blob: d21c13ea5495bde5e94e4ddc7e316b28b8dca2da [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,
1602 uint8_t *data,
1603 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;
1609
Ronald Crone907e552021-01-18 13:22:38 +01001610 /* Reject a zero-length output buffer now, since this can never be a
1611 * valid key representation. This way we know that data must be a valid
1612 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 if (data_size == 0) {
1614 return PSA_ERROR_BUFFER_TOO_SMALL;
1615 }
Ronald Crone907e552021-01-18 13:22:38 +01001616
Ronald Cron9486f9d2020-11-26 13:36:23 +01001617 /* Set the key to empty now, so that even when there are errors, we always
1618 * set data_length to a value between 0 and data_size. On error, setting
1619 * the key to empty is a good choice because an empty key representation is
1620 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001621 *data_length = 0;
1622
Ronald Cron9486f9d2020-11-26 13:36:23 +01001623 /* Export requires the EXPORT flag. There is an exception for public keys,
1624 * which don't require any flag, but
1625 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1626 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1628 PSA_KEY_USAGE_EXPORT, 0);
1629 if (status != PSA_SUCCESS) {
1630 return status;
1631 }
mohammad160306e79202018-03-28 13:17:44 +03001632
Ronald Crond18b5f82020-11-25 16:46:05 +01001633 psa_key_attributes_t attributes = {
1634 .core = slot->attr
1635 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001636 status = psa_driver_wrapper_export_key(&attributes,
1637 slot->key.data, slot->key.bytes,
1638 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001639
Gilles Peskine449bd832023-01-11 14:50:10 +01001640 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001641
Gilles Peskine449bd832023-01-11 14:50:10 +01001642 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001643}
1644
Ronald Cron7285cda2020-11-26 14:46:37 +01001645psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001646 const psa_key_attributes_t *attributes,
1647 const uint8_t *key_buffer,
1648 size_t key_buffer_size,
1649 uint8_t *data,
1650 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001652{
Ronald Crond18b5f82020-11-25 16:46:05 +01001653 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001654
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001655 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001656 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1657 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001658 /* Exporting public -> public */
1659 return psa_export_key_buffer_internal(
1660 key_buffer, key_buffer_size,
1661 data, data_size, data_length);
1662 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001663#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001664 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1665 return mbedtls_psa_rsa_export_public_key(attributes,
1666 key_buffer,
1667 key_buffer_size,
1668 data,
1669 data_size,
1670 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001671#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001672 /* We don't know how to convert a private RSA key to public. */
1673 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001674#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001675 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001676 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001677#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001678 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1679 return mbedtls_psa_ecp_export_public_key(attributes,
1680 key_buffer,
1681 key_buffer_size,
1682 data,
1683 data_size,
1684 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001685#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001686 /* We don't know how to convert a private ECC key to public */
1687 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001688#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001689 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001690 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001691#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001692 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001693 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001694 key_buffer,
1695 key_buffer_size,
1696 data, data_size,
1697 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001698#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001699 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001700#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001701 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001703 (void) key_buffer;
1704 (void) key_buffer_size;
1705 (void) data;
1706 (void) data_size;
1707 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001709 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001710}
Ronald Crond18b5f82020-11-25 16:46:05 +01001711
Gilles Peskine449bd832023-01-11 14:50:10 +01001712psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1713 uint8_t *data,
1714 size_t data_size,
1715 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001716{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001717 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001718 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001719 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001720 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001721
Ronald Crone907e552021-01-18 13:22:38 +01001722 /* Reject a zero-length output buffer now, since this can never be a
1723 * valid key representation. This way we know that data must be a valid
1724 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 if (data_size == 0) {
1726 return PSA_ERROR_BUFFER_TOO_SMALL;
1727 }
Ronald Crone907e552021-01-18 13:22:38 +01001728
Darryl Greendd8fb772018-11-07 16:00:44 +00001729 /* Set the key to empty now, so that even when there are errors, we always
1730 * set data_length to a value between 0 and data_size. On error, setting
1731 * the key to empty is a good choice because an empty key representation is
1732 * unlikely to be accepted anywhere. */
1733 *data_length = 0;
1734
1735 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1737 if (status != PSA_SUCCESS) {
1738 return status;
1739 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001740
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1742 status = PSA_ERROR_INVALID_ARGUMENT;
1743 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001744 }
1745
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001746 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001747 .core = slot->attr
1748 };
Ronald Cron67227982020-11-26 15:16:05 +01001749 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001750 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001752
1753exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001755
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001757}
1758
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001759MBEDTLS_STATIC_ASSERT(
1760 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1761 "One or more key attribute flag is listed as both external-only and dual-use")
1762MBEDTLS_STATIC_ASSERT(
1763 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1764 "One or more key attribute flag is listed as both internal-only and dual-use")
1765MBEDTLS_STATIC_ASSERT(
1766 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1767 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001768
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001769/** Validate that a key policy is internally well-formed.
1770 *
1771 * This function only rejects invalid policies. It does not validate the
1772 * consistency of the policy with respect to other attributes of the key
1773 * such as the key type.
1774 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001775static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001776{
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1778 PSA_KEY_USAGE_COPY |
1779 PSA_KEY_USAGE_ENCRYPT |
1780 PSA_KEY_USAGE_DECRYPT |
1781 PSA_KEY_USAGE_SIGN_MESSAGE |
1782 PSA_KEY_USAGE_VERIFY_MESSAGE |
1783 PSA_KEY_USAGE_SIGN_HASH |
1784 PSA_KEY_USAGE_VERIFY_HASH |
1785 PSA_KEY_USAGE_VERIFY_DERIVATION |
1786 PSA_KEY_USAGE_DERIVE)) != 0) {
1787 return PSA_ERROR_INVALID_ARGUMENT;
1788 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001789
Gilles Peskine449bd832023-01-11 14:50:10 +01001790 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001791}
1792
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001793/** Validate the internal consistency of key attributes.
1794 *
1795 * This function only rejects invalid attribute values. If does not
1796 * validate the consistency of the attributes with any key data that may
1797 * be involved in the creation of the key.
1798 *
1799 * Call this function early in the key creation process.
1800 *
1801 * \param[in] attributes Key attributes for the new key.
1802 * \param[out] p_drv On any return, the driver for the key, if any.
1803 * NULL for a transparent key.
1804 *
1805 */
1806static psa_status_t psa_validate_key_attributes(
1807 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001809{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001810 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1812 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001813
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 status = psa_validate_key_location(lifetime, p_drv);
1815 if (status != PSA_SUCCESS) {
1816 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001817 }
1818
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 status = psa_validate_key_persistence(lifetime);
1820 if (status != PSA_SUCCESS) {
1821 return status;
1822 }
1823
1824 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1825 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1826 return PSA_ERROR_INVALID_ARGUMENT;
1827 }
1828 } else {
1829 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1830 return PSA_ERROR_INVALID_ARGUMENT;
1831 }
1832 }
1833
1834 status = psa_validate_key_policy(&attributes->core.policy);
1835 if (status != PSA_SUCCESS) {
1836 return status;
1837 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001838
1839 /* Refuse to create overly large keys.
1840 * Note that this doesn't trigger on import if the attributes don't
1841 * explicitly specify a size (so psa_get_key_bits returns 0), so
1842 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1844 return PSA_ERROR_NOT_SUPPORTED;
1845 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001846
Gilles Peskine91e8c332019-08-02 19:19:39 +02001847 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1849 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1850 return PSA_ERROR_INVALID_ARGUMENT;
1851 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001854}
1855
Gilles Peskine4747d192019-04-17 15:05:45 +02001856/** Prepare a key slot to receive key material.
1857 *
1858 * This function allocates a key slot and sets its metadata.
1859 *
1860 * If this function fails, call psa_fail_key_creation().
1861 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001862 * This function is intended to be used as follows:
1863 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001864 * it with the specified attributes, and in case of a volatile key assign it
1865 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001866 * -# Populate the slot with the key material.
1867 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1868 * In case of failure at any step, stop the sequence and call
1869 * psa_fail_key_creation().
1870 *
Ronald Cron5c522922020-11-14 16:35:34 +01001871 * On success, the key slot is locked. It is the responsibility of the caller
1872 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001873 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001874 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001875 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001876 * \param[out] p_slot On success, a pointer to the prepared slot.
1877 * \param[out] p_drv On any return, the driver for the key, if any.
1878 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001879 *
1880 * \retval #PSA_SUCCESS
1881 * The key slot is ready to receive key material.
1882 * \return If this function fails, the key slot is an invalid state.
1883 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001884 */
1885static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001886 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001887 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001888 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001889 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001890{
1891 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001892 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001893 psa_key_slot_t *slot;
1894
Gilles Peskinedf179142019-07-15 22:02:14 +02001895 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001896 *p_drv = NULL;
1897
Gilles Peskine449bd832023-01-11 14:50:10 +01001898 status = psa_validate_key_attributes(attributes, p_drv);
1899 if (status != PSA_SUCCESS) {
1900 return status;
1901 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001902
Gilles Peskine449bd832023-01-11 14:50:10 +01001903 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1904 if (status != PSA_SUCCESS) {
1905 return status;
1906 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001907 slot = *p_slot;
1908
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001909 /* We're storing the declared bit-size of the key. It's up to each
1910 * creation mechanism to verify that this information is correct.
1911 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001912 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001913 * is optional (import, copy). In case of a volatile key, assign it the
1914 * volatile key identifier associated to the slot returned to contain its
1915 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001916
1917 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001918 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001919#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1920 slot->attr.id = volatile_key_id;
1921#else
1922 slot->attr.id.key_id = volatile_key_id;
1923#endif
1924 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001925
Gilles Peskine91e8c332019-08-02 19:19:39 +02001926 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001927 * external-only flags, query `attributes`. Thanks to the check
1928 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001929 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001930 * may have set. */
1931 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001932
Gilles Peskinecbaff462019-07-12 23:46:04 +02001933#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001934 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001935 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001936 * create the key file in internal storage, create the
1937 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001938 * persistent data. This is done by starting a transaction that will
1939 * encompass these three actions.
1940 * For registering a volatile key, we just need to find an appropriate
1941 * slot number inside the SE. Since the key is designated volatile, creating
1942 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001943 /* The first thing to do is to find a slot number for the new key.
1944 * We save the slot number in persistent storage as part of the
1945 * transaction data. It will be needed to recover if the power
1946 * fails during the key creation process, to clean up on the secure
1947 * element side after restarting. Obtaining a slot number from the
1948 * secure element driver updates its persistent state, but we do not yet
1949 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001950 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001952 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1954 &slot_number);
1955 if (status != PSA_SUCCESS) {
1956 return status;
1957 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001958
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1960 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001961 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001962 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001963 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001964 status = psa_crypto_save_transaction();
1965 if (status != PSA_SUCCESS) {
1966 (void) psa_crypto_stop_transaction();
1967 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001968 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001969 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001970
1971 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001973 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001974
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001976 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001978 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001979#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1980
Ryan Everett975d4112023-11-16 13:37:51 +00001981 slot->status = PSA_SLOT_OCCUPIED;
1982
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001984}
Gilles Peskine4747d192019-04-17 15:05:45 +02001985
1986/** Finalize the creation of a key once its key material has been set.
1987 *
1988 * This entails writing the key to persistent storage.
1989 *
1990 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001991 * See the documentation of psa_start_key_creation() for the intended use
1992 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001993 *
Ronald Cron5c522922020-11-14 16:35:34 +01001994 * If the finalization succeeds, the function unlocks the key slot (it was
1995 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1996 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001997 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001998 * \param[in,out] slot Pointer to the slot with key material.
1999 * \param[in] driver The secure element driver for the key,
2000 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01002001 * \param[out] key On success, identifier of the key. Note that the
2002 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002003 *
2004 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02002005 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01002006 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
2007 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
2008 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
2009 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
2010 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
2011 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01002012 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002013 * \return If this function fails, the key slot is an invalid state.
2014 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02002015 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002016static psa_status_t psa_finish_key_creation(
2017 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01002018 psa_se_drv_table_entry_t *driver,
2019 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002020{
2021 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02002022 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02002023 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02002024
2025#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02002027#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002029 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01002030 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01002032
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00002033 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
2034 sizeof(data.slot_number),
2035 "Slot number size does not match psa_se_key_data_storage_t");
2036
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
2038 status = psa_save_persistent_key(&slot->attr,
2039 (uint8_t *) &data,
2040 sizeof(data));
2041 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02002042#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2043 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002044 /* Key material is saved in export representation in the slot, so
2045 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 status = psa_save_persistent_key(&slot->attr,
2047 slot->key.data,
2048 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02002049 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002050 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002051#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2052
Gilles Peskinecbaff462019-07-12 23:46:04 +02002053#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002054 /* Finish the transaction for a key creation. This does not
2055 * happen when registering an existing key. Detect this case
2056 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002057 * creation of a persistent key in a secure element requires a transaction,
2058 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 if (driver != NULL &&
2060 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
2061 status = psa_save_se_persistent_data(driver);
2062 if (status != PSA_SUCCESS) {
2063 psa_destroy_persistent_key(slot->attr.id);
2064 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02002065 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02002067 }
2068#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002071 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 status = psa_unlock_key_slot(slot);
2073 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002074 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002076 }
Ronald Cron50972942020-11-14 11:28:25 +01002077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002079}
2080
2081/** Abort the creation of a key.
2082 *
2083 * You may call this function after calling psa_start_key_creation(),
2084 * or after psa_finish_key_creation() fails. In other circumstances, this
2085 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002086 * See the documentation of psa_start_key_creation() for the intended use
2087 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002088 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002089 * \param[in,out] slot Pointer to the slot with key material.
2090 * \param[in] driver The secure element driver for the key,
2091 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002092 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002093static void psa_fail_key_creation(psa_key_slot_t *slot,
2094 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02002095{
Gilles Peskine011e4282019-06-26 18:34:38 +02002096 (void) driver;
2097
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02002099 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 }
Gilles Peskine011e4282019-06-26 18:34:38 +02002101
2102#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002103 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002104 * element, and the failure happened later (when saving metadata
2105 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002106 * element.
2107 * https://github.com/ARMmbed/mbed-crypto/issues/217
2108 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002109
Gilles Peskined7729582019-08-05 15:55:54 +02002110 /* Abort the ongoing transaction if any (there may not be one if
2111 * the creation process failed before starting one, or if the
2112 * key creation is a registration of a key in a secure element).
2113 * Earlier functions must already have done what it takes to undo any
2114 * partial creation. All that's left is to update the transaction data
2115 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002117#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2118
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02002120}
2121
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002122/** Validate optional attributes during key creation.
2123 *
2124 * Some key attributes are optional during key creation. If they are
2125 * specified in the attributes structure, check that they are consistent
2126 * with the data in the slot.
2127 *
2128 * This function should be called near the end of key creation, after
2129 * the slot in memory is fully populated but before saving persistent data.
2130 */
2131static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002132 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002134{
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 if (attributes->core.type != 0) {
2136 if (attributes->core.type != slot->attr.type) {
2137 return PSA_ERROR_INVALID_ARGUMENT;
2138 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002139 }
2140
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002142#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2143 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2145 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002146 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002147 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002148 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002149
Ronald Cron90857082020-11-25 14:58:33 +01002150 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 slot->attr.type,
2152 slot->key.data,
2153 slot->key.bytes,
2154 &rsa);
2155 if (status != PSA_SUCCESS) {
2156 return status;
2157 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002158
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 mbedtls_mpi_init(&actual);
2160 mbedtls_mpi_init(&required);
2161 ret = mbedtls_rsa_export(rsa,
2162 NULL, NULL, NULL, NULL, &actual);
2163 mbedtls_rsa_free(rsa);
2164 mbedtls_free(rsa);
2165 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002166 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 }
2168 ret = mbedtls_mpi_read_binary(&required,
2169 attributes->domain_parameters,
2170 attributes->domain_parameters_size);
2171 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002172 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 }
2174 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002175 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 }
2177rsa_exit:
2178 mbedtls_mpi_free(&actual);
2179 mbedtls_mpi_free(&required);
2180 if (ret != 0) {
2181 return mbedtls_to_psa_error(ret);
2182 }
2183 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002184#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2185 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002186 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002187 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002189 }
2190 }
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 if (attributes->core.bits != 0) {
2193 if (attributes->core.bits != slot->attr.bits) {
2194 return PSA_ERROR_INVALID_ARGUMENT;
2195 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002196 }
2197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002199}
2200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
2202 const uint8_t *data,
2203 size_t data_length,
2204 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002205{
2206 psa_status_t status;
2207 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002208 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002209 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302210 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002211
Ronald Cron81709fc2020-11-14 12:10:32 +01002212 *key = MBEDTLS_SVC_KEY_ID_INIT;
2213
Gilles Peskine0f84d622019-09-12 19:03:13 +02002214 /* Reject zero-length symmetric keys (including raw data key objects).
2215 * This also rejects any key which might be encoded as an empty string,
2216 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (data_length == 0) {
2218 return PSA_ERROR_INVALID_ARGUMENT;
2219 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002220
Archana449608b2021-09-08 15:36:05 +05302221 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 if (data_length > SIZE_MAX / 8) {
2223 return PSA_ERROR_NOT_SUPPORTED;
2224 }
Archana6ed4bda2021-08-04 10:47:15 +05302225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2227 &slot, &driver);
2228 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002229 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002231
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002232 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302233 * storage ( thus not in the case of importing a key in a secure element
2234 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2235 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 if (slot->key.data == NULL) {
2237 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302238 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 attributes, data, data_length, &storage_size);
2240 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302241 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 }
Archanad8a83dc2021-06-14 10:04:16 +05302243 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 status = psa_allocate_buffer_to_slot(slot, storage_size);
2245 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002246 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002248 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002249
2250 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 status = psa_driver_wrapper_import_key(attributes,
2252 data, data_length,
2253 slot->key.data,
2254 slot->key.bytes,
2255 &slot->key.bytes, &bits);
2256 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002257 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002259
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002261 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002263 status = PSA_ERROR_INVALID_ARGUMENT;
2264 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002265 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002266
Archana6ed4bda2021-08-04 10:47:15 +05302267 /* Enforce a size limit, and in particular ensure that the bit
2268 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302270 status = PSA_ERROR_NOT_SUPPORTED;
2271 goto exit;
2272 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 status = psa_validate_optional_attributes(slot, attributes);
2274 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002275 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002277
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002279exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 if (status != PSA_SUCCESS) {
2281 psa_fail_key_creation(slot, driver);
2282 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002285}
2286
Gilles Peskined7729582019-08-05 15:55:54 +02002287#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2288psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002290{
2291 psa_status_t status;
2292 psa_key_slot_t *slot = NULL;
2293 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002294 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002295
2296 /* Leaving attributes unspecified is not currently supported.
2297 * It could make sense to query the key type and size from the
2298 * secure element, but not all secure elements support this
2299 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2301 return PSA_ERROR_NOT_SUPPORTED;
2302 }
2303 if (psa_get_key_bits(attributes) == 0) {
2304 return PSA_ERROR_NOT_SUPPORTED;
2305 }
Gilles Peskined7729582019-08-05 15:55:54 +02002306
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2308 &slot, &driver);
2309 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002310 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 }
Gilles Peskined7729582019-08-05 15:55:54 +02002312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002314
2315exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 if (status != PSA_SUCCESS) {
2317 psa_fail_key_creation(slot, driver);
2318 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002319
Gilles Peskined7729582019-08-05 15:55:54 +02002320 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 psa_close_key(key);
2322 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002323}
2324#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2325
Gilles Peskine449bd832023-01-11 14:50:10 +01002326psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2327 const psa_key_attributes_t *specified_attributes,
2328 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002329{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002330 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002331 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002332 psa_key_slot_t *source_slot = NULL;
2333 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002334 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002335 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302336 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002337
Ronald Cron81709fc2020-11-14 12:10:32 +01002338 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2339
Archana8a180362021-07-05 02:18:48 +05302340 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2342 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002343 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002345
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 status = psa_validate_optional_attributes(source_slot,
2347 specified_attributes);
2348 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002349 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002351
Archana9d17bf42021-09-10 06:22:44 +05302352 /* The target key type and number of bits have been validated by
2353 * psa_validate_optional_attributes() to be either equal to zero or
2354 * equal to the ones of the source key. So it is safe to inherit
2355 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302356 * */
Archana9d17bf42021-09-10 06:22:44 +05302357 actual_attributes.core.bits = source_slot->attr.bits;
2358 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302359
2360
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 status = psa_restrict_key_policy(source_slot->attr.type,
2362 &actual_attributes.core.policy,
2363 &source_slot->attr.policy);
2364 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002365 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2369 &target_slot, &driver);
2370 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002371 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 }
2373 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2374 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302375 /*
Archana9d17bf42021-09-10 06:22:44 +05302376 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302377 * the source key would need to be exported as plaintext and re-imported
2378 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302379 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302380 * appropriate API invocations from the application, if needed.
2381 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002382 status = PSA_ERROR_NOT_SUPPORTED;
2383 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002384 }
Archana8a180362021-07-05 02:18:48 +05302385 /*
2386 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302387 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302388 * - For opaque keys this translates to an invocation of the drivers'
2389 * copy_key entry point through the dispatch layer.
2390 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2392 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2393 &storage_size);
2394 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302395 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 }
Archana374fe5b2021-09-08 15:50:28 +05302397
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2399 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302400 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 }
Archana374fe5b2021-09-08 15:50:28 +05302402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 status = psa_driver_wrapper_copy_key(&actual_attributes,
2404 source_slot->key.data,
2405 source_slot->key.bytes,
2406 target_slot->key.data,
2407 target_slot->key.bytes,
2408 &target_slot->key.bytes);
2409 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302410 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 }
2412 } else {
2413 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302414 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 source_slot->key.bytes);
2416 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302417 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 }
Archana8a180362021-07-05 02:18:48 +05302419 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002421exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 if (status != PSA_SUCCESS) {
2423 psa_fail_key_creation(target_slot, driver);
2424 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002427
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002429}
2430
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002431
2432
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002433/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002434/* Message digests */
2435/****************************************************************/
2436
Gilles Peskine449bd832023-01-11 14:50:10 +01002437psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002438{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002439 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 if (operation->id == 0) {
2441 return PSA_SUCCESS;
2442 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002445 operation->id = 0;
2446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002448}
2449
Gilles Peskine449bd832023-01-11 14:50:10 +01002450psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2451 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002452{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002453 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002454
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002455 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002457 status = PSA_ERROR_BAD_STATE;
2458 goto exit;
2459 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002462 status = PSA_ERROR_INVALID_ARGUMENT;
2463 goto exit;
2464 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002465
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002466 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2467 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002469
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002471
2472exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 if (status != PSA_SUCCESS) {
2474 psa_hash_abort(operation);
2475 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002476
2477 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002478}
2479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2481 const uint8_t *input,
2482 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002483{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002484 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2485
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002487 status = PSA_ERROR_BAD_STATE;
2488 goto exit;
2489 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002490
Steven Cooremanc8288352021-03-04 14:02:19 +01002491 /* Don't require hash implementations to behave correctly on a
2492 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 if (input_length == 0) {
2494 return PSA_SUCCESS;
2495 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002496
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002498
2499exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 if (status != PSA_SUCCESS) {
2501 psa_hash_abort(operation);
2502 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002505}
2506
Gilles Peskine449bd832023-01-11 14:50:10 +01002507psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2508 uint8_t *hash,
2509 size_t hash_size,
2510 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002511{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002512 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 if (operation->id == 0) {
2514 return PSA_ERROR_BAD_STATE;
2515 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002516
Steven Cooreman1e582352021-02-18 17:24:37 +01002517 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 operation, hash, hash_size, hash_length);
2519 psa_hash_abort(operation);
2520 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002521}
2522
Gilles Peskine449bd832023-01-11 14:50:10 +01002523psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2524 const uint8_t *hash,
2525 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002526{
Ronald Cron69a63422021-10-18 09:47:58 +02002527 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002528 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002529 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 operation,
2531 actual_hash, sizeof(actual_hash),
2532 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002533
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002535 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002537
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002539 status = PSA_ERROR_INVALID_SIGNATURE;
2540 goto exit;
2541 }
2542
Dave Rodgman78701152023-08-29 14:20:18 +01002543 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002544 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002546
2547exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2549 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002550 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002552
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002554}
2555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556psa_status_t psa_hash_compute(psa_algorithm_t alg,
2557 const uint8_t *input, size_t input_length,
2558 uint8_t *hash, size_t hash_size,
2559 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002560{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002561 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 if (!PSA_ALG_IS_HASH(alg)) {
2563 return PSA_ERROR_INVALID_ARGUMENT;
2564 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2567 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002568}
2569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570psa_status_t psa_hash_compare(psa_algorithm_t alg,
2571 const uint8_t *input, size_t input_length,
2572 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002573{
Ronald Cron69a63422021-10-18 09:47:58 +02002574 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002575 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 if (!PSA_ALG_IS_HASH(alg)) {
2578 return PSA_ERROR_INVALID_ARGUMENT;
2579 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002580
Steven Cooreman1e582352021-02-18 17:24:37 +01002581 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 alg, input, input_length,
2583 actual_hash, sizeof(actual_hash),
2584 &actual_hash_length);
2585 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002586 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 }
2588 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002589 status = PSA_ERROR_INVALID_SIGNATURE;
2590 goto exit;
2591 }
Dave Rodgman78701152023-08-29 14:20:18 +01002592 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002593 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002595
2596exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2598 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002599}
2600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2602 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002603{
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 if (source_operation->id == 0 ||
2605 target_operation->id != 0) {
2606 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002607 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2610 target_operation);
2611 if (status != PSA_SUCCESS) {
2612 psa_hash_abort(target_operation);
2613 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002616}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002617
2618
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002619/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002620/* MAC */
2621/****************************************************************/
2622
Gilles Peskine449bd832023-01-11 14:50:10 +01002623psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002624{
Steven Cooremane6804192021-03-19 18:28:56 +01002625 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 if (operation->id == 0) {
2627 return PSA_SUCCESS;
2628 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002631 operation->mac_size = 0;
2632 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002633 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002636}
2637
Ronald Cron2dff3b22021-06-17 16:33:22 +02002638static psa_status_t psa_mac_finalize_alg_and_key_validation(
2639 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002640 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002642{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002643 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 psa_key_type_t key_type = psa_get_key_type(attributes);
2645 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 if (!PSA_ALG_IS_MAC(alg)) {
2648 return PSA_ERROR_INVALID_ARGUMENT;
2649 }
Steven Cooremane6804192021-03-19 18:28:56 +01002650
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002651 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 status = psa_mac_key_can_do(alg, key_type);
2653 if (status != PSA_SUCCESS) {
2654 return status;
2655 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002656
Steven Cooremand1a68f12021-05-10 11:13:41 +02002657 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002659
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002661 /* A very short MAC is too short for security since it can be
2662 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2663 * so we make this our minimum, even though 32 bits is still
2664 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002666 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2669 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002670 /* It's impossible to "truncate" to a larger length than the full length
2671 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002673 }
2674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002676 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2677 * that is disabled in the compile-time configuration. The result can
2678 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2679 * configuration into account. In this case, force a return of
2680 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2681 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2682 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2683 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2684 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002686 }
2687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002689}
2690
Gilles Peskine449bd832023-01-11 14:50:10 +01002691static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2692 mbedtls_svc_key_id_t key,
2693 psa_algorithm_t alg,
2694 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002695{
2696 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2697 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002698 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002699 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002700
2701 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002703 status = PSA_ERROR_BAD_STATE;
2704 goto exit;
2705 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002706
2707 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 key,
2709 &slot,
2710 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2711 alg);
2712 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002713 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002715
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002716 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002717 .core = slot->attr
2718 };
2719
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2721 &operation->mac_size);
2722 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002723 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002725
2726 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002727 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 if (is_sign) {
2729 status = psa_driver_wrapper_mac_sign_setup(operation,
2730 &attributes,
2731 slot->key.data,
2732 slot->key.bytes,
2733 alg);
2734 } else {
2735 status = psa_driver_wrapper_mac_verify_setup(operation,
2736 &attributes,
2737 slot->key.data,
2738 slot->key.bytes,
2739 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002740 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002741
Gilles Peskinefbfac682018-07-08 20:51:54 +02002742exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 if (status != PSA_SUCCESS) {
2744 psa_mac_abort(operation);
2745 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002746
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002748
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002750}
2751
Gilles Peskine449bd832023-01-11 14:50:10 +01002752psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2753 mbedtls_svc_key_id_t key,
2754 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002755{
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002757}
2758
Gilles Peskine449bd832023-01-11 14:50:10 +01002759psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2760 mbedtls_svc_key_id_t key,
2761 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002762{
Gilles Peskine449bd832023-01-11 14:50:10 +01002763 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002764}
2765
Gilles Peskine449bd832023-01-11 14:50:10 +01002766psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2767 const uint8_t *input,
2768 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002769{
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 if (operation->id == 0) {
2771 return PSA_ERROR_BAD_STATE;
2772 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002773
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002774 /* Don't require hash implementations to behave correctly on a
2775 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 if (input_length == 0) {
2777 return PSA_SUCCESS;
2778 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002779
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2781 input, input_length);
2782 if (status != PSA_SUCCESS) {
2783 psa_mac_abort(operation);
2784 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002785
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002787}
2788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2790 uint8_t *mac,
2791 size_t mac_size,
2792 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002793{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002794 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2795 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002798 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002799 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002800 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002801
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002803 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002804 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002805 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002806
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002807 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2808 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002810 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002811 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002812 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002813
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002815 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002816 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002817 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002818
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 status = psa_driver_wrapper_mac_sign_finish(operation,
2820 mac, operation->mac_size,
2821 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002822
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002823exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002824 /* In case of success, set the potential excess room in the output buffer
2825 * to an invalid value, to avoid potentially leaking a longer MAC.
2826 * In case of error, set the output length and content to a safe default,
2827 * such that in case the caller misses an error check, the output would be
2828 * an unachievable MAC.
2829 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002831 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002832 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002833 }
mohammad16036df908f2018-04-02 08:34:15 -07002834
Paul Elliottdc42ca82023-02-24 18:11:59 +00002835 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002836
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002838
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002840}
2841
Gilles Peskine449bd832023-01-11 14:50:10 +01002842psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2843 const uint8_t *mac,
2844 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002845{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002846 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2847 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002848
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002850 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002851 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002852 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002853
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002855 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002856 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002857 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002860 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002861 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002862 }
2863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 status = psa_driver_wrapper_mac_verify_finish(operation,
2865 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002866
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002867exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002869
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002871}
2872
Gilles Peskine449bd832023-01-11 14:50:10 +01002873static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2874 psa_algorithm_t alg,
2875 const uint8_t *input,
2876 size_t input_length,
2877 uint8_t *mac,
2878 size_t mac_size,
2879 size_t *mac_length,
2880 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002881{
2882 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002883 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2884 psa_key_slot_t *slot;
2885 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002886 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002887
Ronald Cron51131b52021-06-17 17:17:20 +02002888 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 key,
2890 &slot,
2891 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2892 alg);
2893 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002894 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002896
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002897 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002898 .core = slot->attr
2899 };
2900
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2902 &operation_mac_size);
2903 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002904 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002906
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002908 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002909 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002910 }
2911
2912 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 &attributes,
2914 slot->key.data, slot->key.bytes,
2915 alg,
2916 input, input_length,
2917 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002918
2919exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002920 /* In case of success, set the potential excess room in the output buffer
2921 * to an invalid value, to avoid potentially leaking a longer MAC.
2922 * In case of error, set the output length and content to a safe default,
2923 * such that in case the caller misses an error check, the output would be
2924 * an unachievable MAC.
2925 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002927 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002928 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002929 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002930
2931 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002932
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002936}
2937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002939 psa_algorithm_t alg,
2940 const uint8_t *input,
2941 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002942 uint8_t *mac,
2943 size_t mac_size,
2944 size_t *mac_length)
2945{
2946 return psa_mac_compute_internal(key, alg,
2947 input, input_length,
2948 mac, mac_size, mac_length, 1);
2949}
2950
2951psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2952 psa_algorithm_t alg,
2953 const uint8_t *input,
2954 size_t input_length,
2955 const uint8_t *mac,
2956 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002957{
2958 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002959 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2960 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002961
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 status = psa_mac_compute_internal(key, alg,
2963 input, input_length,
2964 actual_mac, sizeof(actual_mac),
2965 &actual_mac_length, 0);
2966 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002967 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002968 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002969
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002971 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002972 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002973 }
Dave Rodgman78701152023-08-29 14:20:18 +01002974 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002975 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002976 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002977 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002978
2979exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002981
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002983}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002984
Gilles Peskinee59236f2018-01-27 23:32:46 +01002985/****************************************************************/
2986/* Asymmetric cryptography */
2987/****************************************************************/
2988
Gilles Peskine449bd832023-01-11 14:50:10 +01002989static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2990 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002991{
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 if (input_is_message) {
2993 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2994 return PSA_ERROR_INVALID_ARGUMENT;
2995 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002996
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2998 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2999 return PSA_ERROR_INVALID_ARGUMENT;
3000 }
3001 }
3002 } else {
3003 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
3004 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003005 }
3006 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003009}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003010
Gilles Peskine449bd832023-01-11 14:50:10 +01003011static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
3012 int input_is_message,
3013 psa_algorithm_t alg,
3014 const uint8_t *input,
3015 size_t input_length,
3016 uint8_t *signature,
3017 size_t signature_size,
3018 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003019{
3020 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3021 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3022 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003023 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003024
3025 *signature_length = 0;
3026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 status = psa_sign_verify_check_alg(input_is_message, alg);
3028 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003029 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003031
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003032 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02003033 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003034 * buffer can in principle be empty since it doesn't actually have
3035 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 if (signature_size == 0) {
3037 return PSA_ERROR_BUFFER_TOO_SMALL;
3038 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003039
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003040 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 key, &slot,
3042 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
3043 PSA_KEY_USAGE_SIGN_HASH,
3044 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003047 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003049
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003051 status = PSA_ERROR_INVALID_ARGUMENT;
3052 goto exit;
3053 }
3054
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003055 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003057 };
3058
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003060 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003061 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003062 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 signature, signature_size, signature_length);
3064 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003065
3066 status = psa_driver_wrapper_sign_hash(
3067 &attributes, slot->key.data, slot->key.bytes,
3068 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003070 }
3071
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003072
3073exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003074 psa_wipe_tag_output_buffer(signature, status, signature_size,
3075 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003076
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003078
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003080}
3081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3083 int input_is_message,
3084 psa_algorithm_t alg,
3085 const uint8_t *input,
3086 size_t input_length,
3087 const uint8_t *signature,
3088 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003089{
3090 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3091 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3092 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003093
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 status = psa_sign_verify_check_alg(input_is_message, alg);
3095 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003096 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003098
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003099 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 key, &slot,
3101 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3102 PSA_KEY_USAGE_VERIFY_HASH,
3103 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003104
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 if (status != PSA_SUCCESS) {
3106 return status;
3107 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003108
3109 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003111 };
3112
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003114 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003115 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003116 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003117 signature, signature_length);
3118 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003119 status = psa_driver_wrapper_verify_hash(
3120 &attributes, slot->key.data, slot->key.bytes,
3121 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003123 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003124
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003126
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003128
3129}
3130
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003131psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003132 const psa_key_attributes_t *attributes,
3133 const uint8_t *key_buffer,
3134 size_t key_buffer_size,
3135 psa_algorithm_t alg,
3136 const uint8_t *input,
3137 size_t input_length,
3138 uint8_t *signature,
3139 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003141{
3142 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003143
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003145 size_t hash_length;
3146 uint8_t hash[PSA_HASH_MAX_SIZE];
3147
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003148 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 PSA_ALG_SIGN_GET_HASH(alg),
3150 input, input_length,
3151 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003152
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003154 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003155 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003156
3157 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 attributes, key_buffer, key_buffer_size,
3159 alg, hash, hash_length,
3160 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003161 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003162
Gilles Peskine449bd832023-01-11 14:50:10 +01003163 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003164}
3165
Gilles Peskine449bd832023-01-11 14:50:10 +01003166psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3167 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003168 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003169 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003170 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 size_t signature_size,
3172 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003173{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003174 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3175 LOCAL_INPUT_DECLARE(input_external, input);
3176 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3177
3178 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3179 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3180 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3181 signature_size, signature_length);
3182
Thomas Daubney3e65f522024-01-30 12:37:25 +00003183#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003184exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003185#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003186 LOCAL_INPUT_FREE(input_external, input);
3187 LOCAL_OUTPUT_FREE(signature_external, signature);
3188 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003189}
3190
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003191psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003192 const psa_key_attributes_t *attributes,
3193 const uint8_t *key_buffer,
3194 size_t key_buffer_size,
3195 psa_algorithm_t alg,
3196 const uint8_t *input,
3197 size_t input_length,
3198 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003200{
3201 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003202
Gilles Peskine449bd832023-01-11 14:50:10 +01003203 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003204 size_t hash_length;
3205 uint8_t hash[PSA_HASH_MAX_SIZE];
3206
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003207 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003208 PSA_ALG_SIGN_GET_HASH(alg),
3209 input, input_length,
3210 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003211
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003213 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003214 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003215
3216 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003217 attributes, key_buffer, key_buffer_size,
3218 alg, hash, hash_length,
3219 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003220 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003221
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003223}
3224
Gilles Peskine449bd832023-01-11 14:50:10 +01003225psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3226 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003227 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003229 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003231{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003232 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3233 LOCAL_INPUT_DECLARE(input_external, input);
3234 LOCAL_INPUT_DECLARE(signature_external, signature);
3235
3236 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3237 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3238 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3239 signature_length);
3240
Thomas Daubney3e65f522024-01-30 12:37:25 +00003241#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003242exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003243#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003244 LOCAL_INPUT_FREE(input_external, input);
3245 LOCAL_INPUT_FREE(signature_external, signature);
3246
3247 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003248}
3249
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003250psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003251 const psa_key_attributes_t *attributes,
3252 const uint8_t *key_buffer, size_t key_buffer_size,
3253 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003255{
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3257 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3258 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003259#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003260 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3261 return mbedtls_psa_rsa_sign_hash(
3262 attributes,
3263 key_buffer, key_buffer_size,
3264 alg, hash, hash_length,
3265 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003266#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3267 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 } else {
3269 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003270 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003271 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3272 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003273#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3275 return mbedtls_psa_ecdsa_sign_hash(
3276 attributes,
3277 key_buffer, key_buffer_size,
3278 alg, hash, hash_length,
3279 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003280#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3281 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 } else {
3283 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003284 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003285 }
Ronald Cron4501c982021-03-19 20:09:32 +01003286
Gilles Peskine449bd832023-01-11 14:50:10 +01003287 (void) key_buffer;
3288 (void) key_buffer_size;
3289 (void) hash;
3290 (void) hash_length;
3291 (void) signature;
3292 (void) signature_size;
3293 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003294
Gilles Peskine449bd832023-01-11 14:50:10 +01003295 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003296}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003297
Gilles Peskine449bd832023-01-11 14:50:10 +01003298psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3299 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003300 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003302 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 size_t signature_size,
3304 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003305{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003306 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3307 LOCAL_INPUT_DECLARE(hash_external, hash);
3308 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3309
3310 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3311 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3312 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3313 signature_size, signature_length);
3314
Thomas Daubney3e65f522024-01-30 12:37:25 +00003315#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003316exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003317#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003318 LOCAL_INPUT_FREE(hash_external, hash);
3319 LOCAL_OUTPUT_FREE(signature_external, signature);
3320
3321 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003322}
3323
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003324psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003325 const psa_key_attributes_t *attributes,
3326 const uint8_t *key_buffer, size_t key_buffer_size,
3327 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003328 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003329{
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3331 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3332 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003333#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003334 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3335 return mbedtls_psa_rsa_verify_hash(
3336 attributes,
3337 key_buffer, key_buffer_size,
3338 alg, hash, hash_length,
3339 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003340#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3341 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 } else {
3343 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003344 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003345 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3346 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003347#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3349 return mbedtls_psa_ecdsa_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_ECDSA) ||
3355 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 } else {
3357 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003358 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003359 }
Ronald Cron4501c982021-03-19 20:09:32 +01003360
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 (void) key_buffer;
3362 (void) key_buffer_size;
3363 (void) hash;
3364 (void) hash_length;
3365 (void) signature;
3366 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003367
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003369}
3370
Gilles Peskine449bd832023-01-11 14:50:10 +01003371psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3372 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003373 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003374 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003375 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003376 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003377{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003378 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3379 LOCAL_INPUT_DECLARE(hash_external, hash);
3380 LOCAL_INPUT_DECLARE(signature_external, signature);
3381
3382 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3383 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3384 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3385 signature_length);
3386
Thomas Daubney3e65f522024-01-30 12:37:25 +00003387#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003388exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003389#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003390 LOCAL_INPUT_FREE(hash_external, hash);
3391 LOCAL_INPUT_FREE(signature_external, signature);
3392
3393 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003394}
3395
Gilles Peskine449bd832023-01-11 14:50:10 +01003396psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3397 psa_algorithm_t alg,
3398 const uint8_t *input,
3399 size_t input_length,
3400 const uint8_t *salt,
3401 size_t salt_length,
3402 uint8_t *output,
3403 size_t output_size,
3404 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003405{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003406 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003407 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003408 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003409 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003410
Darryl Green5cc689a2018-07-24 15:34:10 +01003411 (void) input;
3412 (void) input_length;
3413 (void) salt;
3414 (void) output;
3415 (void) output_size;
3416
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003417 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003418
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3420 return PSA_ERROR_INVALID_ARGUMENT;
3421 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003422
Ronald Cron5c522922020-11-14 16:35:34 +01003423 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3425 if (status != PSA_SUCCESS) {
3426 return status;
3427 }
3428 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3429 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003430 status = PSA_ERROR_INVALID_ARGUMENT;
3431 goto exit;
3432 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003433
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003434 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003435 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003436 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003437
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003438 status = psa_driver_wrapper_asymmetric_encrypt(
3439 &attributes, slot->key.data, slot->key.bytes,
3440 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003441 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003442exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003443 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003444
Gilles Peskine449bd832023-01-11 14:50:10 +01003445 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003446}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003447
Gilles Peskine449bd832023-01-11 14:50:10 +01003448psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3449 psa_algorithm_t alg,
3450 const uint8_t *input,
3451 size_t input_length,
3452 const uint8_t *salt,
3453 size_t salt_length,
3454 uint8_t *output,
3455 size_t output_size,
3456 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003457{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003458 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003459 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003460 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003461 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003462
Darryl Green5cc689a2018-07-24 15:34:10 +01003463 (void) input;
3464 (void) input_length;
3465 (void) salt;
3466 (void) output;
3467 (void) output_size;
3468
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003469 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003470
Gilles Peskine449bd832023-01-11 14:50:10 +01003471 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3472 return PSA_ERROR_INVALID_ARGUMENT;
3473 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003474
Ronald Cron5c522922020-11-14 16:35:34 +01003475 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003476 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3477 if (status != PSA_SUCCESS) {
3478 return status;
3479 }
3480 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003481 status = PSA_ERROR_INVALID_ARGUMENT;
3482 goto exit;
3483 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003484
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003485 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003486 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003487 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003488
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003489 status = psa_driver_wrapper_asymmetric_decrypt(
3490 &attributes, slot->key.data, slot->key.bytes,
3491 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003492 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003493
3494exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003495 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003496
Gilles Peskine449bd832023-01-11 14:50:10 +01003497 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003498}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003499
Paul Elliott9fe12f62022-11-30 19:16:02 +00003500/****************************************************************/
3501/* Asymmetric interruptible cryptography */
3502/****************************************************************/
3503
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003504static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3505
Paul Elliott9fe12f62022-11-30 19:16:02 +00003506void psa_interruptible_set_max_ops(uint32_t max_ops)
3507{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003508 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003509}
3510
3511uint32_t psa_interruptible_get_max_ops(void)
3512{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003513 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003514}
3515
Paul Elliott9fe12f62022-11-30 19:16:02 +00003516uint32_t psa_sign_hash_get_num_ops(
3517 const psa_sign_hash_interruptible_operation_t *operation)
3518{
Paul Elliott296ede92022-12-15 17:00:30 +00003519 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003520}
3521
3522uint32_t psa_verify_hash_get_num_ops(
3523 const psa_verify_hash_interruptible_operation_t *operation)
3524{
Paul Elliott296ede92022-12-15 17:00:30 +00003525 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003526}
3527
Paul Elliott59ad9452022-12-18 15:09:02 +00003528static psa_status_t psa_sign_hash_abort_internal(
3529 psa_sign_hash_interruptible_operation_t *operation)
3530{
3531 if (operation->id == 0) {
3532 /* The object has (apparently) been initialized but it is not (yet)
3533 * in use. It's ok to call abort on such an object, and there's
3534 * nothing to do. */
3535 return PSA_SUCCESS;
3536 }
3537
3538 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3539
3540 status = psa_driver_wrapper_sign_hash_abort(operation);
3541
3542 operation->id = 0;
3543
Paul Elliotte6145dc2023-02-07 12:51:21 +00003544 /* Do not clear either the error_occurred or num_ops elements here as they
3545 * only want to be cleared by the application calling abort, not by abort
3546 * being called at completion of an operation. */
3547
Paul Elliott59ad9452022-12-18 15:09:02 +00003548 return status;
3549}
3550
Paul Elliott9fe12f62022-11-30 19:16:02 +00003551psa_status_t psa_sign_hash_start(
3552 psa_sign_hash_interruptible_operation_t *operation,
3553 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3554 const uint8_t *hash, size_t hash_length)
3555{
3556 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3557 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3558 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003559 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003560
Paul Elliottc9774412023-02-06 15:14:07 +00003561 /* Check that start has not been previously called, or operation has not
3562 * previously errored. */
3563 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003564 return PSA_ERROR_BAD_STATE;
3565 }
3566
Paul Elliott9fe12f62022-11-30 19:16:02 +00003567 status = psa_sign_verify_check_alg(0, alg);
3568 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003569 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003570 return status;
3571 }
3572
3573 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3574 PSA_KEY_USAGE_SIGN_HASH,
3575 alg);
3576
3577 if (status != PSA_SUCCESS) {
3578 goto exit;
3579 }
3580
3581 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3582 status = PSA_ERROR_INVALID_ARGUMENT;
3583 goto exit;
3584 }
3585
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003586 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003587 .core = slot->attr
3588 };
3589
Paul Elliott296ede92022-12-15 17:00:30 +00003590 /* Ensure ops count gets reset, in case of operation re-use. */
3591 operation->num_ops = 0;
3592
Paul Elliott9fe12f62022-11-30 19:16:02 +00003593 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3594 slot->key.data,
3595 slot->key.bytes, alg,
3596 hash, hash_length);
3597exit:
3598
3599 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003600 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003601 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003602 }
3603
3604 unlock_status = psa_unlock_key_slot(slot);
3605
Paul Elliottc9774412023-02-06 15:14:07 +00003606 if (unlock_status != PSA_SUCCESS) {
3607 operation->error_occurred = 1;
3608 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003609
Paul Elliottc9774412023-02-06 15:14:07 +00003610 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003611}
3612
3613
3614psa_status_t psa_sign_hash_complete(
3615 psa_sign_hash_interruptible_operation_t *operation,
3616 uint8_t *signature, size_t signature_size,
3617 size_t *signature_length)
3618{
3619 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3620
3621 *signature_length = 0;
3622
Paul Elliottc9774412023-02-06 15:14:07 +00003623 /* Check that start has been called first, and that operation has not
3624 * previously errored. */
3625 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003626 status = PSA_ERROR_BAD_STATE;
3627 goto exit;
3628 }
3629
Paul Elliott096abc42023-02-03 18:33:23 +00003630 /* Immediately reject a zero-length signature buffer. This guarantees that
3631 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003632 if (signature_size == 0) {
3633 status = PSA_ERROR_BUFFER_TOO_SMALL;
3634 goto exit;
3635 }
3636
3637 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3638 signature_size,
3639 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003640
Paul Elliott296ede92022-12-15 17:00:30 +00003641 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003642 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003643
Paul Elliottebe225c2023-02-10 14:32:53 +00003644exit:
3645
Paul Elliott59200a22023-02-21 15:07:40 +00003646 psa_wipe_tag_output_buffer(signature, status, signature_size,
3647 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003648
Paul Elliott53bb3122023-02-10 14:22:22 +00003649 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003650 if (status != PSA_SUCCESS) {
3651 operation->error_occurred = 1;
3652 }
3653
Paul Elliott59ad9452022-12-18 15:09:02 +00003654 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003655 }
3656
3657 return status;
3658}
3659
3660psa_status_t psa_sign_hash_abort(
3661 psa_sign_hash_interruptible_operation_t *operation)
3662{
Paul Elliott59ad9452022-12-18 15:09:02 +00003663 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3664
3665 status = psa_sign_hash_abort_internal(operation);
3666
3667 /* We clear the number of ops done here, so that it is not cleared when
3668 * the operation fails or succeeds, only on manual abort. */
3669 operation->num_ops = 0;
3670
Paul Elliottc9774412023-02-06 15:14:07 +00003671 /* Likewise, failure state. */
3672 operation->error_occurred = 0;
3673
Paul Elliott59ad9452022-12-18 15:09:02 +00003674 return status;
3675}
3676
3677static psa_status_t psa_verify_hash_abort_internal(
3678 psa_verify_hash_interruptible_operation_t *operation)
3679{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003680 if (operation->id == 0) {
3681 /* The object has (apparently) been initialized but it is not (yet)
3682 * in use. It's ok to call abort on such an object, and there's
3683 * nothing to do. */
3684 return PSA_SUCCESS;
3685 }
3686
Paul Elliott59ad9452022-12-18 15:09:02 +00003687 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3688
3689 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003690
3691 operation->id = 0;
3692
Paul Elliotte6145dc2023-02-07 12:51:21 +00003693 /* Do not clear either the error_occurred or num_ops elements here as they
3694 * only want to be cleared by the application calling abort, not by abort
3695 * being called at completion of an operation. */
3696
Paul Elliott59ad9452022-12-18 15:09:02 +00003697 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003698}
3699
3700psa_status_t psa_verify_hash_start(
3701 psa_verify_hash_interruptible_operation_t *operation,
3702 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3703 const uint8_t *hash, size_t hash_length,
3704 const uint8_t *signature, size_t signature_length)
3705{
3706 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3707 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3708 psa_key_slot_t *slot;
3709
Paul Elliottc9774412023-02-06 15:14:07 +00003710 /* Check that start has not been previously called, or operation has not
3711 * previously errored. */
3712 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003713 return PSA_ERROR_BAD_STATE;
3714 }
3715
3716 status = psa_sign_verify_check_alg(0, alg);
3717 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003718 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003719 return status;
3720 }
3721
3722 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3723 PSA_KEY_USAGE_VERIFY_HASH,
3724 alg);
3725
3726 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003727 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003728 return status;
3729 }
3730
3731 psa_key_attributes_t attributes = {
3732 .core = slot->attr
3733 };
3734
Paul Elliott296ede92022-12-15 17:00:30 +00003735 /* Ensure ops count gets reset, in case of operation re-use. */
3736 operation->num_ops = 0;
3737
Paul Elliott9fe12f62022-11-30 19:16:02 +00003738 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3739 slot->key.data,
3740 slot->key.bytes,
3741 alg, hash, hash_length,
3742 signature, signature_length);
3743
3744 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003745 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003746 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003747 }
3748
3749 unlock_status = psa_unlock_key_slot(slot);
3750
Paul Elliottc9774412023-02-06 15:14:07 +00003751 if (unlock_status != PSA_SUCCESS) {
3752 operation->error_occurred = 1;
3753 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003754
Paul Elliottc9774412023-02-06 15:14:07 +00003755 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003756}
3757
3758psa_status_t psa_verify_hash_complete(
3759 psa_verify_hash_interruptible_operation_t *operation)
3760{
3761 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3762
Paul Elliottc9774412023-02-06 15:14:07 +00003763 /* Check that start has been called first, and that operation has not
3764 * previously errored. */
3765 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003766 status = PSA_ERROR_BAD_STATE;
3767 goto exit;
3768 }
3769
3770 status = psa_driver_wrapper_verify_hash_complete(operation);
3771
Paul Elliott296ede92022-12-15 17:00:30 +00003772 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003773 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003774 operation);
3775
Paul Elliottebe225c2023-02-10 14:32:53 +00003776exit:
3777
Paul Elliott9fe12f62022-11-30 19:16:02 +00003778 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003779 if (status != PSA_SUCCESS) {
3780 operation->error_occurred = 1;
3781 }
3782
Paul Elliott59ad9452022-12-18 15:09:02 +00003783 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003784 }
3785
3786 return status;
3787}
3788
3789psa_status_t psa_verify_hash_abort(
3790 psa_verify_hash_interruptible_operation_t *operation)
3791{
Paul Elliott59ad9452022-12-18 15:09:02 +00003792 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003793
Paul Elliott59ad9452022-12-18 15:09:02 +00003794 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003795
Paul Elliott59ad9452022-12-18 15:09:02 +00003796 /* We clear the number of ops done here, so that it is not cleared when
3797 * the operation fails or succeeds, only on manual abort. */
3798 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003799
Paul Elliottc9774412023-02-06 15:14:07 +00003800 /* Likewise, failure state. */
3801 operation->error_occurred = 0;
3802
Paul Elliott59ad9452022-12-18 15:09:02 +00003803 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003804}
3805
Paul Elliott588f8ed2022-12-02 18:10:26 +00003806/****************************************************************/
3807/* Asymmetric interruptible cryptography internal */
3808/* implementations */
3809/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003810
Paul Elliott588f8ed2022-12-02 18:10:26 +00003811void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3812{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003813
Paul Elliott588f8ed2022-12-02 18:10:26 +00003814#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3815 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3816 defined(MBEDTLS_ECP_RESTARTABLE)
3817
3818 /* Internal implementation uses zero to indicate infinite number max ops,
3819 * therefore avoid this value, and set to minimum possible. */
3820 if (max_ops == 0) {
3821 max_ops = 1;
3822 }
3823
Paul Elliott588f8ed2022-12-02 18:10:26 +00003824 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003825#else
3826 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003827#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3828 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3829 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3830}
3831
Paul Elliott588f8ed2022-12-02 18:10:26 +00003832uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003833 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003834{
3835#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3836 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3837 defined(MBEDTLS_ECP_RESTARTABLE)
3838
Paul Elliott93d9ca82023-02-15 18:14:21 +00003839 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003840#else
3841 (void) operation;
3842 return 0;
3843#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3844 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3845 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3846}
3847
3848uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003849 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003850{
3851 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3852 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3853 defined(MBEDTLS_ECP_RESTARTABLE)
3854
Paul Elliott93d9ca82023-02-15 18:14:21 +00003855 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003856#else
3857 (void) operation;
3858 return 0;
3859#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3860 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3861 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3862}
3863
3864psa_status_t mbedtls_psa_sign_hash_start(
3865 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3866 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3867 size_t key_buffer_size, psa_algorithm_t alg,
3868 const uint8_t *hash, size_t hash_length)
3869{
3870 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003871 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003872
Paul Elliott068fe072023-01-16 13:59:15 +00003873 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3874 return PSA_ERROR_NOT_SUPPORTED;
3875 }
3876
3877 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003878 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003879 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003880
3881#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003882 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3883 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003884
Paul Elliotta1c94092023-02-15 16:38:04 +00003885 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3886
Paul Elliott93d9ca82023-02-15 18:14:21 +00003887 /* Ensure num_ops is zero'ed in case of context re-use. */
3888 operation->num_ops = 0;
3889
Paul Elliott068fe072023-01-16 13:59:15 +00003890 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3891 attributes->core.bits,
3892 key_buffer,
3893 key_buffer_size,
3894 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003895
Paul Elliott068fe072023-01-16 13:59:15 +00003896 if (status != PSA_SUCCESS) {
3897 return status;
3898 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003899
Paul Elliott1bc59df2023-02-05 13:41:57 +00003900 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003901 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003902
Paul Elliott068fe072023-01-16 13:59:15 +00003903 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003904 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003905 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003906
Paul Elliott0290a762023-02-09 14:30:24 +00003907 /* We only need to store the same length of hash as the private key size
3908 * here, it would be truncated by the internal implementation anyway. */
3909 required_hash_length = (hash_length < operation->coordinate_bytes ?
3910 hash_length : operation->coordinate_bytes);
3911
Paul Elliottba70ad42023-02-15 18:23:53 +00003912 if (required_hash_length > sizeof(operation->hash)) {
3913 /* Shouldn't happen, but better safe than sorry. */
3914 return PSA_ERROR_CORRUPTION_DETECTED;
3915 }
3916
Paul Elliott0290a762023-02-09 14:30:24 +00003917 memcpy(operation->hash, hash, required_hash_length);
3918 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003919
3920 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003921
3922#else
Paul Elliott068fe072023-01-16 13:59:15 +00003923 (void) operation;
3924 (void) key_buffer;
3925 (void) key_buffer_size;
3926 (void) alg;
3927 (void) hash;
3928 (void) hash_length;
3929 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003930 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003931
Paul Elliott068fe072023-01-16 13:59:15 +00003932 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003933#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3934 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3935 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003936}
3937
3938psa_status_t mbedtls_psa_sign_hash_complete(
3939 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3940 uint8_t *signature, size_t signature_size,
3941 size_t *signature_length)
3942{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003943#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3944 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3945 defined(MBEDTLS_ECP_RESTARTABLE)
3946
Paul Elliotta1c94092023-02-15 16:38:04 +00003947 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003948 mbedtls_mpi r;
3949 mbedtls_mpi s;
3950
Paul Elliott46845252023-02-03 14:59:11 +00003951 mbedtls_mpi_init(&r);
3952 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003953
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003954 /* Ensure max_ops is set to the current value (or default). */
3955 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3956
Paul Elliotta1c94092023-02-15 16:38:04 +00003957 if (signature_size < 2 * operation->coordinate_bytes) {
3958 status = PSA_ERROR_BUFFER_TOO_SMALL;
3959 goto exit;
3960 }
3961
Paul Elliott588f8ed2022-12-02 18:10:26 +00003962 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003963
Paul Elliott588f8ed2022-12-02 18:10:26 +00003964#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3965 status = mbedtls_to_psa_error(
3966 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003967 &r,
3968 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003969 &operation->ctx->d,
3970 operation->hash,
3971 operation->hash_length,
3972 operation->md_alg,
3973 mbedtls_psa_get_random,
3974 MBEDTLS_PSA_RANDOM_STATE,
3975 &operation->restart_ctx));
3976#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003977 status = PSA_ERROR_NOT_SUPPORTED;
3978 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003979#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3980 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003981 status = mbedtls_to_psa_error(
3982 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003983 &r,
3984 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003985 &operation->ctx->d,
3986 operation->hash,
3987 operation->hash_length,
3988 mbedtls_psa_get_random,
3989 MBEDTLS_PSA_RANDOM_STATE,
3990 mbedtls_psa_get_random,
3991 MBEDTLS_PSA_RANDOM_STATE,
3992 &operation->restart_ctx));
3993 }
3994
Paul Elliottf8e5b562023-02-19 18:43:45 +00003995 /* Hide the fact that the restart context only holds a delta of number of
3996 * ops done during the last operation, not an absolute value. */
3997 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3998
Paul Elliott724bd252023-02-08 12:35:08 +00003999 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00004000 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004001 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004002 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004003 operation->coordinate_bytes)
4004 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004005
4006 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004007 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004008 }
4009
4010 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004011 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004012 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004013 operation->coordinate_bytes,
4014 operation->coordinate_bytes)
4015 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004016
4017 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004018 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004019 }
4020
Paul Elliott1bc59df2023-02-05 13:41:57 +00004021 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004022
Paul Elliott724bd252023-02-08 12:35:08 +00004023 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004024 }
Paul Elliott724bd252023-02-08 12:35:08 +00004025
4026exit:
4027
4028 mbedtls_mpi_free(&r);
4029 mbedtls_mpi_free(&s);
4030 return status;
4031
Paul Elliott588f8ed2022-12-02 18:10:26 +00004032 #else
4033
4034 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004035 (void) signature;
4036 (void) signature_size;
4037 (void) signature_length;
4038
4039 return PSA_ERROR_NOT_SUPPORTED;
4040
4041#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4042 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4043 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4044}
4045
4046psa_status_t mbedtls_psa_sign_hash_abort(
4047 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4048{
4049
4050#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4051 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4052 defined(MBEDTLS_ECP_RESTARTABLE)
4053
4054 if (operation->ctx) {
4055 mbedtls_ecdsa_free(operation->ctx);
4056 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004057 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004058 }
4059
4060 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4061
Paul Elliott93d9ca82023-02-15 18:14:21 +00004062 operation->num_ops = 0;
4063
Paul Elliott588f8ed2022-12-02 18:10:26 +00004064 return PSA_SUCCESS;
4065
4066#else
4067
4068 (void) operation;
4069
4070 return PSA_ERROR_NOT_SUPPORTED;
4071
4072#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4073 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4074 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4075}
4076
4077psa_status_t mbedtls_psa_verify_hash_start(
4078 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4079 const psa_key_attributes_t *attributes,
4080 const uint8_t *key_buffer, size_t key_buffer_size,
4081 psa_algorithm_t alg,
4082 const uint8_t *hash, size_t hash_length,
4083 const uint8_t *signature, size_t signature_length)
4084{
4085 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004086 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004087 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004088
Paul Elliott068fe072023-01-16 13:59:15 +00004089 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4090 return PSA_ERROR_NOT_SUPPORTED;
4091 }
4092
4093 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004094 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004095 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004096
4097#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004098 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4099 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004100
Paul Elliotta1c94092023-02-15 16:38:04 +00004101 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4102 mbedtls_mpi_init(&operation->r);
4103 mbedtls_mpi_init(&operation->s);
4104
Paul Elliott93d9ca82023-02-15 18:14:21 +00004105 /* Ensure num_ops is zero'ed in case of context re-use. */
4106 operation->num_ops = 0;
4107
Paul Elliott068fe072023-01-16 13:59:15 +00004108 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4109 attributes->core.bits,
4110 key_buffer,
4111 key_buffer_size,
4112 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004113
Paul Elliott068fe072023-01-16 13:59:15 +00004114 if (status != PSA_SUCCESS) {
4115 return status;
4116 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004117
Paul Elliottc569fc22023-02-10 13:02:54 +00004118 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004119
Paul Elliott1bc59df2023-02-05 13:41:57 +00004120 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004121 return PSA_ERROR_INVALID_SIGNATURE;
4122 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004123
Paul Elliott068fe072023-01-16 13:59:15 +00004124 status = mbedtls_to_psa_error(
4125 mbedtls_mpi_read_binary(&operation->r,
4126 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004127 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004128
Paul Elliott068fe072023-01-16 13:59:15 +00004129 if (status != PSA_SUCCESS) {
4130 return status;
4131 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004132
Paul Elliott068fe072023-01-16 13:59:15 +00004133 status = mbedtls_to_psa_error(
4134 mbedtls_mpi_read_binary(&operation->s,
4135 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004136 coordinate_bytes,
4137 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004138
Paul Elliott068fe072023-01-16 13:59:15 +00004139 if (status != PSA_SUCCESS) {
4140 return status;
4141 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004142
Paul Elliott2c9843f2023-02-15 17:32:42 +00004143 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004144
Paul Elliott2c9843f2023-02-15 17:32:42 +00004145 if (status != PSA_SUCCESS) {
4146 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004147 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004148
Paul Elliott0290a762023-02-09 14:30:24 +00004149 /* We only need to store the same length of hash as the private key size
4150 * here, it would be truncated by the internal implementation anyway. */
4151 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4152 coordinate_bytes);
4153
Paul Elliottba70ad42023-02-15 18:23:53 +00004154 if (required_hash_length > sizeof(operation->hash)) {
4155 /* Shouldn't happen, but better safe than sorry. */
4156 return PSA_ERROR_CORRUPTION_DETECTED;
4157 }
4158
Paul Elliott0290a762023-02-09 14:30:24 +00004159 memcpy(operation->hash, hash, required_hash_length);
4160 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004161
4162 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004163#else
Paul Elliott068fe072023-01-16 13:59:15 +00004164 (void) operation;
4165 (void) key_buffer;
4166 (void) key_buffer_size;
4167 (void) alg;
4168 (void) hash;
4169 (void) hash_length;
4170 (void) signature;
4171 (void) signature_length;
4172 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004173 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004174 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004175
Paul Elliott068fe072023-01-16 13:59:15 +00004176 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004177#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4178 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4179 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004180}
4181
4182psa_status_t mbedtls_psa_verify_hash_complete(
4183 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4184{
4185
4186#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4187 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4188 defined(MBEDTLS_ECP_RESTARTABLE)
4189
Paul Elliottf8e5b562023-02-19 18:43:45 +00004190 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4191
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004192 /* Ensure max_ops is set to the current value (or default). */
4193 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4194
Paul Elliottf8e5b562023-02-19 18:43:45 +00004195 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004196 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4197 operation->hash,
4198 operation->hash_length,
4199 &operation->ctx->Q,
4200 &operation->r,
4201 &operation->s,
4202 &operation->restart_ctx));
4203
Paul Elliottf8e5b562023-02-19 18:43:45 +00004204 /* Hide the fact that the restart context only holds a delta of number of
4205 * ops done during the last operation, not an absolute value. */
4206 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4207
4208 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004209#else
4210 (void) operation;
4211
4212 return PSA_ERROR_NOT_SUPPORTED;
4213
4214#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4215 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4216 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4217}
4218
4219psa_status_t mbedtls_psa_verify_hash_abort(
4220 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4221{
4222
4223#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4224 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4225 defined(MBEDTLS_ECP_RESTARTABLE)
4226
4227 if (operation->ctx) {
4228 mbedtls_ecdsa_free(operation->ctx);
4229 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004230 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004231 }
4232
4233 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4234
Paul Elliott93d9ca82023-02-15 18:14:21 +00004235 operation->num_ops = 0;
4236
Paul Elliott588f8ed2022-12-02 18:10:26 +00004237 mbedtls_mpi_free(&operation->r);
4238 mbedtls_mpi_free(&operation->s);
4239
4240 return PSA_SUCCESS;
4241
4242#else
4243 (void) operation;
4244
4245 return PSA_ERROR_NOT_SUPPORTED;
4246
4247#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4248 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4249 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4250}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004251
mohammad1603503973b2018-03-12 15:59:30 +02004252/****************************************************************/
4253/* Symmetric cryptography */
4254/****************************************************************/
4255
Gilles Peskine449bd832023-01-11 14:50:10 +01004256static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4257 mbedtls_svc_key_id_t key,
4258 psa_algorithm_t alg,
4259 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004260{
4261 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4262 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004263 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4265 PSA_KEY_USAGE_ENCRYPT :
4266 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004267 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004268
4269 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004271 status = PSA_ERROR_BAD_STATE;
4272 goto exit;
4273 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004274
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004276 status = PSA_ERROR_INVALID_ARGUMENT;
4277 goto exit;
4278 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004279
Gilles Peskine449bd832023-01-11 14:50:10 +01004280 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4281 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004282 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004284
Ronald Cron49fafa92021-03-10 08:34:23 +01004285 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004286 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004287 * so we only set it (in the driver wrapper) after resources have been
4288 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004289 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004291 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004293 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 }
4295 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004296
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004297 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004299 };
4300
Ronald Cronab99ac22020-10-01 16:38:28 +02004301 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 if (cipher_operation == MBEDTLS_ENCRYPT) {
4303 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4304 &attributes,
4305 slot->key.data,
4306 slot->key.bytes,
4307 alg);
4308 } else {
4309 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4310 &attributes,
4311 slot->key.data,
4312 slot->key.bytes,
4313 alg);
4314 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004315
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004316exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 if (status != PSA_SUCCESS) {
4318 psa_cipher_abort(operation);
4319 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004320
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004322
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004324}
4325
Gilles Peskine449bd832023-01-11 14:50:10 +01004326psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4327 mbedtls_svc_key_id_t key,
4328 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004329{
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004331}
4332
Gilles Peskine449bd832023-01-11 14:50:10 +01004333psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4334 mbedtls_svc_key_id_t key,
4335 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004336{
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004338}
4339
Gilles Peskine449bd832023-01-11 14:50:10 +01004340psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4341 uint8_t *iv,
4342 size_t iv_size,
4343 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004344{
Ronald Cron6d051732020-10-01 14:10:20 +02004345 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004346 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004347 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004348
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004350 status = PSA_ERROR_BAD_STATE;
4351 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004352 }
4353
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004355 status = PSA_ERROR_BAD_STATE;
4356 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004357 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004358
Ronald Cron2fb90522021-07-05 12:31:44 +02004359 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004361 status = PSA_ERROR_BUFFER_TOO_SMALL;
4362 goto exit;
4363 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004364
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004366 status = PSA_ERROR_GENERIC_ERROR;
4367 goto exit;
4368 }
4369
Gilles Peskine449bd832023-01-11 14:50:10 +01004370 status = psa_generate_random(local_iv, default_iv_length);
4371 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004372 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 }
Ronald Cron5618a392021-03-26 09:52:26 +01004374
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 status = psa_driver_wrapper_cipher_set_iv(operation,
4376 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004377
4378exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 if (status == PSA_SUCCESS) {
4380 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004381 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004382 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004384 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004386 }
Ronald Cron6d051732020-10-01 14:10:20 +02004387
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004389}
4390
Gilles Peskine449bd832023-01-11 14:50:10 +01004391psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4392 const uint8_t *iv,
4393 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004394{
Ronald Cron6d051732020-10-01 14:10:20 +02004395 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004396
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004398 status = PSA_ERROR_BAD_STATE;
4399 goto exit;
4400 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004403 status = PSA_ERROR_BAD_STATE;
4404 goto exit;
4405 }
Ronald Crona0d68172021-03-26 10:15:08 +01004406
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004408 status = PSA_ERROR_INVALID_ARGUMENT;
4409 goto exit;
4410 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004411
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 status = psa_driver_wrapper_cipher_set_iv(operation,
4413 iv,
4414 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004415
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004416exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004418 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 } else {
4420 psa_cipher_abort(operation);
4421 }
4422 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004423}
4424
Gilles Peskine449bd832023-01-11 14:50:10 +01004425psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4426 const uint8_t *input,
4427 size_t input_length,
4428 uint8_t *output,
4429 size_t output_size,
4430 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004431{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004432 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004433
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004435 status = PSA_ERROR_BAD_STATE;
4436 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004437 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004438
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004440 status = PSA_ERROR_BAD_STATE;
4441 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004442 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004443
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 status = psa_driver_wrapper_cipher_update(operation,
4445 input,
4446 input_length,
4447 output,
4448 output_size,
4449 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004450
4451exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 if (status != PSA_SUCCESS) {
4453 psa_cipher_abort(operation);
4454 }
Ronald Cron6d051732020-10-01 14:10:20 +02004455
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004457}
4458
Gilles Peskine449bd832023-01-11 14:50:10 +01004459psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4460 uint8_t *output,
4461 size_t output_size,
4462 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004463{
David Saadab4ecc272019-02-14 13:48:10 +02004464 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004465
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004467 status = PSA_ERROR_BAD_STATE;
4468 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004469 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004470
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004472 status = PSA_ERROR_BAD_STATE;
4473 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004474 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004475
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 status = psa_driver_wrapper_cipher_finish(operation,
4477 output,
4478 output_size,
4479 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004480
4481exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 if (status == PSA_SUCCESS) {
4483 return psa_cipher_abort(operation);
4484 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004485 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004487
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004489 }
mohammad1603503973b2018-03-12 15:59:30 +02004490}
4491
Gilles Peskine449bd832023-01-11 14:50:10 +01004492psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004493{
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004495 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004496 * in use. It's ok to call abort on such an object, and there's
4497 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004499 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004500
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004502
Ronald Cron49fafa92021-03-10 08:34:23 +01004503 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004504 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004505 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004506
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004508}
4509
Gilles Peskine449bd832023-01-11 14:50:10 +01004510psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4511 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004512 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004514 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 size_t output_size,
4516 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004517{
4518 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004519 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004520 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004521 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4522 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004523 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004524
David Horstmann62a56d92023-12-14 18:12:47 +00004525 LOCAL_INPUT_DECLARE(input_external, input);
4526 LOCAL_OUTPUT_DECLARE(output_external, output);
4527
David Horstmann36df4b22023-12-13 15:55:25 +00004528 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004529 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004532 status = PSA_ERROR_INVALID_ARGUMENT;
4533 goto exit;
4534 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004535
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4537 PSA_KEY_USAGE_ENCRYPT,
4538 alg);
4539 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004540 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004542
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004543 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004545 };
4546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4548 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004549 status = PSA_ERROR_GENERIC_ERROR;
4550 goto exit;
4551 }
4552
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 if (default_iv_length > 0) {
4554 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004555 status = PSA_ERROR_BUFFER_TOO_SMALL;
4556 goto exit;
4557 }
4558
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 status = psa_generate_random(local_iv, default_iv_length);
4560 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004561 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004563 }
4564
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004565 status = psa_driver_wrapper_cipher_encrypt(
4566 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004567 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004568 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004570
4571exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 unlock_status = psa_unlock_key_slot(slot);
4573 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004574 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004575 }
Ronald Cron23919522021-07-08 19:00:07 +02004576
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 if (status == PSA_SUCCESS) {
4578 if (default_iv_length > 0) {
4579 memcpy(output, local_iv, default_iv_length);
4580 }
4581 *output_length += default_iv_length;
4582 } else {
4583 *output_length = 0;
4584 }
4585
David Horstmann62a56d92023-12-14 18:12:47 +00004586 LOCAL_INPUT_FREE(input_external, input);
4587 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004588
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004590}
4591
Gilles Peskine449bd832023-01-11 14:50:10 +01004592psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4593 psa_algorithm_t alg,
4594 const uint8_t *input,
4595 size_t input_length,
4596 uint8_t *output,
4597 size_t output_size,
4598 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004599{
4600 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004601 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004602 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004603 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004606 status = PSA_ERROR_INVALID_ARGUMENT;
4607 goto exit;
4608 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004609
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4611 PSA_KEY_USAGE_DECRYPT,
4612 alg);
4613 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004614 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004616
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004617 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004619 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004620
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4622 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004623 status = PSA_ERROR_INVALID_ARGUMENT;
4624 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004626 status = PSA_ERROR_INVALID_ARGUMENT;
4627 goto exit;
4628 }
4629
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004630 status = psa_driver_wrapper_cipher_decrypt(
4631 &attributes, slot->key.data, slot->key.bytes,
4632 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004634
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004635exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004636 unlock_status = psa_unlock_key_slot(slot);
4637 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004638 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004640
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004642 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 }
Ronald Cron23919522021-07-08 19:00:07 +02004644
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004646}
4647
4648
mohammad16035955c982018-04-26 00:53:03 +03004649/****************************************************************/
4650/* AEAD */
4651/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004652
Paul Elliottbaff51c2021-09-28 17:44:45 +01004653/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004654static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004655{
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004657}
4658
4659/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004660static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4661 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004662{
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004664
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004666#if defined(PSA_WANT_ALG_GCM)
4667 case PSA_ALG_GCM:
4668 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 * arbitrarily large nonces. Please note that we do not generally
4670 * recommend the usage of nonces of greater length than
4671 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4672 * size, which can then lead to collisions if you encrypt a very
4673 * large number of messages.*/
4674 if (nonce_length != 0) {
4675 return PSA_SUCCESS;
4676 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004677 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004678#endif /* PSA_WANT_ALG_GCM */
4679#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004680 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 if (nonce_length >= 7 && nonce_length <= 13) {
4682 return PSA_SUCCESS;
4683 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004684 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004685#endif /* PSA_WANT_ALG_CCM */
4686#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004687 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 if (nonce_length == 12) {
4689 return PSA_SUCCESS;
4690 } else if (nonce_length == 8) {
4691 return PSA_ERROR_NOT_SUPPORTED;
4692 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004693 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004694#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004695 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004696 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004698 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004699
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004701}
4702
Gilles Peskine449bd832023-01-11 14:50:10 +01004703static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004704{
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4706 return PSA_ERROR_INVALID_ARGUMENT;
4707 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004708
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004710}
4711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4713 psa_algorithm_t alg,
4714 const uint8_t *nonce,
4715 size_t nonce_length,
4716 const uint8_t *additional_data,
4717 size_t additional_data_length,
4718 const uint8_t *plaintext,
4719 size_t plaintext_length,
4720 uint8_t *ciphertext,
4721 size_t ciphertext_size,
4722 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004723{
Ronald Cron215633c2021-03-16 17:15:37 +01004724 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4725 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004726
mohammad1603f08a5502018-06-03 15:05:47 +03004727 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004728
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 status = psa_aead_check_algorithm(alg);
4730 if (status != PSA_SUCCESS) {
4731 return status;
4732 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004733
Ronald Cron9a986162021-03-26 12:40:07 +01004734 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4736 if (status != PSA_SUCCESS) {
4737 return status;
4738 }
mohammad16035955c982018-04-26 00:53:03 +03004739
Ronald Cron215633c2021-03-16 17:15:37 +01004740 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004742 };
mohammad16035955c982018-04-26 00:53:03 +03004743
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 status = psa_aead_check_nonce_length(alg, nonce_length);
4745 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004746 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004748
Ronald Cronde822812021-03-17 16:08:20 +01004749 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004750 &attributes, slot->key.data, slot->key.bytes,
4751 alg,
4752 nonce, nonce_length,
4753 additional_data, additional_data_length,
4754 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004756
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4758 memset(ciphertext, 0, ciphertext_size);
4759 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004760
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004761exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004763
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004765}
4766
Gilles Peskine449bd832023-01-11 14:50:10 +01004767psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4768 psa_algorithm_t alg,
4769 const uint8_t *nonce,
4770 size_t nonce_length,
4771 const uint8_t *additional_data,
4772 size_t additional_data_length,
4773 const uint8_t *ciphertext,
4774 size_t ciphertext_length,
4775 uint8_t *plaintext,
4776 size_t plaintext_size,
4777 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004778{
Ronald Cron215633c2021-03-16 17:15:37 +01004779 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4780 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004781
Gilles Peskineee652a32018-06-01 19:23:52 +02004782 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004783
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 status = psa_aead_check_algorithm(alg);
4785 if (status != PSA_SUCCESS) {
4786 return status;
4787 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004788
Ronald Cron9a986162021-03-26 12:40:07 +01004789 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4791 if (status != PSA_SUCCESS) {
4792 return status;
4793 }
mohammad16035955c982018-04-26 00:53:03 +03004794
Ronald Cron215633c2021-03-16 17:15:37 +01004795 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004797 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004798
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 status = psa_aead_check_nonce_length(alg, nonce_length);
4800 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004801 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004803
Ronald Cronde822812021-03-17 16:08:20 +01004804 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004805 &attributes, slot->key.data, slot->key.bytes,
4806 alg,
4807 nonce, nonce_length,
4808 additional_data, additional_data_length,
4809 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004811
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 if (status != PSA_SUCCESS && plaintext_size != 0) {
4813 memset(plaintext, 0, plaintext_size);
4814 }
mohammad160360a64d02018-06-03 17:20:42 +03004815
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004816exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004818
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 return status;
mohammad16035955c982018-04-26 00:53:03 +03004820}
4821
Gilles Peskine449bd832023-01-11 14:50:10 +01004822static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4823{
4824 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004825
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004827#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004829 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4831 return PSA_ERROR_INVALID_ARGUMENT;
4832 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004833 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004834#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004835
Przemek Stekiel86679c72022-10-06 17:06:56 +02004836#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004838 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4840 return PSA_ERROR_INVALID_ARGUMENT;
4841 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004842 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004843#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004844
Przemek Stekiel86679c72022-10-06 17:06:56 +02004845#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004847 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if (tag_len != 16) {
4849 return PSA_ERROR_INVALID_ARGUMENT;
4850 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004851 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004852#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004853
4854 default:
4855 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004857 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004859}
4860
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004861/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004862static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4863 int is_encrypt,
4864 mbedtls_svc_key_id_t key,
4865 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004866{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004867 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4868 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4869 psa_key_slot_t *slot = NULL;
4870 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004871 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004872
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 status = psa_aead_check_algorithm(alg);
4874 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004875 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004877
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004879 status = PSA_ERROR_BAD_STATE;
4880 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004881 }
4882
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 if (operation->nonce_set || operation->lengths_set ||
4884 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004885 status = PSA_ERROR_BAD_STATE;
4886 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004887 }
4888
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004890 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004892 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004894
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4896 alg);
4897 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004898 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004900
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004901 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004902 .core = slot->attr
4903 };
4904
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004906 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004908
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 if (is_encrypt) {
4910 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4911 &attributes,
4912 slot->key.data,
4913 slot->key.bytes,
4914 alg);
4915 } else {
4916 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4917 &attributes,
4918 slot->key.data,
4919 slot->key.bytes,
4920 alg);
4921 }
4922 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004923 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004925
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004927
4928exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004930
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004932 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004934 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 } else {
4936 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004937 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004938
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004940}
4941
Paul Elliott302ff6b2021-04-20 18:10:30 +01004942/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004943psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4944 mbedtls_svc_key_id_t key,
4945 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004946{
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004948}
4949
4950/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004951psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4952 mbedtls_svc_key_id_t key,
4953 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004954{
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004956}
4957
4958/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004959psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4960 uint8_t *nonce,
4961 size_t nonce_size,
4962 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004963{
4964 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004965 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004966 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004967
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004968 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004969
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004971 status = PSA_ERROR_BAD_STATE;
4972 goto exit;
4973 }
4974
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004976 status = PSA_ERROR_BAD_STATE;
4977 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004978 }
4979
Paul Elliotte193ea82021-10-01 13:00:16 +01004980 /* For CCM, this size may not be correct according to the PSA
4981 * specification. The PSA Crypto 1.0.1 specification states:
4982 *
4983 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4984 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4985 *
4986 * However this restriction that L has to be the smallest integer is not
4987 * applied in practice, and it is not implementable here since the
4988 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4990 operation->alg);
4991 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004992 status = PSA_ERROR_BUFFER_TOO_SMALL;
4993 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004994 }
4995
Gilles Peskine449bd832023-01-11 14:50:10 +01004996 status = psa_generate_random(local_nonce, required_nonce_size);
4997 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004998 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005000
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005002
Paul Elliott39dc6b82021-05-11 19:16:09 +01005003exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 if (status == PSA_SUCCESS) {
5005 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005006 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005007 } else {
5008 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005009 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005010
Gilles Peskine449bd832023-01-11 14:50:10 +01005011 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005012}
5013
5014/* Set the nonce for a multipart authenticated encryption or decryption
5015 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005016psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
5017 const uint8_t *nonce,
5018 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005019{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005020 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5021
Gilles Peskine449bd832023-01-11 14:50:10 +01005022 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005023 status = PSA_ERROR_BAD_STATE;
5024 goto exit;
5025 }
5026
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005028 status = PSA_ERROR_BAD_STATE;
5029 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005030 }
5031
Gilles Peskine449bd832023-01-11 14:50:10 +01005032 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5033 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01005034 status = PSA_ERROR_INVALID_ARGUMENT;
5035 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01005036 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01005037
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5039 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005040
Paul Elliott39dc6b82021-05-11 19:16:09 +01005041exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005043 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 } else {
5045 psa_aead_abort(operation);
5046 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005047
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005049}
5050
5051/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005052psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5053 size_t ad_length,
5054 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005055{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005056 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5057
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005059 status = PSA_ERROR_BAD_STATE;
5060 goto exit;
5061 }
5062
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 if (operation->lengths_set || operation->ad_started ||
5064 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005065 status = PSA_ERROR_BAD_STATE;
5066 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005067 }
5068
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005070#if defined(PSA_WANT_ALG_GCM)
5071 case PSA_ALG_GCM:
5072 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 * bits. Without the guard this code will generate warnings on 32bit
5074 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005075#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 if (((uint64_t) ad_length) >> 61 != 0 ||
5077 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005078 status = PSA_ERROR_INVALID_ARGUMENT;
5079 goto exit;
5080 }
Paul Elliott325d3742021-09-27 17:56:28 +01005081#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005082 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005083#endif /* PSA_WANT_ALG_GCM */
5084#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005085 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005086 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005087 status = PSA_ERROR_INVALID_ARGUMENT;
5088 goto exit;
5089 }
5090 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005091#endif /* PSA_WANT_ALG_CCM */
5092#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005093 case PSA_ALG_CHACHA20_POLY1305:
5094 /* No length restrictions for ChaChaPoly. */
5095 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005096#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005097 default:
5098 break;
5099 }
Paul Elliott325d3742021-09-27 17:56:28 +01005100
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5102 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005103
Paul Elliott39dc6b82021-05-11 19:16:09 +01005104exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005106 operation->ad_remaining = ad_length;
5107 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005108 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 } else {
5110 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005111 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005112
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005114}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005115
5116/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005117psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5118 const uint8_t *input,
5119 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005120{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005121 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5122
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005124 status = PSA_ERROR_BAD_STATE;
5125 goto exit;
5126 }
5127
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005129 status = PSA_ERROR_BAD_STATE;
5130 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005131 }
5132
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 if (operation->lengths_set) {
5134 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005135 status = PSA_ERROR_INVALID_ARGUMENT;
5136 goto exit;
5137 }
5138
5139 operation->ad_remaining -= input_length;
5140 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005141#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005143 status = PSA_ERROR_BAD_STATE;
5144 goto exit;
5145 }
5146#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005147
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 status = psa_driver_wrapper_aead_update_ad(operation, input,
5149 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005150
Paul Elliott39dc6b82021-05-11 19:16:09 +01005151exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005153 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 } else {
5155 psa_aead_abort(operation);
5156 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005157
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005159}
5160
5161/* Encrypt or decrypt a message fragment in an active multipart AEAD
5162 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005163psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5164 const uint8_t *input,
5165 size_t input_length,
5166 uint8_t *output,
5167 size_t output_size,
5168 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005169{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005170 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005171
5172 *output_length = 0;
5173
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005175 status = PSA_ERROR_BAD_STATE;
5176 goto exit;
5177 }
5178
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005180 status = PSA_ERROR_BAD_STATE;
5181 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005182 }
5183
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005185 /* Additional data length was supplied, but not all the additional
5186 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005188 status = PSA_ERROR_INVALID_ARGUMENT;
5189 goto exit;
5190 }
5191
5192 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005194 status = PSA_ERROR_INVALID_ARGUMENT;
5195 goto exit;
5196 }
5197
5198 operation->body_remaining -= input_length;
5199 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005200#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005202 status = PSA_ERROR_BAD_STATE;
5203 goto exit;
5204 }
5205#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005206
Gilles Peskine449bd832023-01-11 14:50:10 +01005207 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5208 output, output_size,
5209 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005210
Paul Elliott39dc6b82021-05-11 19:16:09 +01005211exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005213 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 } else {
5215 psa_aead_abort(operation);
5216 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005217
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005219}
5220
Gilles Peskine449bd832023-01-11 14:50:10 +01005221static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005222{
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 if (operation->id == 0 || !operation->nonce_set) {
5224 return PSA_ERROR_BAD_STATE;
5225 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005226
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5228 operation->body_remaining != 0)) {
5229 return PSA_ERROR_INVALID_ARGUMENT;
5230 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005231
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005233}
5234
Paul Elliott302ff6b2021-04-20 18:10:30 +01005235/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005236psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5237 uint8_t *ciphertext,
5238 size_t ciphertext_size,
5239 size_t *ciphertext_length,
5240 uint8_t *tag,
5241 size_t tag_size,
5242 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005243{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005244 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5245
Paul Elliott302ff6b2021-04-20 18:10:30 +01005246 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005247 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005248
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 status = psa_aead_final_checks(operation);
5250 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005251 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005253
Gilles Peskine449bd832023-01-11 14:50:10 +01005254 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005255 status = PSA_ERROR_BAD_STATE;
5256 goto exit;
5257 }
5258
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5260 ciphertext_size,
5261 ciphertext_length,
5262 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005263
Paul Elliott39dc6b82021-05-11 19:16:09 +01005264exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005265
5266
Paul Elliottf47b0952021-05-21 18:02:33 +01005267 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005268 * the zero tag size, make sure the tag is set to something implausible.
5269 * Even if the operation succeeds, make sure we clear the rest of the
5270 * buffer to prevent potential leakage of anything previously placed in
5271 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005272 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005273
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005275
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005277}
5278
5279/* Finish authenticating and decrypting a message in a multipart AEAD
5280 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005281psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5282 uint8_t *plaintext,
5283 size_t plaintext_size,
5284 size_t *plaintext_length,
5285 const uint8_t *tag,
5286 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005287{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005288 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5289
Paul Elliott302ff6b2021-04-20 18:10:30 +01005290 *plaintext_length = 0;
5291
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 status = psa_aead_final_checks(operation);
5293 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005294 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005295 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005296
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005298 status = PSA_ERROR_BAD_STATE;
5299 goto exit;
5300 }
5301
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5303 plaintext_size,
5304 plaintext_length,
5305 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005306
5307exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005309
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005311}
5312
5313/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005314psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005315{
5316 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5317
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005319 /* The object has (apparently) been initialized but it is not (yet)
5320 * in use. It's ok to call abort on such an object, and there's
5321 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005323 }
5324
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005326
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005328
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005330}
5331
Gilles Peskinee59236f2018-01-27 23:32:46 +01005332/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005333/* Generators */
5334/****************************************************************/
5335
Przemek Stekiel69c46792022-06-10 12:59:51 +02005336#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005337 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005338 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305339 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305340 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005341#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005342#endif /* At least one builtin KDF */
5343
Przemek Stekiel69c46792022-06-10 12:59:51 +02005344#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005345 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5346 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5347static psa_status_t psa_key_derivation_start_hmac(
5348 psa_mac_operation_t *operation,
5349 psa_algorithm_t hash_alg,
5350 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005352{
5353 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5354 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5356 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5357 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005358
Steven Cooreman72f736a2021-05-07 14:14:37 +02005359 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005361
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 status = psa_driver_wrapper_mac_sign_setup(operation,
5363 &attributes,
5364 hmac_key, hmac_key_length,
5365 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005366
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 psa_reset_key_attributes(&attributes);
5368 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005369}
5370#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005371
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005372#define HKDF_STATE_INIT 0 /* no input yet */
5373#define HKDF_STATE_STARTED 1 /* got salt */
5374#define HKDF_STATE_KEYED 2 /* got key */
5375#define HKDF_STATE_OUTPUT 3 /* output started */
5376
Gilles Peskinecbe66502019-05-16 16:59:18 +02005377static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005379{
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5381 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5382 } else {
5383 return operation->alg;
5384 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005385}
5386
Gilles Peskine449bd832023-01-11 14:50:10 +01005387psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005388{
5389 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5391 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005392 /* The object has (apparently) been initialized but it is not
5393 * in use. It's ok to call abort on such an object, and there's
5394 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005396#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5398 mbedtls_free(operation->ctx.hkdf.info);
5399 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5400 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005401#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005402#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5403 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5405 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5406 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5407 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005408 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005410 }
5411
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005413 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005415 }
5416
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005418 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005420 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005421#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005423 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005425 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005426#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005427 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005428
5429 /* We leave the fields Ai and output_block to be erased safely by the
5430 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005432#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5433 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005434#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5436 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5437 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5438 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005439#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305440#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305441 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305442 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005443 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305444 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305445 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305446
5447 status = PSA_SUCCESS;
5448 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305449#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005450 {
5451 status = PSA_ERROR_BAD_STATE;
5452 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 mbedtls_platform_zeroize(operation, sizeof(*operation));
5454 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005455}
5456
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005457psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005459{
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005461 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005463 }
5464
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005465 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005467}
5468
Gilles Peskine449bd832023-01-11 14:50:10 +01005469psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5470 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005471{
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 if (operation->alg == 0) {
5473 return PSA_ERROR_BAD_STATE;
5474 }
5475 if (capacity > operation->capacity) {
5476 return PSA_ERROR_INVALID_ARGUMENT;
5477 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005478 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005480}
5481
Przemek Stekiel69c46792022-06-10 12:59:51 +02005482#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005483/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005484static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5485 psa_algorithm_t kdf_alg,
5486 uint8_t *output,
5487 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005488{
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5490 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005491 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005492 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005493#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005495#else
5496 const uint8_t last_block = 0xff;
5497#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005498
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 if (hkdf->state < HKDF_STATE_KEYED ||
5500 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005501#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005503#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 )) {
5505 return PSA_ERROR_BAD_STATE;
5506 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005507 hkdf->state = HKDF_STATE_OUTPUT;
5508
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005510 /* Copy what remains of the current block */
5511 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005513 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 }
5515 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005516 output += n;
5517 output_length -= n;
5518 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005520 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005522 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005523 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005524 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005525 * object was corrupted or if this function is called directly
5526 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 if (hkdf->block_number == last_block) {
5528 return PSA_ERROR_BAD_STATE;
5529 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005530
5531 /* We need a new block */
5532 ++hkdf->block_number;
5533 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005534
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5536 hash_alg,
5537 hkdf->prk,
5538 hash_length);
5539 if (status != PSA_SUCCESS) {
5540 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005541 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005542
5543 if (hkdf->block_number != 1) {
5544 status = psa_mac_update(&hkdf->hmac,
5545 hkdf->output_block,
5546 hash_length);
5547 if (status != PSA_SUCCESS) {
5548 return status;
5549 }
5550 }
5551 status = psa_mac_update(&hkdf->hmac,
5552 hkdf->info,
5553 hkdf->info_length);
5554 if (status != PSA_SUCCESS) {
5555 return status;
5556 }
5557 status = psa_mac_update(&hkdf->hmac,
5558 &hkdf->block_number, 1);
5559 if (status != PSA_SUCCESS) {
5560 return status;
5561 }
5562 status = psa_mac_sign_finish(&hkdf->hmac,
5563 hkdf->output_block,
5564 sizeof(hkdf->output_block),
5565 &hmac_output_length);
5566 if (status != PSA_SUCCESS) {
5567 return status;
5568 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005569 }
5570
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005572}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005573#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005574
John Durkop07cc04a2020-11-16 22:08:34 -08005575#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5576 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005577static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5578 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005579 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005580{
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5582 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005583 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5584 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005585 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005586
Janos Follath7742fee2019-06-17 12:58:10 +01005587 /* We can't be wanting more output after block 0xff, otherwise
5588 * the capacity check in psa_key_derivation_output_bytes() would have
5589 * prevented this call. It could happen only if the operation
5590 * object was corrupted or if this function is called directly
5591 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 if (tls12_prf->block_number == 0xff) {
5593 return PSA_ERROR_CORRUPTION_DETECTED;
5594 }
Janos Follath7742fee2019-06-17 12:58:10 +01005595
5596 /* We need a new block */
5597 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005598 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005599
5600 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5601 *
5602 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5603 *
5604 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5605 * HMAC_hash(secret, A(2) + seed) +
5606 * HMAC_hash(secret, A(3) + seed) + ...
5607 *
5608 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005609 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005610 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005611 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005612 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005613 * is currently extracted as `output_block` and where i is
5614 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005615 */
5616
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 status = psa_key_derivation_start_hmac(&hmac,
5618 hash_alg,
5619 tls12_prf->secret,
5620 tls12_prf->secret_length);
5621 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005622 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005624
5625 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005627 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5628 * the variable seed and in this instance means it in the context of the
5629 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 status = psa_mac_update(&hmac,
5631 tls12_prf->label,
5632 tls12_prf->label_length);
5633 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005634 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 }
5636 status = psa_mac_update(&hmac,
5637 tls12_prf->seed,
5638 tls12_prf->seed_length);
5639 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005640 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005641 }
5642 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005643 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5645 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005646 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005647 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005648 }
5649
Gilles Peskine449bd832023-01-11 14:50:10 +01005650 status = psa_mac_sign_finish(&hmac,
5651 tls12_prf->Ai, hash_length,
5652 &hmac_output_length);
5653 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005654 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 }
5656 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005657 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005659
5660 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 status = psa_key_derivation_start_hmac(&hmac,
5662 hash_alg,
5663 tls12_prf->secret,
5664 tls12_prf->secret_length);
5665 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005666 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 }
5668 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5669 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005670 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 }
5672 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5673 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005674 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 }
5676 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5677 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005678 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005679 }
5680 status = psa_mac_sign_finish(&hmac,
5681 tls12_prf->output_block, hash_length,
5682 &hmac_output_length);
5683 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005684 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005686
Janos Follath7742fee2019-06-17 12:58:10 +01005687
5688cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005689 cleanup_status = psa_mac_abort(&hmac);
5690 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005691 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005693
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005695}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005696
Janos Follath844eb0e2019-06-19 12:10:49 +01005697static psa_status_t psa_key_derivation_tls12_prf_read(
5698 psa_tls12_prf_key_derivation_t *tls12_prf,
5699 psa_algorithm_t alg,
5700 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005702{
Gilles Peskine449bd832023-01-11 14:50:10 +01005703 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5704 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005705 psa_status_t status;
5706 uint8_t offset, length;
5707
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005709 case PSA_TLS12_PRF_STATE_LABEL_SET:
5710 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5711 break;
5712 case PSA_TLS12_PRF_STATE_OUTPUT:
5713 break;
5714 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005716 }
5717
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005719 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 if (tls12_prf->left_in_block == 0) {
5721 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5722 alg);
5723 if (status != PSA_SUCCESS) {
5724 return status;
5725 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005726
5727 continue;
5728 }
5729
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005731 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005733 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005735
5736 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005738 output += length;
5739 output_length -= length;
5740 tls12_prf->left_in_block -= length;
5741 }
5742
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005744}
John Durkop07cc04a2020-11-16 22:08:34 -08005745#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5746 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005747
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005748#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5749static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5750 psa_tls12_ecjpake_to_pms_t *ecjpake,
5751 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005753{
5754 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005755 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005756
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 if (output_length != 32) {
5758 return PSA_ERROR_INVALID_ARGUMENT;
5759 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005760
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5762 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5763 &output_size);
5764 if (status != PSA_SUCCESS) {
5765 return status;
5766 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005767
Gilles Peskine449bd832023-01-11 14:50:10 +01005768 if (output_size != output_length) {
5769 return PSA_ERROR_GENERIC_ERROR;
5770 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005771
Gilles Peskine449bd832023-01-11 14:50:10 +01005772 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005773}
5774#endif
5775
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305776#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305777static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5778 psa_pbkdf2_key_derivation_t *pbkdf2,
5779 psa_algorithm_t prf_alg,
5780 uint8_t prf_output_length,
5781 psa_key_attributes_t *attributes)
5782{
5783 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305784 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305785 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305786 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305787 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305788 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305789 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305790
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305791 mac_operation.is_sign = 1;
5792 mac_operation.mac_size = prf_output_length;
5793 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305794
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305795 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5796 attributes,
5797 pbkdf2->password,
5798 pbkdf2->password_length,
5799 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305800 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305801 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305802 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305803 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5804 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305805 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305806 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305807 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305808 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305809 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305810 }
5811 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5812 &mac_output_length);
5813 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305814 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305815 }
5816
5817 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305818 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305819 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305820 }
5821
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305822 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305823
5824 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305825 /* We are passing prf_output_length as mac_size because the driver
5826 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305827 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305828 status = psa_driver_wrapper_mac_compute(attributes,
5829 pbkdf2->password,
5830 pbkdf2->password_length,
5831 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305832 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305833 &mac_output_length);
5834 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305835 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305836 }
5837
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305838 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305839 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305840
5841cleanup:
5842 /* Zeroise buffers to clear sensitive data from memory. */
5843 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5844 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305845}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305846
5847static psa_status_t psa_key_derivation_pbkdf2_read(
5848 psa_pbkdf2_key_derivation_t *pbkdf2,
5849 psa_algorithm_t kdf_alg,
5850 uint8_t *output,
5851 size_t output_length)
5852{
5853 psa_status_t status;
5854 psa_algorithm_t prf_alg;
5855 uint8_t prf_output_length;
5856 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5857 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5858 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5859
5860 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5861 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5862 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5863 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305864 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5865 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305866 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305867 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305868 } else {
5869 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305870 }
5871
5872 switch (pbkdf2->state) {
5873 case PSA_PBKDF2_STATE_PASSWORD_SET:
5874 /* Initially we need a new block so bytes_used is equal to block size*/
5875 pbkdf2->bytes_used = prf_output_length;
5876 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5877 break;
5878 case PSA_PBKDF2_STATE_OUTPUT:
5879 break;
5880 default:
5881 return PSA_ERROR_BAD_STATE;
5882 }
5883
5884 while (output_length != 0) {
5885 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5886 if (n > output_length) {
5887 n = (uint8_t) output_length;
5888 }
5889 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5890 output += n;
5891 output_length -= n;
5892 pbkdf2->bytes_used += n;
5893
5894 if (output_length == 0) {
5895 break;
5896 }
5897
5898 /* We need a new block */
5899 pbkdf2->bytes_used = 0;
5900 pbkdf2->block_number++;
5901
5902 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5903 prf_output_length,
5904 &attributes);
5905 if (status != PSA_SUCCESS) {
5906 return status;
5907 }
5908 }
5909
5910 return PSA_SUCCESS;
5911}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305912#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305913
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005914psa_status_t psa_key_derivation_output_bytes(
5915 psa_key_derivation_operation_t *operation,
5916 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005917 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005918{
5919 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005921
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005923 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005925 }
5926
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005928 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005929 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005930 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005931 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005932 goto exit;
5933 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005935 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005936 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005937 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5938 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005939 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005940 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005942 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005943 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005944
Przemek Stekiel69c46792022-06-10 12:59:51 +02005945#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5947 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5948 output, output_length);
5949 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005950#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005951#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5952 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005953 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5954 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5955 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5956 kdf_alg, output,
5957 output_length);
5958 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005959#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5960 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005961#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005963 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5965 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005966#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305967#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305968 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305969 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5970 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305971 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305972#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005973
Gilles Peskineeab56e42018-07-12 17:12:33 +02005974 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005975 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005977 }
5978
5979exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005981 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005982 * This allows us to differentiate between exhausted operations and
5983 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5984 * operations. */
5985 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005987 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005989 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005991}
5992
David Brown7807bf72021-02-09 16:28:23 -07005993#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005994static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005995{
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 if (data_size >= 8) {
5997 mbedtls_des_key_set_parity(data);
5998 }
5999 if (data_size >= 16) {
6000 mbedtls_des_key_set_parity(data + 8);
6001 }
6002 if (data_size >= 24) {
6003 mbedtls_des_key_set_parity(data + 16);
6004 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006005}
David Brown7807bf72021-02-09 16:28:23 -07006006#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006007
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006008/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 * ECC keys on a Weierstrass elliptic curve require the generation
6010 * of a private key which is an integer
6011 * in the range [1, N - 1], where N is the boundary of the private key domain:
6012 * N is the prime p for Diffie-Hellman, or the order of the
6013 * curve’s base point for ECC.
6014 *
6015 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6016 * This function generates the private key using the following process:
6017 *
6018 * 1. Draw a byte string of length ceiling(m/8) bytes.
6019 * 2. If m is not a multiple of 8, set the most significant
6020 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6021 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6022 * 4. If k > N - 2, discard the result and return to step 1.
6023 * 5. Output k + 1 as the private key.
6024 *
6025 * This method allows compliance to NIST standards, specifically the methods titled
6026 * Key-Pair Generation by Testing Candidates in the following publications:
6027 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6028 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6029 * Diffie-Hellman keys.
6030 *
6031 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6032 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6033 *
6034 * Note: Function allocates memory for *data buffer, so given *data should be
6035 * always NULL.
6036 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006037#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6038#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006039static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006040 psa_key_slot_t *slot,
6041 size_t bits,
6042 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006043 uint8_t **data
6044 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006045{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006046 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006047 mbedtls_mpi k;
6048 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006049 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006050 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006051 size_t m;
6052 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006053
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 mbedtls_mpi_init(&k);
6055 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006056
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006057 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006059 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006061
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006063 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006064 goto cleanup;
6065 }
6066
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006067 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006071
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006072 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006073 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006074 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006075
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006076 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006077
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006078 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006080
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006081 /* Note: This function is always called with *data == NULL and it
6082 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 *data = mbedtls_calloc(1, m_bytes);
6084 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006085 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006086 goto cleanup;
6087 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006088
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006090 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006092 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006094
6095 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006097 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006098 * (8 * ceiling(m/8) - m) bits of the first byte in
6099 * the string to zero.
6100 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006102 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006103 }
6104
6105 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 * big-endian byte string.
6107 */
6108 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006109
6110 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 * Result of comparison is returned. When it indicates error
6112 * then this function is called again.
6113 */
6114 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006115 }
6116
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006117 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6119 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006120cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 if (ret != 0) {
6122 status = mbedtls_to_psa_error(ret);
6123 }
6124 if (status != PSA_SUCCESS) {
6125 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006126 *data = NULL;
6127 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 mbedtls_mpi_free(&k);
6129 mbedtls_mpi_free(&diff_N_2);
6130 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006131}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006132
6133/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6134 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6135 *
6136 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6137 * draw a 32-byte string and process it as specified in
6138 * Elliptic Curves for Security [RFC7748] §5.
6139 *
6140 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6141 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6142 *
6143 * Note: Function allocates memory for *data buffer, so given *data should be
6144 * always NULL.
6145 */
6146
6147static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6148 size_t bits,
6149 psa_key_derivation_operation_t *operation,
6150 uint8_t **data
6151 )
6152{
6153 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006154 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006155
Gilles Peskine449bd832023-01-11 14:50:10 +01006156 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006157 case 255:
6158 output_length = 32;
6159 break;
6160 case 448:
6161 output_length = 56;
6162 break;
6163 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006165 break;
6166 }
6167
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006169
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 if (*data == NULL) {
6171 return PSA_ERROR_INSUFFICIENT_MEMORY;
6172 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006173
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006175
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006177 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006181 case 255:
6182 (*data)[0] &= 248;
6183 (*data)[31] &= 127;
6184 (*data)[31] |= 64;
6185 break;
6186 case 448:
6187 (*data)[0] &= 252;
6188 (*data)[55] |= 128;
6189 break;
6190 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006192 break;
6193 }
6194
6195 return status;
6196}
Valerio Setti86587ab2023-06-27 13:09:30 +02006197#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6198static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6199 psa_key_slot_t *slot, size_t bits,
6200 psa_key_derivation_operation_t *operation, uint8_t **data)
6201{
6202 (void) slot;
6203 (void) bits;
6204 (void) operation;
6205 (void) data;
6206 return PSA_ERROR_NOT_SUPPORTED;
6207}
6208
6209static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6210 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6211{
6212 (void) bits;
6213 (void) operation;
6214 (void) data;
6215 return PSA_ERROR_NOT_SUPPORTED;
6216}
6217#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6218#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006219
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006220static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006221 psa_key_slot_t *slot,
6222 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006224{
6225 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306227 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006228 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006229 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006230
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6232 return PSA_ERROR_INVALID_ARGUMENT;
6233 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006234
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006235#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006236 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6238 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6239 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006240 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6242 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006243 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 }
6245 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006246 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6248 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006249 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006251 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006252 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006253#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006254 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 if (key_type_is_raw_bytes(slot->attr.type)) {
6256 if (bits % 8 != 0) {
6257 return PSA_ERROR_INVALID_ARGUMENT;
6258 }
6259 data = mbedtls_calloc(1, bytes);
6260 if (data == NULL) {
6261 return PSA_ERROR_INSUFFICIENT_MEMORY;
6262 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006263
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 status = psa_key_derivation_output_bytes(operation, data, bytes);
6265 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006266 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 }
David Brown12ca5032021-02-11 11:02:00 -07006268#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6270 psa_des_set_key_parity(data, bytes);
6271 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006272#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 } else {
6274 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006275 }
Ronald Crondd04d422020-11-28 15:14:42 +01006276
Ronald Cronbf33c932020-11-28 18:06:53 +01006277 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006278 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006280 };
6281
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6283 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6284 &storage_size);
6285 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306286 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 }
Archanad8a83dc2021-06-14 10:04:16 +05306288 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 status = psa_allocate_buffer_to_slot(slot, storage_size);
6290 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306291 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 }
Archanad8a83dc2021-06-14 10:04:16 +05306293
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 status = psa_driver_wrapper_import_key(&attributes,
6295 data, bytes,
6296 slot->key.data,
6297 slot->key.bytes,
6298 &slot->key.bytes, &bits);
6299 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006300 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006302
6303exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 mbedtls_free(data);
6305 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006306}
6307
Gilles Peskine449bd832023-01-11 14:50:10 +01006308psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6309 psa_key_derivation_operation_t *operation,
6310 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006311{
6312 psa_status_t status;
6313 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006314 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006315
Ronald Cron81709fc2020-11-14 12:10:32 +01006316 *key = MBEDTLS_SVC_KEY_ID_INIT;
6317
Gilles Peskine0f84d622019-09-12 19:03:13 +02006318 /* Reject any attempt to create a zero-length key so that we don't
6319 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 if (psa_get_key_bits(attributes) == 0) {
6321 return PSA_ERROR_INVALID_ARGUMENT;
6322 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006323
Gilles Peskine449bd832023-01-11 14:50:10 +01006324 if (operation->alg == PSA_ALG_NONE) {
6325 return PSA_ERROR_BAD_STATE;
6326 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006327
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 if (!operation->can_output_key) {
6329 return PSA_ERROR_NOT_PERMITTED;
6330 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006331
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6333 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006334#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006335 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006336 /* Deriving a key in a secure element is not implemented yet. */
6337 status = PSA_ERROR_NOT_SUPPORTED;
6338 }
6339#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 if (status == PSA_SUCCESS) {
6341 status = psa_generate_derived_key_internal(slot,
6342 attributes->core.bits,
6343 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006344 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 if (status == PSA_SUCCESS) {
6346 status = psa_finish_key_creation(slot, driver, key);
6347 }
6348 if (status != PSA_SUCCESS) {
6349 psa_fail_key_creation(slot, driver);
6350 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006351
Gilles Peskine449bd832023-01-11 14:50:10 +01006352 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006353}
6354
Gilles Peskineeab56e42018-07-12 17:12:33 +02006355
6356
6357/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006358/* Key derivation */
6359/****************************************************************/
6360
Steven Cooreman932ffb72021-02-15 12:14:32 +01006361#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006362static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006363{
6364#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006365 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6366 return 1;
6367 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006368#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006369#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6371 return 1;
6372 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006373#endif
6374#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6376 return 1;
6377 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006378#endif
6379#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6381 return 1;
6382 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006383#endif
6384#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006385 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6386 return 1;
6387 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006388#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006389#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006390 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6391 return 1;
6392 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006393#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306394#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6395 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6396 return 1;
6397 }
6398#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306399#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6400 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6401 return 1;
6402 }
6403#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006405}
6406
Gilles Peskine449bd832023-01-11 14:50:10 +01006407static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006408{
6409 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 psa_status_t status = psa_hash_setup(&operation, alg);
6411 psa_hash_abort(&operation);
6412 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006413}
6414
Gilles Peskine969c5d62019-01-16 15:53:06 +01006415static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006416 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006418{
Janos Follath5fe19732019-06-20 15:09:30 +01006419 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6420 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006422
Gilles Peskine969c5d62019-01-16 15:53:06 +01006423 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 if (!is_kdf_alg_supported(kdf_alg)) {
6425 return PSA_ERROR_NOT_SUPPORTED;
6426 }
John Durkop07cc04a2020-11-16 22:08:34 -08006427
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006428 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306429 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6431 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306432 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6433 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6434 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306435 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306436 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006437 if (hash_size == 0) {
6438 return PSA_ERROR_NOT_SUPPORTED;
6439 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006440
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006441 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6442 * we might fail later, which is somewhat unfriendly and potentially
6443 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 psa_status_t status = psa_hash_try_support(hash_alg);
6445 if (status != PSA_SUCCESS) {
6446 return status;
6447 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006448 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006449
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6451 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6452 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6453 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006454 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006455#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006456 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006457 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6458 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006459 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006461#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6462 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 operation->capacity = 255 * hash_size;
6464 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006465}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006466
Gilles Peskine449bd832023-01-11 14:50:10 +01006467static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006468{
6469#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 if (alg == PSA_ALG_ECDH) {
6471 return PSA_SUCCESS;
6472 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006473#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006474#if defined(PSA_WANT_ALG_FFDH)
6475 if (alg == PSA_ALG_FFDH) {
6476 return PSA_SUCCESS;
6477 }
6478#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006479 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006481}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006482
6483static int psa_key_derivation_allows_free_form_secret_input(
6484 psa_algorithm_t kdf_alg)
6485{
6486#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6487 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6488 return 0;
6489 }
6490#endif
6491 (void) kdf_alg;
6492 return 1;
6493}
John Durkop07cc04a2020-11-16 22:08:34 -08006494#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006495
Gilles Peskine449bd832023-01-11 14:50:10 +01006496psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6497 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006498{
6499 psa_status_t status;
6500
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 if (operation->alg != 0) {
6502 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006503 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006504
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6506 return PSA_ERROR_INVALID_ARGUMENT;
6507 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6508#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6509 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6510 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6511 status = psa_key_agreement_try_support(ka_alg);
6512 if (status != PSA_SUCCESS) {
6513 return status;
6514 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006515 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6516 return PSA_ERROR_INVALID_ARGUMENT;
6517 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006518 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6519#else
6520 return PSA_ERROR_NOT_SUPPORTED;
6521#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6522 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6523#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6524 status = psa_key_derivation_setup_kdf(operation, alg);
6525#else
6526 return PSA_ERROR_NOT_SUPPORTED;
6527#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6528 } else {
6529 return PSA_ERROR_INVALID_ARGUMENT;
6530 }
6531
6532 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006533 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 }
6535 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006536}
6537
Przemek Stekiel69c46792022-06-10 12:59:51 +02006538#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006539static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6540 psa_algorithm_t kdf_alg,
6541 psa_key_derivation_step_t step,
6542 const uint8_t *data,
6543 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006544{
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006546 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006548 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006549#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6551 return PSA_ERROR_INVALID_ARGUMENT;
6552 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006553#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 if (hkdf->state != HKDF_STATE_INIT) {
6555 return PSA_ERROR_BAD_STATE;
6556 } else {
6557 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6558 hash_alg,
6559 data, data_length);
6560 if (status != PSA_SUCCESS) {
6561 return status;
6562 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006563 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006565 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006566 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006567#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006569 /* We shouldn't be in different state as HKDF_EXPAND only allows
6570 * two inputs: SECRET (this case) and INFO which does not modify
6571 * the state. It could happen only if the hkdf
6572 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006573 if (hkdf->state != HKDF_STATE_INIT) {
6574 return PSA_ERROR_BAD_STATE;
6575 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006576
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006577 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6579 return PSA_ERROR_INVALID_ARGUMENT;
6580 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006581
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 memcpy(hkdf->prk, data, data_length);
6583 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006584#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006585 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006586 /* HKDF: If no salt was provided, use an empty salt.
6587 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006588 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006589#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6591 return PSA_ERROR_BAD_STATE;
6592 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006593#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6595 hash_alg,
6596 NULL, 0);
6597 if (status != PSA_SUCCESS) {
6598 return status;
6599 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006600 hkdf->state = HKDF_STATE_STARTED;
6601 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006602 if (hkdf->state != HKDF_STATE_STARTED) {
6603 return PSA_ERROR_BAD_STATE;
6604 }
6605 status = psa_mac_update(&hkdf->hmac,
6606 data, data_length);
6607 if (status != PSA_SUCCESS) {
6608 return status;
6609 }
6610 status = psa_mac_sign_finish(&hkdf->hmac,
6611 hkdf->prk,
6612 sizeof(hkdf->prk),
6613 &data_length);
6614 if (status != PSA_SUCCESS) {
6615 return status;
6616 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006617 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006618
Gilles Peskine2b522db2019-04-12 15:11:49 +02006619 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006620 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006621#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006622 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006623 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006625 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006627#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006628 {
6629 /* Block 0 is empty, and the next block will be
6630 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006631 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006632 }
6633
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006635 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006636#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6638 return PSA_ERROR_INVALID_ARGUMENT;
6639 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006640#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006641#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006642 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6643 hkdf->state == HKDF_STATE_INIT) {
6644 return PSA_ERROR_BAD_STATE;
6645 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006646#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006647 if (hkdf->state == HKDF_STATE_OUTPUT) {
6648 return PSA_ERROR_BAD_STATE;
6649 }
6650 if (hkdf->info_set) {
6651 return PSA_ERROR_BAD_STATE;
6652 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006653 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 if (data_length != 0) {
6655 hkdf->info = mbedtls_calloc(1, data_length);
6656 if (hkdf->info == NULL) {
6657 return PSA_ERROR_INSUFFICIENT_MEMORY;
6658 }
6659 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006660 }
6661 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006663 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006664 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006665 }
6666}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006667#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006668
John Durkop07cc04a2020-11-16 22:08:34 -08006669#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6670 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006671static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6672 const uint8_t *data,
6673 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006674{
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6676 return PSA_ERROR_BAD_STATE;
6677 }
Janos Follathf08e2652019-06-13 09:05:41 +01006678
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 if (data_length != 0) {
6680 prf->seed = mbedtls_calloc(1, data_length);
6681 if (prf->seed == NULL) {
6682 return PSA_ERROR_INSUFFICIENT_MEMORY;
6683 }
Janos Follathf08e2652019-06-13 09:05:41 +01006684
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006686 prf->seed_length = data_length;
6687 }
Janos Follathf08e2652019-06-13 09:05:41 +01006688
Gilles Peskine43f958b2020-12-13 14:55:14 +01006689 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006690
Gilles Peskine449bd832023-01-11 14:50:10 +01006691 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006692}
6693
Gilles Peskine449bd832023-01-11 14:50:10 +01006694static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6695 const uint8_t *data,
6696 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006697{
Gilles Peskine449bd832023-01-11 14:50:10 +01006698 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6699 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6700 return PSA_ERROR_BAD_STATE;
6701 }
Janos Follath81550542019-06-13 14:26:34 +01006702
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 if (data_length != 0) {
6704 prf->secret = mbedtls_calloc(1, data_length);
6705 if (prf->secret == NULL) {
6706 return PSA_ERROR_INSUFFICIENT_MEMORY;
6707 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006708
Gilles Peskine449bd832023-01-11 14:50:10 +01006709 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006710 prf->secret_length = data_length;
6711 }
Janos Follath81550542019-06-13 14:26:34 +01006712
Gilles Peskine43f958b2020-12-13 14:55:14 +01006713 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006714
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006716}
6717
Gilles Peskine449bd832023-01-11 14:50:10 +01006718static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6719 const uint8_t *data,
6720 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006721{
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6723 return PSA_ERROR_BAD_STATE;
6724 }
Janos Follath63028dd2019-06-13 09:15:47 +01006725
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 if (data_length != 0) {
6727 prf->label = mbedtls_calloc(1, data_length);
6728 if (prf->label == NULL) {
6729 return PSA_ERROR_INSUFFICIENT_MEMORY;
6730 }
Janos Follath63028dd2019-06-13 09:15:47 +01006731
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006733 prf->label_length = data_length;
6734 }
Janos Follath63028dd2019-06-13 09:15:47 +01006735
Gilles Peskine43f958b2020-12-13 14:55:14 +01006736 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006737
Gilles Peskine449bd832023-01-11 14:50:10 +01006738 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006739}
6740
Gilles Peskine449bd832023-01-11 14:50:10 +01006741static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6742 psa_key_derivation_step_t step,
6743 const uint8_t *data,
6744 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006745{
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006747 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006748 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006749 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006750 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006751 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006753 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006755 }
6756}
John Durkop07cc04a2020-11-16 22:08:34 -08006757#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6758 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6759
6760#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6761static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6762 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006763 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006765{
6766 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6768 4 + data_length + prf->other_secret_length :
6769 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006770
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6772 return PSA_ERROR_INVALID_ARGUMENT;
6773 }
John Durkop07cc04a2020-11-16 22:08:34 -08006774
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 uint8_t *pms = mbedtls_calloc(1, pms_len);
6776 if (pms == NULL) {
6777 return PSA_ERROR_INSUFFICIENT_MEMORY;
6778 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006779 uint8_t *cur = pms;
6780
6781 /* pure-PSK:
6782 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006783 *
6784 * The premaster secret is formed as follows: if the PSK is N octets
6785 * long, concatenate a uint16 with the value N, N zero octets, a second
6786 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006787 *
6788 * mixed-PSK:
6789 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6790 * follows: concatenate a uint16 with the length of the other secret,
6791 * the other secret itself, uint16 with the length of PSK, and the
6792 * PSK itself.
6793 * For details please check:
6794 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6795 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6796 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006797 */
6798
Gilles Peskine449bd832023-01-11 14:50:10 +01006799 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6800 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6801 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6802 if (prf->other_secret_length != 0) {
6803 memcpy(cur, prf->other_secret, prf->other_secret_length);
6804 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006805 cur += prf->other_secret_length;
6806 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 } else {
6808 *cur++ = MBEDTLS_BYTE_1(data_length);
6809 *cur++ = MBEDTLS_BYTE_0(data_length);
6810 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006811 cur += data_length;
6812 }
6813
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 *cur++ = MBEDTLS_BYTE_1(data_length);
6815 *cur++ = MBEDTLS_BYTE_0(data_length);
6816 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006817 cur += data_length;
6818
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006819 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006820
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006821 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006823}
Janos Follath6660f0e2019-06-17 08:44:03 +01006824
Przemek Stekiele47201b2022-04-19 13:53:28 +02006825static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6826 psa_tls12_prf_key_derivation_t *prf,
6827 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006829{
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6831 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006832 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006833
6834 if (data_length != 0) {
6835 prf->other_secret = mbedtls_calloc(1, data_length);
6836 if (prf->other_secret == NULL) {
6837 return PSA_ERROR_INSUFFICIENT_MEMORY;
6838 }
6839
6840 memcpy(prf->other_secret, data, data_length);
6841 prf->other_secret_length = data_length;
6842 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006843 prf->other_secret_length = 0;
6844 }
6845
6846 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6847
Gilles Peskine449bd832023-01-11 14:50:10 +01006848 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006849}
6850
Janos Follath6660f0e2019-06-17 08:44:03 +01006851static psa_status_t psa_tls12_prf_psk_to_ms_input(
6852 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006853 psa_key_derivation_step_t step,
6854 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006856{
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006858 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 return psa_tls12_prf_psk_to_ms_set_key(prf,
6860 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006861 break;
6862 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6864 data,
6865 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006866 break;
6867 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006869 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006870
Przemek Stekiele47201b2022-04-19 13:53:28 +02006871 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006872}
John Durkop07cc04a2020-11-16 22:08:34 -08006873#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006874
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006875#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6876static psa_status_t psa_tls12_ecjpake_to_pms_input(
6877 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006878 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006879 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006881{
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6883 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6884 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006885 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006886
6887 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 if (data[0] != 0x04) {
6889 return PSA_ERROR_INVALID_ARGUMENT;
6890 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006891
6892 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006894
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006896}
6897#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306898
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306899#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306900static psa_status_t psa_pbkdf2_set_input_cost(
6901 psa_pbkdf2_key_derivation_t *pbkdf2,
6902 psa_key_derivation_step_t step,
6903 uint64_t data)
6904{
6905 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6906 return PSA_ERROR_INVALID_ARGUMENT;
6907 }
6908
6909 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6910 return PSA_ERROR_BAD_STATE;
6911 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306912
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306913 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306914 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306915 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306916
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306917 if (data == 0) {
6918 return PSA_ERROR_INVALID_ARGUMENT;
6919 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306920
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306921 pbkdf2->input_cost = data;
6922 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6923
6924 return PSA_SUCCESS;
6925}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306926
6927static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6928 const uint8_t *data,
6929 size_t data_length)
6930{
Gilles Peskineead17662023-08-20 22:02:51 +02006931 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6932 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6933 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6934 /* Appending to existing salt. No state change. */
6935 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306936 return PSA_ERROR_BAD_STATE;
6937 }
6938
Gilles Peskineca57d782023-07-20 19:08:06 +02006939 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006940 /* Appending an empty string, nothing to do. */
6941 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306942 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306943
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306944 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6945 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306946 return PSA_ERROR_INSUFFICIENT_MEMORY;
6947 }
6948
Gilles Peskineead17662023-08-20 22:02:51 +02006949 if (pbkdf2->salt_length != 0) {
6950 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6951 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306952 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306953 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306954 mbedtls_free(pbkdf2->salt);
6955 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306956 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306957 return PSA_SUCCESS;
6958}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306959
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306960#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306961static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306962 const uint8_t *input,
6963 size_t input_len,
6964 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306965 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306966{
6967 psa_status_t status = PSA_SUCCESS;
6968 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6969 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306970 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306971 } else {
6972 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306973 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306974 }
6975 return status;
6976}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306977#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306978
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306979#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306980static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6981 size_t input_len,
6982 uint8_t *output,
6983 size_t *output_len)
6984{
6985 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306986 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306987 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306988 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306989 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6990 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6991 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306992 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306993 * mac_size as the driver function sets mac_output_length = mac_size
6994 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306995 status = psa_driver_wrapper_mac_compute(&attributes,
6996 zeros, sizeof(zeros),
6997 PSA_ALG_CMAC, input, input_len,
6998 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306999 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7000 128U,
7001 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307002 output_len);
7003 } else {
7004 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307005 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307006 }
7007 return status;
7008}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307009#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307010
7011static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307012 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307013 const uint8_t *data,
7014 size_t data_length)
7015{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307016 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307017 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7018 return PSA_ERROR_BAD_STATE;
7019 }
7020
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307021#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307022 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7023 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7024 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7025 pbkdf2->password,
7026 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307027 } else
7028#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7029#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7030 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307031 status = psa_pbkdf2_cmac_set_password(data, data_length,
7032 pbkdf2->password,
7033 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307034 } else
7035#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7036 {
7037 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307038 }
7039
7040 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7041
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307042 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307043}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307044
7045static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307046 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307047 psa_key_derivation_step_t step,
7048 const uint8_t *data,
7049 size_t data_length)
7050{
7051 switch (step) {
7052 case PSA_KEY_DERIVATION_INPUT_SALT:
7053 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7054 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307055 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307056 default:
7057 return PSA_ERROR_INVALID_ARGUMENT;
7058 }
7059}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307060#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307061
Gilles Peskineb8965192019-09-24 16:21:10 +02007062/** Check whether the given key type is acceptable for the given
7063 * input step of a key derivation.
7064 *
7065 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7066 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7067 * Both secret and non-secret inputs can alternatively have the type
7068 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7069 * that the input was passed as a buffer rather than via a key object.
7070 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007071static int psa_key_derivation_check_input_type(
7072 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007073 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007074{
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007076 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 if (key_type == PSA_KEY_TYPE_DERIVE) {
7078 return PSA_SUCCESS;
7079 }
7080 if (key_type == PSA_KEY_TYPE_NONE) {
7081 return PSA_SUCCESS;
7082 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007083 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007084 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 if (key_type == PSA_KEY_TYPE_DERIVE) {
7086 return PSA_SUCCESS;
7087 }
7088 if (key_type == PSA_KEY_TYPE_NONE) {
7089 return PSA_SUCCESS;
7090 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007091 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007092 case PSA_KEY_DERIVATION_INPUT_LABEL:
7093 case PSA_KEY_DERIVATION_INPUT_SALT:
7094 case PSA_KEY_DERIVATION_INPUT_INFO:
7095 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7097 return PSA_SUCCESS;
7098 }
7099 if (key_type == PSA_KEY_TYPE_NONE) {
7100 return PSA_SUCCESS;
7101 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007102 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307103 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7104 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7105 return PSA_SUCCESS;
7106 }
7107 if (key_type == PSA_KEY_TYPE_DERIVE) {
7108 return PSA_SUCCESS;
7109 }
7110 if (key_type == PSA_KEY_TYPE_NONE) {
7111 return PSA_SUCCESS;
7112 }
7113 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007114 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007116}
7117
Janos Follathb80a94e2019-06-12 15:54:46 +01007118static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007119 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007120 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007121 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007122 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007123 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007124{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007125 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007126 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007127
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 status = psa_key_derivation_check_input_type(step, key_type);
7129 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007130 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007132
Przemek Stekiel69c46792022-06-10 12:59:51 +02007133#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7135 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7136 step, data, data_length);
7137 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007138#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007139#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7141 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7142 step, data, data_length);
7143 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007144#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7145#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7147 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7148 step, data, data_length);
7149 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007150#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007151#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007153 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7155 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007156#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307157#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307158 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307159 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7160 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307161 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307162#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007163 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007164 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007165 (void) data;
7166 (void) data_length;
7167 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007169 }
7170
Gilles Peskine224b0d62019-09-23 18:13:17 +02007171exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 if (status != PSA_SUCCESS) {
7173 psa_key_derivation_abort(operation);
7174 }
7175 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007176}
7177
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307178static psa_status_t psa_key_derivation_input_integer_internal(
7179 psa_key_derivation_operation_t *operation,
7180 psa_key_derivation_step_t step,
7181 uint64_t value)
7182{
7183 psa_status_t status;
7184 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7185
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307186#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307187 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307188 status = psa_pbkdf2_set_input_cost(
7189 &operation->ctx.pbkdf2, step, value);
7190 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307191#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307192 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307193 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307194 (void) value;
7195 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307196 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307197 }
7198
7199 if (status != PSA_SUCCESS) {
7200 psa_key_derivation_abort(operation);
7201 }
7202 return status;
7203}
7204
Janos Follath51f4a0f2019-06-14 11:35:55 +01007205psa_status_t psa_key_derivation_input_bytes(
7206 psa_key_derivation_operation_t *operation,
7207 psa_key_derivation_step_t step,
7208 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007210{
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 return psa_key_derivation_input_internal(operation, step,
7212 PSA_KEY_TYPE_NONE,
7213 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007214}
7215
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307216psa_status_t psa_key_derivation_input_integer(
7217 psa_key_derivation_operation_t *operation,
7218 psa_key_derivation_step_t step,
7219 uint64_t value)
7220{
7221 return psa_key_derivation_input_integer_internal(operation, step, value);
7222}
7223
Janos Follath51f4a0f2019-06-14 11:35:55 +01007224psa_status_t psa_key_derivation_input_key(
7225 psa_key_derivation_operation_t *operation,
7226 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007227 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007228{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007229 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007230 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007231 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007232
Ronald Cron5c522922020-11-14 16:35:34 +01007233 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007234 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7235 if (status != PSA_SUCCESS) {
7236 psa_key_derivation_abort(operation);
7237 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007238 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007239
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307240 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7241 * permission to output to a key object. */
7242 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7243 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007244 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007246
Gilles Peskine449bd832023-01-11 14:50:10 +01007247 status = psa_key_derivation_input_internal(operation,
7248 step, slot->attr.type,
7249 slot->key.data,
7250 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007251
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007253
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007255}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007256
7257
7258
7259/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007260/* Key agreement */
7261/****************************************************************/
7262
Gilles Peskine449bd832023-01-11 14:50:10 +01007263psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7264 const uint8_t *key_buffer,
7265 size_t key_buffer_size,
7266 psa_algorithm_t alg,
7267 const uint8_t *peer_key,
7268 size_t peer_key_length,
7269 uint8_t *shared_secret,
7270 size_t shared_secret_size,
7271 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007272{
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007274#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007275 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7277 key_buffer_size, alg,
7278 peer_key, peer_key_length,
7279 shared_secret,
7280 shared_secret_size,
7281 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007282#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007283
7284#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7285 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007286 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007287 peer_key,
7288 peer_key_length,
7289 key_buffer,
7290 key_buffer_size,
7291 shared_secret,
7292 shared_secret_size,
7293 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007294#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7295
Gilles Peskine01d718c2018-09-18 12:01:02 +02007296 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007297 (void) attributes;
7298 (void) key_buffer;
7299 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007300 (void) peer_key;
7301 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007302 (void) shared_secret;
7303 (void) shared_secret_size;
7304 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007305 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007306 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007307}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007308
Aditya Deshpande17845b82022-10-13 17:21:01 +01007309/** Internal function for raw key agreement
7310 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007311 * to the driver's implementation if a driver is present.
7312 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007313 * (psa_key_agreement_raw_builtin).
7314 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007315static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7316 psa_key_slot_t *private_key,
7317 const uint8_t *peer_key,
7318 size_t peer_key_length,
7319 uint8_t *shared_secret,
7320 size_t shared_secret_size,
7321 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007322{
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7324 return PSA_ERROR_NOT_SUPPORTED;
7325 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007326
7327 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007329 };
7330
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 return psa_driver_wrapper_key_agreement(&attributes,
7332 private_key->key.data,
7333 private_key->key.bytes, alg,
7334 peer_key, peer_key_length,
7335 shared_secret,
7336 shared_secret_size,
7337 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007338}
7339
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007340/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007341 * to potentially free embedded data structures and wipe confidential data.
7342 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007343static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7344 psa_key_derivation_step_t step,
7345 psa_key_slot_t *private_key,
7346 const uint8_t *peer_key,
7347 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007348{
7349 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007350 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007351 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007353
7354 /* Step 1: run the secret agreement algorithm to generate the shared
7355 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 status = psa_key_agreement_raw_internal(ka_alg,
7357 private_key,
7358 peer_key, peer_key_length,
7359 shared_secret,
7360 sizeof(shared_secret),
7361 &shared_secret_length);
7362 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007363 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007365
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007366 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007367 * the shared secret. A shared secret is permitted wherever a key
7368 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 status = psa_key_derivation_input_internal(operation, step,
7370 PSA_KEY_TYPE_DERIVE,
7371 shared_secret,
7372 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007373exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7375 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007376}
7377
Gilles Peskine449bd832023-01-11 14:50:10 +01007378psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7379 psa_key_derivation_step_t step,
7380 mbedtls_svc_key_id_t private_key,
7381 const uint8_t *peer_key,
7382 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007383{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007384 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007385 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007386 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007387
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7389 return PSA_ERROR_INVALID_ARGUMENT;
7390 }
Ronald Cron5c522922020-11-14 16:35:34 +01007391 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7393 if (status != PSA_SUCCESS) {
7394 return status;
7395 }
7396 status = psa_key_agreement_internal(operation, step,
7397 slot,
7398 peer_key, peer_key_length);
7399 if (status != PSA_SUCCESS) {
7400 psa_key_derivation_abort(operation);
7401 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007402 /* If a private key has been added as SECRET, we allow the derived
7403 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007405 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007407 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007408
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007410
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007412}
7413
Gilles Peskine449bd832023-01-11 14:50:10 +01007414psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7415 mbedtls_svc_key_id_t private_key,
7416 const uint8_t *peer_key,
7417 size_t peer_key_length,
7418 uint8_t *output,
7419 size_t output_size,
7420 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007421{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007422 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007423 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007424 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007425 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007426
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007428 status = PSA_ERROR_INVALID_ARGUMENT;
7429 goto exit;
7430 }
Ronald Cron5c522922020-11-14 16:35:34 +01007431 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7433 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007434 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007436
Gilles Peskine3e561302022-04-14 00:17:15 +02007437 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7438 * for the output size. The PSA specification only guarantees that this
7439 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7440 * but it might be nice to allow smaller buffers if the output fits.
7441 * At the time of writing this comment, with only ECDH implemented,
7442 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7443 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7444 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007445 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7447 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007448 status = PSA_ERROR_BUFFER_TOO_SMALL;
7449 goto exit;
7450 }
7451
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 status = psa_key_agreement_raw_internal(alg, slot,
7453 peer_key, peer_key_length,
7454 output, output_size,
7455 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007456
7457exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007459 /* If an error happens and is not handled properly, the output
7460 * may be used as a key to protect sensitive data. Arrange for such
7461 * a key to be random, which is likely to result in decryption or
7462 * verification errors. This is better than filling the buffer with
7463 * some constant data such as zeros, which would result in the data
7464 * being protected with a reproducible, easily knowable key.
7465 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007467 *output_length = output_size;
7468 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007469
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007471
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007473}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007474
7475
Gilles Peskine30524eb2020-11-13 17:02:26 +01007476
Gilles Peskine86a440b2018-11-12 18:39:40 +01007477/****************************************************************/
7478/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007479/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007480
Gilles Peskine672a7712023-04-28 21:00:28 +02007481#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7482#include "entropy_poll.h"
7483#endif
7484
Gilles Peskine30524eb2020-11-13 17:02:26 +01007485/** Initialize the PSA random generator.
7486 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007487static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007488{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007489#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007491#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7492
Gilles Peskine30524eb2020-11-13 17:02:26 +01007493 /* Set default configuration if
7494 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007495 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007496 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 }
7498 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007499 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007501
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007503#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7504 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7505 /* The PSA entropy injection feature depends on using NV seed as an entropy
7506 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 mbedtls_entropy_add_source(&rng->entropy,
7508 mbedtls_nv_seed_poll, NULL,
7509 MBEDTLS_ENTROPY_BLOCK_SIZE,
7510 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007511#endif
7512
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007514#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007515}
7516
7517/** Deinitialize the PSA random generator.
7518 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007519static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007520{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007521#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007523#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007524 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7525 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007526#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007527}
7528
7529/** Seed the PSA random generator.
7530 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007531static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007532{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007533#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7534 /* Do nothing: the external RNG seeds itself. */
7535 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007537#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007538 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7540 drbg_seed, sizeof(drbg_seed) - 1);
7541 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007542#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007543}
7544
Gilles Peskine449bd832023-01-11 14:50:10 +01007545psa_status_t psa_generate_random(uint8_t *output,
7546 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007547{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007548 GUARD_MODULE_INITIALIZED;
7549
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007550#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7551
7552 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7554 output, output_size,
7555 &output_length);
7556 if (status != PSA_SUCCESS) {
7557 return status;
7558 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007559 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007560 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 if (output_length != output_size) {
7562 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7563 }
7564 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007565
7566#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7567
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007569 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007570 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7571 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7572 output_size);
7573 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7574 output, request_size);
7575 if (ret != 0) {
7576 return mbedtls_to_psa_error(ret);
7577 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007578 output_size -= request_size;
7579 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007580 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007582#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007583}
7584
Gilles Peskine8814fc42020-12-14 15:33:44 +01007585/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007586 *
7587 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7588 * `psa_generate_random(...)`. The state parameter is ignored since the
7589 * PSA API doesn't support passing an explicit state.
7590 *
7591 * In the non-external case, psa_generate_random() calls an
7592 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7593 * and semantics as mbedtls_psa_get_random(). As an optimization,
7594 * instead of doing this back-and-forth between the PSA API and the
7595 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7596 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007597 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007598#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7599int mbedtls_psa_get_random(void *p_rng,
7600 unsigned char *output,
7601 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007602{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007603 /* This function takes a pointer to the RNG state because that's what
7604 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7605 * its own state internally and doesn't let the caller access that state.
7606 * So we just ignore the state parameter, and in practice we'll pass
7607 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007608 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 psa_status_t status = psa_generate_random(output, output_size);
7610 if (status == PSA_SUCCESS) {
7611 return 0;
7612 } else {
7613 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7614 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007615}
7616#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7617
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007618#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007619psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7620 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007621{
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 if (global_data.initialized) {
7623 return PSA_ERROR_NOT_PERMITTED;
7624 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007625
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7627 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7628 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7629 return PSA_ERROR_INVALID_ARGUMENT;
7630 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007631
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007633}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007634#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007635
Ronald Cron3772afe2021-02-08 16:10:05 +01007636/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007637 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007638 * \param type The key type
7639 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007640 *
7641 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007642 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007643 * \retval #PSA_ERROR_INVALID_ARGUMENT
7644 * The size in bits of the key is not valid.
7645 * \retval #PSA_ERROR_NOT_SUPPORTED
7646 * The type and/or the size in bits of the key or the combination of
7647 * the two is not supported.
7648 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007649static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007651{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007652 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007653
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 if (key_type_is_raw_bytes(type)) {
7655 status = psa_validate_unstructured_key_bit_size(type, bits);
7656 if (status != PSA_SUCCESS) {
7657 return status;
7658 }
7659 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007660#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7662 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7663 return PSA_ERROR_NOT_SUPPORTED;
7664 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007665 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007666 return PSA_ERROR_NOT_SUPPORTED;
7667 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007668
Ronald Cron01b2aba2020-10-05 09:42:02 +02007669 /* Accept only byte-aligned keys, for the same reasons as
7670 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 if (bits % 8 != 0) {
7672 return PSA_ERROR_NOT_SUPPORTED;
7673 }
7674 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007675#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007676
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007677#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007679 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 return PSA_SUCCESS;
7681 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007682#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007683
Valerio Settia55f0422023-07-10 15:34:41 +02007684#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007685 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007686 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007687 return PSA_ERROR_NOT_SUPPORTED;
7688 }
7689 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007690#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007691 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007693 }
7694
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007696}
7697
Ronald Cron55ed0592020-10-05 10:30:40 +02007698psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007699 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007700 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007701{
7702 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007703 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007704
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 if ((attributes->domain_parameters == NULL) &&
7706 (attributes->domain_parameters_size != 0)) {
7707 return PSA_ERROR_INVALID_ARGUMENT;
7708 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007709
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 if (key_type_is_raw_bytes(type)) {
7711 status = psa_generate_random(key_buffer, key_buffer_size);
7712 if (status != PSA_SUCCESS) {
7713 return status;
7714 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007715
David Brown12ca5032021-02-11 11:02:00 -07007716#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 if (type == PSA_KEY_TYPE_DES) {
7718 psa_des_set_key_parity(key_buffer, key_buffer_size);
7719 }
David Brown8107e312021-02-12 08:08:46 -07007720#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007722
Valerio Setti76df8c12023-07-11 14:11:28 +02007723#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7725 return mbedtls_psa_rsa_generate_key(attributes,
7726 key_buffer,
7727 key_buffer_size,
7728 key_buffer_length);
7729 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007730#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007731
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007732#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007733 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7734 return mbedtls_psa_ecp_generate_key(attributes,
7735 key_buffer,
7736 key_buffer_size,
7737 key_buffer_length);
7738 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007739#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007740
Valerio Settia55f0422023-07-10 15:34:41 +02007741#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007742 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7743 return mbedtls_psa_ffdh_generate_key(attributes,
7744 key_buffer,
7745 key_buffer_size,
7746 key_buffer_length);
7747 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007748#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007749 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 (void) key_buffer_length;
7751 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007752 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007753
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007755}
Darryl Green0c6575a2018-11-07 16:05:30 +00007756
Gilles Peskine449bd832023-01-11 14:50:10 +01007757psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7758 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007759{
7760 psa_status_t status;
7761 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007762 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007763 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007764
Ronald Cron81709fc2020-11-14 12:10:32 +01007765 *key = MBEDTLS_SVC_KEY_ID_INIT;
7766
Gilles Peskine0f84d622019-09-12 19:03:13 +02007767 /* Reject any attempt to create a zero-length key so that we don't
7768 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007769 if (psa_get_key_bits(attributes) == 0) {
7770 return PSA_ERROR_INVALID_ARGUMENT;
7771 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007772
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007773 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007774 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7775 return PSA_ERROR_INVALID_ARGUMENT;
7776 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007777
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7779 &slot, &driver);
7780 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007781 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007782 }
Gilles Peskine11792082019-08-06 18:36:36 +02007783
Ronald Cron977c2472020-10-13 08:32:21 +02007784 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307785 * storage ( thus not in the case of generating a key in a secure element
7786 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7787 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 if (slot->key.data == NULL) {
7789 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7790 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007791 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007792 attributes->core.type, attributes->core.bits);
7793 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007794 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007795 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007796
7797 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 attributes->core.type,
7799 attributes->core.bits);
7800 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007801 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 attributes, &key_buffer_size);
7803 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007804 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007805 }
Ronald Cron977c2472020-10-13 08:32:21 +02007806 }
Ronald Cron977c2472020-10-13 08:32:21 +02007807
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7809 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007810 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007811 }
Ronald Cron977c2472020-10-13 08:32:21 +02007812 }
7813
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 status = psa_driver_wrapper_generate_key(attributes,
7815 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007816
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 if (status != PSA_SUCCESS) {
7818 psa_remove_key_data_from_memory(slot);
7819 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007820
Gilles Peskine11792082019-08-06 18:36:36 +02007821exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007822 if (status == PSA_SUCCESS) {
7823 status = psa_finish_key_creation(slot, driver, key);
7824 }
7825 if (status != PSA_SUCCESS) {
7826 psa_fail_key_creation(slot, driver);
7827 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007828
Gilles Peskine449bd832023-01-11 14:50:10 +01007829 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007830}
7831
Gilles Peskinee59236f2018-01-27 23:32:46 +01007832/****************************************************************/
7833/* Module setup */
7834/****************************************************************/
7835
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007836#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007837psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 void (* entropy_init)(mbedtls_entropy_context *ctx),
7839 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007840{
Gilles Peskine449bd832023-01-11 14:50:10 +01007841 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7842 return PSA_ERROR_BAD_STATE;
7843 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007844 global_data.rng.entropy_init = entropy_init;
7845 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007847}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007848#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007849
Gilles Peskine449bd832023-01-11 14:50:10 +01007850void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007851{
Gilles Peskine449bd832023-01-11 14:50:10 +01007852 psa_wipe_all_key_slots();
7853 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7854 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007855 }
7856 /* Wipe all remaining data, including configuration.
7857 * In particular, this sets all state indicator to the value
7858 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007859 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007860
7861 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007862 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007863}
7864
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007865#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7866/** Recover a transaction that was interrupted by a power failure.
7867 *
7868 * This function is called during initialization, before psa_crypto_init()
7869 * returns. If this function returns a failure status, the initialization
7870 * fails.
7871 */
7872static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007874{
Gilles Peskine449bd832023-01-11 14:50:10 +01007875 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007876 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7877 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007878 /* TODO - fall through to the failure case until this
7879 * is implemented.
7880 * https://github.com/ARMmbed/mbed-crypto/issues/218
7881 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007882 default:
7883 /* We found an unsupported transaction in the storage.
7884 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007886 }
7887}
7888#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7889
Gilles Peskine449bd832023-01-11 14:50:10 +01007890psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007891{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007892 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007893
Gilles Peskinec6b69072018-11-20 21:42:52 +01007894 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 if (global_data.initialized != 0) {
7896 return PSA_SUCCESS;
7897 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007898
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007899 /* Init drivers */
7900 status = psa_driver_wrapper_init();
7901 if (status != PSA_SUCCESS) {
7902 goto exit;
7903 }
7904 global_data.drivers_initialized = 1;
7905
Gilles Peskine30524eb2020-11-13 17:02:26 +01007906 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007908 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 status = mbedtls_psa_random_seed(&global_data.rng);
7910 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007911 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007913 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007914
Gilles Peskine449bd832023-01-11 14:50:10 +01007915 status = psa_initialize_key_slots();
7916 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01007917 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007919
Gilles Peskine4b734222019-07-24 15:56:31 +02007920#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 status = psa_crypto_load_transaction();
7922 if (status == PSA_SUCCESS) {
7923 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7924 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007925 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 }
7927 status = psa_crypto_stop_transaction();
7928 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007929 /* There's no transaction to complete. It's all good. */
7930 status = PSA_SUCCESS;
7931 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007932#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007933
Gilles Peskinec6b69072018-11-20 21:42:52 +01007934 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007935 global_data.initialized = 1;
7936
7937exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 if (status != PSA_SUCCESS) {
7939 mbedtls_psa_crypto_free();
7940 }
7941 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007942}
7943
Yanray Wangffc3c482023-07-11 12:01:04 +08007944#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007945psa_status_t psa_crypto_driver_pake_get_password_len(
7946 const psa_crypto_driver_pake_inputs_t *inputs,
7947 size_t *password_len)
7948{
7949 if (inputs->password_len == 0) {
7950 return PSA_ERROR_BAD_STATE;
7951 }
7952
7953 *password_len = inputs->password_len;
7954
7955 return PSA_SUCCESS;
7956}
7957
7958psa_status_t psa_crypto_driver_pake_get_password(
7959 const psa_crypto_driver_pake_inputs_t *inputs,
7960 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7961{
7962 if (inputs->password_len == 0) {
7963 return PSA_ERROR_BAD_STATE;
7964 }
7965
7966 if (buffer_size < inputs->password_len) {
7967 return PSA_ERROR_BUFFER_TOO_SMALL;
7968 }
7969
7970 memcpy(buffer, inputs->password, inputs->password_len);
7971 *buffer_length = inputs->password_len;
7972
7973 return PSA_SUCCESS;
7974}
7975
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007976psa_status_t psa_crypto_driver_pake_get_user_len(
7977 const psa_crypto_driver_pake_inputs_t *inputs,
7978 size_t *user_len)
7979{
7980 if (inputs->user_len == 0) {
7981 return PSA_ERROR_BAD_STATE;
7982 }
7983
7984 *user_len = inputs->user_len;
7985
7986 return PSA_SUCCESS;
7987}
7988
7989psa_status_t psa_crypto_driver_pake_get_user(
7990 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007991 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007992{
7993 if (inputs->user_len == 0) {
7994 return PSA_ERROR_BAD_STATE;
7995 }
7996
Przemek Stekielc0e62502023-03-14 11:49:36 +01007997 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007998 return PSA_ERROR_BUFFER_TOO_SMALL;
7999 }
8000
Przemek Stekielc0e62502023-03-14 11:49:36 +01008001 memcpy(user_id, inputs->user, inputs->user_len);
8002 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008003
8004 return PSA_SUCCESS;
8005}
8006
8007psa_status_t psa_crypto_driver_pake_get_peer_len(
8008 const psa_crypto_driver_pake_inputs_t *inputs,
8009 size_t *peer_len)
8010{
8011 if (inputs->peer_len == 0) {
8012 return PSA_ERROR_BAD_STATE;
8013 }
8014
8015 *peer_len = inputs->peer_len;
8016
8017 return PSA_SUCCESS;
8018}
8019
8020psa_status_t psa_crypto_driver_pake_get_peer(
8021 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008022 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008023{
8024 if (inputs->peer_len == 0) {
8025 return PSA_ERROR_BAD_STATE;
8026 }
8027
Przemek Stekielc0e62502023-03-14 11:49:36 +01008028 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008029 return PSA_ERROR_BUFFER_TOO_SMALL;
8030 }
8031
Przemek Stekielc0e62502023-03-14 11:49:36 +01008032 memcpy(peer_id, inputs->peer, inputs->peer_len);
8033 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008034
8035 return PSA_SUCCESS;
8036}
8037
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008038psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8039 const psa_crypto_driver_pake_inputs_t *inputs,
8040 psa_pake_cipher_suite_t *cipher_suite)
8041{
8042 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8043 return PSA_ERROR_BAD_STATE;
8044 }
8045
8046 *cipher_suite = inputs->cipher_suite;
8047
8048 return PSA_SUCCESS;
8049}
8050
Neil Armstronga7d08c32022-06-01 18:21:20 +02008051psa_status_t psa_pake_setup(
8052 psa_pake_operation_t *operation,
8053 const psa_pake_cipher_suite_t *cipher_suite)
8054{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008055 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008056
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008057 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008058 status = PSA_ERROR_BAD_STATE;
8059 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008060 }
8061
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008062 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008063 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008064 status = PSA_ERROR_INVALID_ARGUMENT;
8065 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008066 }
8067
Przemek Stekiel51eac532022-12-07 11:04:51 +01008068 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8069
Przemek Stekiele12ed362022-12-21 12:54:46 +01008070 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008071 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8072 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008073 operation->data.inputs.cipher_suite = *cipher_suite;
8074
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008075#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008076 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008077 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008078 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008079
David Horstmann16f01512023-06-14 17:21:07 +01008080 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008081 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008082 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008083#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008084 {
8085 status = PSA_ERROR_NOT_SUPPORTED;
8086 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008087 }
8088
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008089 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8090
Przemek Stekiel51eac532022-12-07 11:04:51 +01008091 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008092exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008093 psa_pake_abort(operation);
8094 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008095}
8096
8097psa_status_t psa_pake_set_password_key(
8098 psa_pake_operation_t *operation,
8099 mbedtls_svc_key_id_t password)
8100{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008101 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008102 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8103 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008104 psa_key_attributes_t attributes;
8105 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008106
Przemek Stekiel51eac532022-12-07 11:04:51 +01008107 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008108 status = PSA_ERROR_BAD_STATE;
8109 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008110 }
8111
Przemek Stekiel6c764412022-11-22 14:05:12 +01008112 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8113 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008114 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008115 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008116 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008117 }
8118
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008119 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008120 .core = slot->attr
8121 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008122
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008123 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008124
Przemek Stekiel51eac532022-12-07 11:04:51 +01008125 if (type != PSA_KEY_TYPE_PASSWORD &&
8126 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8127 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008128 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008129 }
8130
Przemek Stekiel51eac532022-12-07 11:04:51 +01008131 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8132 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008133 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008134 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008135 }
8136
8137 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8138 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008139 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008140exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008141 if (status != PSA_SUCCESS) {
8142 psa_pake_abort(operation);
8143 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008144 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008145 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008146}
8147
8148psa_status_t psa_pake_set_user(
8149 psa_pake_operation_t *operation,
8150 const uint8_t *user_id,
8151 size_t user_id_len)
8152{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008153 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008154
8155 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008156 status = PSA_ERROR_BAD_STATE;
8157 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008158 }
8159
Przemek Stekiel51eac532022-12-07 11:04:51 +01008160 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008161 status = PSA_ERROR_INVALID_ARGUMENT;
8162 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008163 }
8164
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008165 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008166 status = PSA_ERROR_BAD_STATE;
8167 goto exit;
8168 }
8169
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008170 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8171 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008172 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8173 goto exit;
8174 }
8175
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008176 memcpy(operation->data.inputs.user, user_id, user_id_len);
8177 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008178
8179 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008180exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008181 psa_pake_abort(operation);
8182 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008183}
8184
8185psa_status_t psa_pake_set_peer(
8186 psa_pake_operation_t *operation,
8187 const uint8_t *peer_id,
8188 size_t peer_id_len)
8189{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008190 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008191
8192 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008193 status = PSA_ERROR_BAD_STATE;
8194 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008195 }
8196
Przemek Stekiel51eac532022-12-07 11:04:51 +01008197 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008198 status = PSA_ERROR_INVALID_ARGUMENT;
8199 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008200 }
8201
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008202 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008203 status = PSA_ERROR_BAD_STATE;
8204 goto exit;
8205 }
8206
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008207 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8208 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008209 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8210 goto exit;
8211 }
8212
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008213 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8214 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008215
8216 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008217exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008218 psa_pake_abort(operation);
8219 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008220}
8221
8222psa_status_t psa_pake_set_role(
8223 psa_pake_operation_t *operation,
8224 psa_pake_role_t role)
8225{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008226 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008227
Przemek Stekiel51eac532022-12-07 11:04:51 +01008228 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008229 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008230 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008231 }
8232
Przemek Stekiel09104b82023-03-06 14:11:51 +01008233 switch (operation->alg) {
8234#if defined(PSA_WANT_ALG_JPAKE)
8235 case PSA_ALG_JPAKE:
8236 if (role == PSA_PAKE_ROLE_NONE) {
8237 return PSA_SUCCESS;
8238 }
8239 status = PSA_ERROR_INVALID_ARGUMENT;
8240 break;
8241#endif
8242 default:
8243 (void) role;
8244 status = PSA_ERROR_NOT_SUPPORTED;
8245 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008246 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008247exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008248 psa_pake_abort(operation);
8249 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008250}
8251
David Horstmanne7f21e62023-05-12 18:17:21 +01008252/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008253#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008254static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008255 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008256{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008257 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008258 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008259 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008260
David Horstmann024e5c52023-06-14 15:48:21 +01008261 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008262 is_x1 = (stage->outputs < 1);
8263 } else {
8264 is_x1 = (stage->inputs < 1);
8265 }
8266
David Horstmann74a3d8c2023-06-14 18:28:19 +01008267 key_share_step = is_x1 ?
8268 PSA_JPAKE_X1_STEP_KEY_SHARE :
8269 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008270 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008271 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8272 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8273 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8274 } else {
8275 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008276 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008277 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008278}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008279#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008280
Przemek Stekiel2797d372022-12-22 11:19:22 +01008281static psa_status_t psa_pake_complete_inputs(
8282 psa_pake_operation_t *operation)
8283{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008284 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008285 /* Create copy of the inputs on stack as inputs share memory
8286 with the driver context which will be setup by the driver. */
8287 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008288
Przemek Stekielfde11282023-03-13 16:06:09 +01008289 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008290 return PSA_ERROR_BAD_STATE;
8291 }
8292
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008293 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008294 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8295 return PSA_ERROR_BAD_STATE;
8296 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008297 }
8298
Przemek Stekiel18620a32023-01-17 16:34:52 +01008299 /* Clear driver context */
8300 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8301
8302 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008303
8304 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008305 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008306
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008307 /* User and peer are translated to role. */
8308 mbedtls_free(inputs.user);
8309 mbedtls_free(inputs.peer);
8310
Przemek Stekiel2797d372022-12-22 11:19:22 +01008311 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008312#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008313 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008314 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008315 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008316#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008317 {
8318 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008319 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008320 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008321 return status;
8322}
8323
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008324#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008325static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008326 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008327 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008328 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008329{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008330 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8331 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8332 step != PSA_PAKE_STEP_ZK_PROOF) {
8333 return PSA_ERROR_INVALID_ARGUMENT;
8334 }
8335
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008336 psa_jpake_computation_stage_t *computation_stage =
8337 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008338
David Horstmann5da95602023-06-08 15:37:12 +01008339 if (computation_stage->round != PSA_JPAKE_FIRST &&
8340 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008341 return PSA_ERROR_BAD_STATE;
8342 }
8343
David Horstmanne7f21e62023-05-12 18:17:21 +01008344 /* Check that the step we are given is the one we were expecting */
8345 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008346 return PSA_ERROR_BAD_STATE;
8347 }
8348
David Horstmanne7f21e62023-05-12 18:17:21 +01008349 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8350 computation_stage->inputs == 0 &&
8351 computation_stage->outputs == 0) {
8352 /* Start of the round, so function decides whether we are inputting
8353 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008354 computation_stage->io_mode = io_mode;
8355 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008356 /* Middle of the round so the mode we are in must match the function
8357 * called by the user */
8358 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008359 }
8360
8361 return PSA_SUCCESS;
8362}
8363
David Horstmanne7f21e62023-05-12 18:17:21 +01008364static psa_status_t psa_jpake_epilogue(
8365 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008366 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008367{
David Horstmanne7f21e62023-05-12 18:17:21 +01008368 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008369 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008370
David Horstmanne7f21e62023-05-12 18:17:21 +01008371 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8372 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008373 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008374 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008375 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008376 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008377 }
8378 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008379 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008380 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008381 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008382 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008383 }
8384 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008385 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8386 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008387 /* End of a round, move to the next round */
8388 stage->inputs = 0;
8389 stage->outputs = 0;
8390 stage->round++;
8391 }
8392 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008393 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008394 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008395 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008396 return PSA_SUCCESS;
8397}
David Horstmanne7f21e62023-05-12 18:17:21 +01008398
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008399#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008400
Neil Armstronga7d08c32022-06-01 18:21:20 +02008401psa_status_t psa_pake_output(
8402 psa_pake_operation_t *operation,
8403 psa_pake_step_t step,
8404 uint8_t *output,
8405 size_t output_size,
8406 size_t *output_length)
8407{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008408 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008409 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008410 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008411
8412 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008413 status = psa_pake_complete_inputs(operation);
8414 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008415 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008416 }
8417 }
8418
8419 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008420 status = PSA_ERROR_BAD_STATE;
8421 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008422 }
8423
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008424 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008425 status = PSA_ERROR_INVALID_ARGUMENT;
8426 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008427 }
8428
Przemek Stekiele12ed362022-12-21 12:54:46 +01008429 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008430#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008431 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008432 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008433 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008434 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008435 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008436 driver_step = convert_jpake_computation_stage_to_driver_step(
8437 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008438 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008439#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008440 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008441 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008442 status = PSA_ERROR_NOT_SUPPORTED;
8443 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008444 }
8445
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008446 status = psa_driver_wrapper_pake_output(operation, driver_step,
8447 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008448
8449 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008450 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008451 }
8452
8453 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008454#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008455 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008456 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008457 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008458 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008459 }
8460 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008461#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008462 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008463 status = PSA_ERROR_NOT_SUPPORTED;
8464 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008465 }
8466
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008467 return PSA_SUCCESS;
8468exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008469 psa_pake_abort(operation);
8470 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008471}
8472
8473psa_status_t psa_pake_input(
8474 psa_pake_operation_t *operation,
8475 psa_pake_step_t step,
8476 const uint8_t *input,
8477 size_t input_length)
8478{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008479 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008480 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008481 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8482 operation->primitive,
8483 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008484
8485 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008486 status = psa_pake_complete_inputs(operation);
8487 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008488 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008489 }
8490 }
8491
8492 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008493 status = PSA_ERROR_BAD_STATE;
8494 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008495 }
8496
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008497 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008498 status = PSA_ERROR_INVALID_ARGUMENT;
8499 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008500 }
8501
Przemek Stekiele12ed362022-12-21 12:54:46 +01008502 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008503#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008504 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008505 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008506 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008507 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008508 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008509 driver_step = convert_jpake_computation_stage_to_driver_step(
8510 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008511 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008512#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008513 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008514 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008515 status = PSA_ERROR_NOT_SUPPORTED;
8516 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008517 }
8518
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008519 status = psa_driver_wrapper_pake_input(operation, driver_step,
8520 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008521
8522 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008523 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008524 }
8525
8526 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008527#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008528 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008529 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008530 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008531 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008532 }
8533 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008534#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008535 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008536 status = PSA_ERROR_NOT_SUPPORTED;
8537 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008538 }
8539
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008540 return PSA_SUCCESS;
8541exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008542 psa_pake_abort(operation);
8543 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008544}
8545
8546psa_status_t psa_pake_get_implicit_key(
8547 psa_pake_operation_t *operation,
8548 psa_key_derivation_operation_t *output)
8549{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008550 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008551 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008552 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008553 size_t shared_key_len = 0;
8554
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008555 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008556 status = PSA_ERROR_BAD_STATE;
8557 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008558 }
8559
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008560#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008561 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008562 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008563 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008564 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008565 status = PSA_ERROR_BAD_STATE;
8566 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008567 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008568 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008569#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008570 {
8571 status = PSA_ERROR_NOT_SUPPORTED;
8572 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008573 }
8574
Przemek Stekiel0c781802022-11-29 14:53:13 +01008575 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8576 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008577 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008578 &shared_key_len);
8579
8580 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008581 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008582 }
8583
8584 status = psa_key_derivation_input_bytes(output,
8585 PSA_KEY_DERIVATION_INPUT_SECRET,
8586 shared_key,
8587 shared_key_len);
8588
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008589 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008590exit:
8591 abort_status = psa_pake_abort(operation);
8592 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008593}
8594
8595psa_status_t psa_pake_abort(
8596 psa_pake_operation_t *operation)
8597{
Przemek Stekield69dca92023-01-31 19:59:20 +01008598 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008599
Przemek Stekield69dca92023-01-31 19:59:20 +01008600 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008601 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008602 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008603
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008604 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8605 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008606 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008607 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008608 }
8609 if (operation->data.inputs.user != NULL) {
8610 mbedtls_free(operation->data.inputs.user);
8611 }
8612 if (operation->data.inputs.peer != NULL) {
8613 mbedtls_free(operation->data.inputs.peer);
8614 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008615 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008616 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008617
Przemek Stekield69dca92023-01-31 19:59:20 +01008618 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008619}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008620#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008621
David Horstmann00d7a042023-12-07 18:39:17 +00008622/* Memory copying test hooks. These are called before input copy, after input
8623 * copy, before output copy and after output copy, respectively.
8624 * They are used by memory-poisoning tests to temporarily unpoison buffers
8625 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008626#if defined(MBEDTLS_TEST_HOOKS)
8627void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8628void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8629void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8630void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8631#endif
David Horstmannfde97392023-10-30 20:29:43 +00008632
David Horstmann1b7279a2023-11-15 15:18:30 +00008633/** Copy from an input buffer to a local copy.
8634 *
8635 * \param[in] input Pointer to input buffer.
8636 * \param[in] input_len Length of the input buffer.
8637 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8638 * \param[out] input_copy_len Length of the local copy buffer.
8639 * \return #PSA_SUCCESS, if the buffer was successfully
8640 * copied.
8641 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8642 * copy is too small to hold contents of the
8643 * input buffer.
8644 */
8645MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008646psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8647 uint8_t *input_copy, size_t input_copy_len)
8648{
8649 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008650 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008651 }
8652
David Horstmann372b8bb2023-11-24 16:21:04 +00008653#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008654 if (psa_input_pre_copy_hook != NULL) {
8655 psa_input_pre_copy_hook(input, input_len);
8656 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008657#endif
8658
David Horstmann777e7412023-11-15 17:33:47 +00008659 if (input_len > 0) {
8660 memcpy(input_copy, input, input_len);
8661 }
David Horstmannfde97392023-10-30 20:29:43 +00008662
David Horstmann372b8bb2023-11-24 16:21:04 +00008663#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008664 if (psa_input_post_copy_hook != NULL) {
8665 psa_input_post_copy_hook(input, input_len);
8666 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008667#endif
8668
David Horstmannfde97392023-10-30 20:29:43 +00008669 return PSA_SUCCESS;
8670}
8671
David Horstmann1b7279a2023-11-15 15:18:30 +00008672/** Copy from a local output buffer into a user-supplied one.
8673 *
8674 * \param[in] output_copy Pointer to a local buffer containing the output.
8675 * \param[in] output_copy_len Length of the local buffer.
8676 * \param[out] output Pointer to user-supplied output buffer.
8677 * \param[out] output_len Length of the user-supplied output buffer.
8678 * \return #PSA_SUCCESS, if the buffer was successfully
8679 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008680 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008681 * user-supplied output buffer is too small to
8682 * hold the contents of the local buffer.
8683 */
8684MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008685psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8686 uint8_t *output, size_t output_len)
8687{
8688 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008689 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008690 }
David Horstmann777e7412023-11-15 17:33:47 +00008691
David Horstmann372b8bb2023-11-24 16:21:04 +00008692#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008693 if (psa_output_pre_copy_hook != NULL) {
8694 psa_output_pre_copy_hook(output, output_len);
8695 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008696#endif
8697
David Horstmann777e7412023-11-15 17:33:47 +00008698 if (output_copy_len > 0) {
8699 memcpy(output, output_copy, output_copy_len);
8700 }
8701
David Horstmann372b8bb2023-11-24 16:21:04 +00008702#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008703 if (psa_output_post_copy_hook != NULL) {
8704 psa_output_post_copy_hook(output, output_len);
8705 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008706#endif
8707
David Horstmann8978f5c2023-10-30 20:37:12 +00008708 return PSA_SUCCESS;
8709}
8710
David Horstmannf1734052023-11-20 17:15:32 +00008711psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8712 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008713{
8714 psa_status_t status;
8715
David Horstmann9db14482023-11-23 15:50:37 +00008716 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008717
David Horstmannc5cc1c32023-11-15 18:11:26 +00008718 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008719 return PSA_SUCCESS;
8720 }
8721
David Horstmannf1734052023-11-20 17:15:32 +00008722 local_input->buffer = mbedtls_calloc(input_len, 1);
8723 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008724 /* Since we dealt with the zero-length case above, we know that
8725 * a NULL return value means a failure of allocation. */
8726 return PSA_ERROR_INSUFFICIENT_MEMORY;
8727 }
David Horstmannf1734052023-11-20 17:15:32 +00008728 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008729
David Horstmannf1734052023-11-20 17:15:32 +00008730 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008731
8732 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008733 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008734 if (status != PSA_SUCCESS) {
8735 goto error;
8736 }
8737
8738 return PSA_SUCCESS;
8739
8740error:
David Horstmannf1734052023-11-20 17:15:32 +00008741 mbedtls_free(local_input->buffer);
8742 local_input->buffer = NULL;
8743 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008744 return status;
8745}
8746
David Horstmannf1734052023-11-20 17:15:32 +00008747void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008748{
David Horstmannf1734052023-11-20 17:15:32 +00008749 mbedtls_free(local_input->buffer);
8750 local_input->buffer = NULL;
8751 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008752}
8753
David Horstmann89875a42023-11-20 12:54:09 +00008754psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8755 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008756{
David Horstmann9db14482023-11-23 15:50:37 +00008757 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008758
David Horstmannc5cc1c32023-11-15 18:11:26 +00008759 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008760 return PSA_SUCCESS;
8761 }
David Horstmann89875a42023-11-20 12:54:09 +00008762 local_output->buffer = mbedtls_calloc(output_len, 1);
8763 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008764 /* Since we dealt with the zero-length case above, we know that
8765 * a NULL return value means a failure of allocation. */
8766 return PSA_ERROR_INSUFFICIENT_MEMORY;
8767 }
David Horstmann89875a42023-11-20 12:54:09 +00008768 local_output->length = output_len;
8769 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008770
8771 return PSA_SUCCESS;
8772}
8773
Gabor Mezei1882c512024-01-24 13:07:17 +01008774psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8775 psa_crypto_local_output_t *local_output)
8776{
8777 psa_status_t status;
8778 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8779
8780 if (output_len == 0) {
8781 return PSA_SUCCESS;
8782 }
8783 local_output->buffer = mbedtls_calloc(output_len, 1);
8784 if (local_output->buffer == NULL) {
8785 /* Since we dealt with the zero-length case above, we know that
8786 * a NULL return value means a failure of allocation. */
8787 return PSA_ERROR_INSUFFICIENT_MEMORY;
8788 }
8789 local_output->length = output_len;
8790 local_output->original = output;
8791
8792 status = psa_crypto_copy_input(output, output_len,
8793 local_output->buffer, local_output->length);
8794 if (status != PSA_SUCCESS) {
8795 goto error;
8796 }
8797
8798 return PSA_SUCCESS;
8799
8800error:
8801 mbedtls_free(local_output->buffer);
8802 local_output->buffer = NULL;
8803 local_output->length = 0;
8804 return status;
8805}
8806
David Horstmann89875a42023-11-20 12:54:09 +00008807psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008808{
David Horstmannc335a4e2023-11-15 15:57:32 +00008809 psa_status_t status;
8810
David Horstmann89875a42023-11-20 12:54:09 +00008811 if (local_output->buffer == NULL) {
8812 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008813 return PSA_SUCCESS;
8814 }
David Horstmann89875a42023-11-20 12:54:09 +00008815 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008816 /* We have an internal copy but nothing to copy back to. */
8817 return PSA_ERROR_CORRUPTION_DETECTED;
8818 }
8819
David Horstmann89875a42023-11-20 12:54:09 +00008820 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8821 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008822 if (status != PSA_SUCCESS) {
8823 return status;
8824 }
David Horstmann9467ea32023-11-08 17:44:18 +00008825
David Horstmann89875a42023-11-20 12:54:09 +00008826 mbedtls_free(local_output->buffer);
8827 local_output->buffer = NULL;
8828 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008829
8830 return PSA_SUCCESS;
8831}
8832
Gilles Peskinee59236f2018-01-27 23:32:46 +01008833#endif /* MBEDTLS_PSA_CRYPTO_C */