blob: f6a06a0da0d07545cb391e014e1e8d8080578b87 [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
3183exit:
3184 LOCAL_INPUT_FREE(input_external, input);
3185 LOCAL_OUTPUT_FREE(signature_external, signature);
3186 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003187}
3188
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003189psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003190 const psa_key_attributes_t *attributes,
3191 const uint8_t *key_buffer,
3192 size_t key_buffer_size,
3193 psa_algorithm_t alg,
3194 const uint8_t *input,
3195 size_t input_length,
3196 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003198{
3199 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003200
Gilles Peskine449bd832023-01-11 14:50:10 +01003201 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003202 size_t hash_length;
3203 uint8_t hash[PSA_HASH_MAX_SIZE];
3204
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003205 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003206 PSA_ALG_SIGN_GET_HASH(alg),
3207 input, input_length,
3208 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003211 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003213
3214 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003215 attributes, key_buffer, key_buffer_size,
3216 alg, hash, hash_length,
3217 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003218 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003221}
3222
Gilles Peskine449bd832023-01-11 14:50:10 +01003223psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3224 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003225 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003226 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003227 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003229{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003230 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3231 LOCAL_INPUT_DECLARE(input_external, input);
3232 LOCAL_INPUT_DECLARE(signature_external, signature);
3233
3234 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3235 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3236 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3237 signature_length);
3238
3239exit:
3240 LOCAL_INPUT_FREE(input_external, input);
3241 LOCAL_INPUT_FREE(signature_external, signature);
3242
3243 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003244}
3245
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003246psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003247 const psa_key_attributes_t *attributes,
3248 const uint8_t *key_buffer, size_t key_buffer_size,
3249 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003251{
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3253 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3254 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003255#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3257 return mbedtls_psa_rsa_sign_hash(
3258 attributes,
3259 key_buffer, key_buffer_size,
3260 alg, hash, hash_length,
3261 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003262#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3263 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003264 } else {
3265 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003266 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003267 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3268 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003269#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3271 return mbedtls_psa_ecdsa_sign_hash(
3272 attributes,
3273 key_buffer, key_buffer_size,
3274 alg, hash, hash_length,
3275 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003276#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3277 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 } else {
3279 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003280 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003281 }
Ronald Cron4501c982021-03-19 20:09:32 +01003282
Gilles Peskine449bd832023-01-11 14:50:10 +01003283 (void) key_buffer;
3284 (void) key_buffer_size;
3285 (void) hash;
3286 (void) hash_length;
3287 (void) signature;
3288 (void) signature_size;
3289 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003290
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003292}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003293
Gilles Peskine449bd832023-01-11 14:50:10 +01003294psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3295 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003296 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003298 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 size_t signature_size,
3300 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003301{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003302 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3303 LOCAL_INPUT_DECLARE(hash_external, hash);
3304 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3305
3306 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3307 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3308 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3309 signature_size, signature_length);
3310
3311exit:
3312 LOCAL_INPUT_FREE(hash_external, hash);
3313 LOCAL_OUTPUT_FREE(signature_external, signature);
3314
3315 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003316}
3317
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003318psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003319 const psa_key_attributes_t *attributes,
3320 const uint8_t *key_buffer, size_t key_buffer_size,
3321 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003322 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003323{
Gilles Peskine449bd832023-01-11 14:50:10 +01003324 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3325 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3326 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003327#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003328 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3329 return mbedtls_psa_rsa_verify_hash(
3330 attributes,
3331 key_buffer, key_buffer_size,
3332 alg, hash, hash_length,
3333 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003334#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3335 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 } else {
3337 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003338 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3340 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003341#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3343 return mbedtls_psa_ecdsa_verify_hash(
3344 attributes,
3345 key_buffer, key_buffer_size,
3346 alg, hash, hash_length,
3347 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003348#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3349 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003350 } else {
3351 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003352 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003353 }
Ronald Cron4501c982021-03-19 20:09:32 +01003354
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 (void) key_buffer;
3356 (void) key_buffer_size;
3357 (void) hash;
3358 (void) hash_length;
3359 (void) signature;
3360 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003361
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003363}
3364
Gilles Peskine449bd832023-01-11 14:50:10 +01003365psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3366 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003367 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003369 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003371{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003372 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3373 LOCAL_INPUT_DECLARE(hash_external, hash);
3374 LOCAL_INPUT_DECLARE(signature_external, signature);
3375
3376 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3377 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3378 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3379 signature_length);
3380
3381exit:
3382 LOCAL_INPUT_FREE(hash_external, hash);
3383 LOCAL_INPUT_FREE(signature_external, signature);
3384
3385 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003386}
3387
Gilles Peskine449bd832023-01-11 14:50:10 +01003388psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3389 psa_algorithm_t alg,
3390 const uint8_t *input,
3391 size_t input_length,
3392 const uint8_t *salt,
3393 size_t salt_length,
3394 uint8_t *output,
3395 size_t output_size,
3396 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003397{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003398 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003399 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003400 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003401 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003402
Darryl Green5cc689a2018-07-24 15:34:10 +01003403 (void) input;
3404 (void) input_length;
3405 (void) salt;
3406 (void) output;
3407 (void) output_size;
3408
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003409 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003410
Gilles Peskine449bd832023-01-11 14:50:10 +01003411 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3412 return PSA_ERROR_INVALID_ARGUMENT;
3413 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003414
Ronald Cron5c522922020-11-14 16:35:34 +01003415 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003416 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3417 if (status != PSA_SUCCESS) {
3418 return status;
3419 }
3420 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3421 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003422 status = PSA_ERROR_INVALID_ARGUMENT;
3423 goto exit;
3424 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003425
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003426 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003427 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003428 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003429
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003430 status = psa_driver_wrapper_asymmetric_encrypt(
3431 &attributes, slot->key.data, slot->key.bytes,
3432 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003433 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003434exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003435 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003436
Gilles Peskine449bd832023-01-11 14:50:10 +01003437 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003438}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003439
Gilles Peskine449bd832023-01-11 14:50:10 +01003440psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3441 psa_algorithm_t alg,
3442 const uint8_t *input,
3443 size_t input_length,
3444 const uint8_t *salt,
3445 size_t salt_length,
3446 uint8_t *output,
3447 size_t output_size,
3448 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003449{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003450 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003451 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003452 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003453 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003454
Darryl Green5cc689a2018-07-24 15:34:10 +01003455 (void) input;
3456 (void) input_length;
3457 (void) salt;
3458 (void) output;
3459 (void) output_size;
3460
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003461 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003462
Gilles Peskine449bd832023-01-11 14:50:10 +01003463 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3464 return PSA_ERROR_INVALID_ARGUMENT;
3465 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003466
Ronald Cron5c522922020-11-14 16:35:34 +01003467 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003468 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3469 if (status != PSA_SUCCESS) {
3470 return status;
3471 }
3472 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003473 status = PSA_ERROR_INVALID_ARGUMENT;
3474 goto exit;
3475 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003476
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003477 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003478 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003479 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003480
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003481 status = psa_driver_wrapper_asymmetric_decrypt(
3482 &attributes, slot->key.data, slot->key.bytes,
3483 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003484 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003485
3486exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003487 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003488
Gilles Peskine449bd832023-01-11 14:50:10 +01003489 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003490}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003491
Paul Elliott9fe12f62022-11-30 19:16:02 +00003492/****************************************************************/
3493/* Asymmetric interruptible cryptography */
3494/****************************************************************/
3495
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003496static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3497
Paul Elliott9fe12f62022-11-30 19:16:02 +00003498void psa_interruptible_set_max_ops(uint32_t max_ops)
3499{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003500 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003501}
3502
3503uint32_t psa_interruptible_get_max_ops(void)
3504{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003505 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003506}
3507
Paul Elliott9fe12f62022-11-30 19:16:02 +00003508uint32_t psa_sign_hash_get_num_ops(
3509 const psa_sign_hash_interruptible_operation_t *operation)
3510{
Paul Elliott296ede92022-12-15 17:00:30 +00003511 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003512}
3513
3514uint32_t psa_verify_hash_get_num_ops(
3515 const psa_verify_hash_interruptible_operation_t *operation)
3516{
Paul Elliott296ede92022-12-15 17:00:30 +00003517 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003518}
3519
Paul Elliott59ad9452022-12-18 15:09:02 +00003520static psa_status_t psa_sign_hash_abort_internal(
3521 psa_sign_hash_interruptible_operation_t *operation)
3522{
3523 if (operation->id == 0) {
3524 /* The object has (apparently) been initialized but it is not (yet)
3525 * in use. It's ok to call abort on such an object, and there's
3526 * nothing to do. */
3527 return PSA_SUCCESS;
3528 }
3529
3530 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3531
3532 status = psa_driver_wrapper_sign_hash_abort(operation);
3533
3534 operation->id = 0;
3535
Paul Elliotte6145dc2023-02-07 12:51:21 +00003536 /* Do not clear either the error_occurred or num_ops elements here as they
3537 * only want to be cleared by the application calling abort, not by abort
3538 * being called at completion of an operation. */
3539
Paul Elliott59ad9452022-12-18 15:09:02 +00003540 return status;
3541}
3542
Paul Elliott9fe12f62022-11-30 19:16:02 +00003543psa_status_t psa_sign_hash_start(
3544 psa_sign_hash_interruptible_operation_t *operation,
3545 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3546 const uint8_t *hash, size_t hash_length)
3547{
3548 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3549 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3550 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003551 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003552
Paul Elliottc9774412023-02-06 15:14:07 +00003553 /* Check that start has not been previously called, or operation has not
3554 * previously errored. */
3555 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003556 return PSA_ERROR_BAD_STATE;
3557 }
3558
Paul Elliott9fe12f62022-11-30 19:16:02 +00003559 status = psa_sign_verify_check_alg(0, alg);
3560 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003561 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003562 return status;
3563 }
3564
3565 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3566 PSA_KEY_USAGE_SIGN_HASH,
3567 alg);
3568
3569 if (status != PSA_SUCCESS) {
3570 goto exit;
3571 }
3572
3573 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3574 status = PSA_ERROR_INVALID_ARGUMENT;
3575 goto exit;
3576 }
3577
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003578 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003579 .core = slot->attr
3580 };
3581
Paul Elliott296ede92022-12-15 17:00:30 +00003582 /* Ensure ops count gets reset, in case of operation re-use. */
3583 operation->num_ops = 0;
3584
Paul Elliott9fe12f62022-11-30 19:16:02 +00003585 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3586 slot->key.data,
3587 slot->key.bytes, alg,
3588 hash, hash_length);
3589exit:
3590
3591 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003592 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003593 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003594 }
3595
3596 unlock_status = psa_unlock_key_slot(slot);
3597
Paul Elliottc9774412023-02-06 15:14:07 +00003598 if (unlock_status != PSA_SUCCESS) {
3599 operation->error_occurred = 1;
3600 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003601
Paul Elliottc9774412023-02-06 15:14:07 +00003602 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003603}
3604
3605
3606psa_status_t psa_sign_hash_complete(
3607 psa_sign_hash_interruptible_operation_t *operation,
3608 uint8_t *signature, size_t signature_size,
3609 size_t *signature_length)
3610{
3611 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3612
3613 *signature_length = 0;
3614
Paul Elliottc9774412023-02-06 15:14:07 +00003615 /* Check that start has been called first, and that operation has not
3616 * previously errored. */
3617 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003618 status = PSA_ERROR_BAD_STATE;
3619 goto exit;
3620 }
3621
Paul Elliott096abc42023-02-03 18:33:23 +00003622 /* Immediately reject a zero-length signature buffer. This guarantees that
3623 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003624 if (signature_size == 0) {
3625 status = PSA_ERROR_BUFFER_TOO_SMALL;
3626 goto exit;
3627 }
3628
3629 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3630 signature_size,
3631 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003632
Paul Elliott296ede92022-12-15 17:00:30 +00003633 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003634 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003635
Paul Elliottebe225c2023-02-10 14:32:53 +00003636exit:
3637
Paul Elliott59200a22023-02-21 15:07:40 +00003638 psa_wipe_tag_output_buffer(signature, status, signature_size,
3639 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003640
Paul Elliott53bb3122023-02-10 14:22:22 +00003641 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003642 if (status != PSA_SUCCESS) {
3643 operation->error_occurred = 1;
3644 }
3645
Paul Elliott59ad9452022-12-18 15:09:02 +00003646 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003647 }
3648
3649 return status;
3650}
3651
3652psa_status_t psa_sign_hash_abort(
3653 psa_sign_hash_interruptible_operation_t *operation)
3654{
Paul Elliott59ad9452022-12-18 15:09:02 +00003655 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3656
3657 status = psa_sign_hash_abort_internal(operation);
3658
3659 /* We clear the number of ops done here, so that it is not cleared when
3660 * the operation fails or succeeds, only on manual abort. */
3661 operation->num_ops = 0;
3662
Paul Elliottc9774412023-02-06 15:14:07 +00003663 /* Likewise, failure state. */
3664 operation->error_occurred = 0;
3665
Paul Elliott59ad9452022-12-18 15:09:02 +00003666 return status;
3667}
3668
3669static psa_status_t psa_verify_hash_abort_internal(
3670 psa_verify_hash_interruptible_operation_t *operation)
3671{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003672 if (operation->id == 0) {
3673 /* The object has (apparently) been initialized but it is not (yet)
3674 * in use. It's ok to call abort on such an object, and there's
3675 * nothing to do. */
3676 return PSA_SUCCESS;
3677 }
3678
Paul Elliott59ad9452022-12-18 15:09:02 +00003679 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3680
3681 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003682
3683 operation->id = 0;
3684
Paul Elliotte6145dc2023-02-07 12:51:21 +00003685 /* Do not clear either the error_occurred or num_ops elements here as they
3686 * only want to be cleared by the application calling abort, not by abort
3687 * being called at completion of an operation. */
3688
Paul Elliott59ad9452022-12-18 15:09:02 +00003689 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003690}
3691
3692psa_status_t psa_verify_hash_start(
3693 psa_verify_hash_interruptible_operation_t *operation,
3694 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3695 const uint8_t *hash, size_t hash_length,
3696 const uint8_t *signature, size_t signature_length)
3697{
3698 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3699 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3700 psa_key_slot_t *slot;
3701
Paul Elliottc9774412023-02-06 15:14:07 +00003702 /* Check that start has not been previously called, or operation has not
3703 * previously errored. */
3704 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003705 return PSA_ERROR_BAD_STATE;
3706 }
3707
3708 status = psa_sign_verify_check_alg(0, alg);
3709 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003710 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003711 return status;
3712 }
3713
3714 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3715 PSA_KEY_USAGE_VERIFY_HASH,
3716 alg);
3717
3718 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003719 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003720 return status;
3721 }
3722
3723 psa_key_attributes_t attributes = {
3724 .core = slot->attr
3725 };
3726
Paul Elliott296ede92022-12-15 17:00:30 +00003727 /* Ensure ops count gets reset, in case of operation re-use. */
3728 operation->num_ops = 0;
3729
Paul Elliott9fe12f62022-11-30 19:16:02 +00003730 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3731 slot->key.data,
3732 slot->key.bytes,
3733 alg, hash, hash_length,
3734 signature, signature_length);
3735
3736 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003737 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003738 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003739 }
3740
3741 unlock_status = psa_unlock_key_slot(slot);
3742
Paul Elliottc9774412023-02-06 15:14:07 +00003743 if (unlock_status != PSA_SUCCESS) {
3744 operation->error_occurred = 1;
3745 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003746
Paul Elliottc9774412023-02-06 15:14:07 +00003747 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003748}
3749
3750psa_status_t psa_verify_hash_complete(
3751 psa_verify_hash_interruptible_operation_t *operation)
3752{
3753 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3754
Paul Elliottc9774412023-02-06 15:14:07 +00003755 /* Check that start has been called first, and that operation has not
3756 * previously errored. */
3757 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003758 status = PSA_ERROR_BAD_STATE;
3759 goto exit;
3760 }
3761
3762 status = psa_driver_wrapper_verify_hash_complete(operation);
3763
Paul Elliott296ede92022-12-15 17:00:30 +00003764 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003765 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003766 operation);
3767
Paul Elliottebe225c2023-02-10 14:32:53 +00003768exit:
3769
Paul Elliott9fe12f62022-11-30 19:16:02 +00003770 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003771 if (status != PSA_SUCCESS) {
3772 operation->error_occurred = 1;
3773 }
3774
Paul Elliott59ad9452022-12-18 15:09:02 +00003775 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003776 }
3777
3778 return status;
3779}
3780
3781psa_status_t psa_verify_hash_abort(
3782 psa_verify_hash_interruptible_operation_t *operation)
3783{
Paul Elliott59ad9452022-12-18 15:09:02 +00003784 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003785
Paul Elliott59ad9452022-12-18 15:09:02 +00003786 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003787
Paul Elliott59ad9452022-12-18 15:09:02 +00003788 /* We clear the number of ops done here, so that it is not cleared when
3789 * the operation fails or succeeds, only on manual abort. */
3790 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003791
Paul Elliottc9774412023-02-06 15:14:07 +00003792 /* Likewise, failure state. */
3793 operation->error_occurred = 0;
3794
Paul Elliott59ad9452022-12-18 15:09:02 +00003795 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003796}
3797
Paul Elliott588f8ed2022-12-02 18:10:26 +00003798/****************************************************************/
3799/* Asymmetric interruptible cryptography internal */
3800/* implementations */
3801/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003802
Paul Elliott588f8ed2022-12-02 18:10:26 +00003803void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3804{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003805
Paul Elliott588f8ed2022-12-02 18:10:26 +00003806#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3807 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3808 defined(MBEDTLS_ECP_RESTARTABLE)
3809
3810 /* Internal implementation uses zero to indicate infinite number max ops,
3811 * therefore avoid this value, and set to minimum possible. */
3812 if (max_ops == 0) {
3813 max_ops = 1;
3814 }
3815
Paul Elliott588f8ed2022-12-02 18:10:26 +00003816 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003817#else
3818 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003819#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3820 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3821 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3822}
3823
Paul Elliott588f8ed2022-12-02 18:10:26 +00003824uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003825 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003826{
3827#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3828 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3829 defined(MBEDTLS_ECP_RESTARTABLE)
3830
Paul Elliott93d9ca82023-02-15 18:14:21 +00003831 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003832#else
3833 (void) operation;
3834 return 0;
3835#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3836 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3837 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3838}
3839
3840uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003841 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003842{
3843 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3844 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3845 defined(MBEDTLS_ECP_RESTARTABLE)
3846
Paul Elliott93d9ca82023-02-15 18:14:21 +00003847 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003848#else
3849 (void) operation;
3850 return 0;
3851#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3852 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3853 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3854}
3855
3856psa_status_t mbedtls_psa_sign_hash_start(
3857 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3858 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3859 size_t key_buffer_size, psa_algorithm_t alg,
3860 const uint8_t *hash, size_t hash_length)
3861{
3862 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003863 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003864
Paul Elliott068fe072023-01-16 13:59:15 +00003865 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3866 return PSA_ERROR_NOT_SUPPORTED;
3867 }
3868
3869 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003870 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003871 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003872
3873#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003874 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3875 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003876
Paul Elliotta1c94092023-02-15 16:38:04 +00003877 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3878
Paul Elliott93d9ca82023-02-15 18:14:21 +00003879 /* Ensure num_ops is zero'ed in case of context re-use. */
3880 operation->num_ops = 0;
3881
Paul Elliott068fe072023-01-16 13:59:15 +00003882 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3883 attributes->core.bits,
3884 key_buffer,
3885 key_buffer_size,
3886 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003887
Paul Elliott068fe072023-01-16 13:59:15 +00003888 if (status != PSA_SUCCESS) {
3889 return status;
3890 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003891
Paul Elliott1bc59df2023-02-05 13:41:57 +00003892 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003893 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003894
Paul Elliott068fe072023-01-16 13:59:15 +00003895 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003896 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003897 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003898
Paul Elliott0290a762023-02-09 14:30:24 +00003899 /* We only need to store the same length of hash as the private key size
3900 * here, it would be truncated by the internal implementation anyway. */
3901 required_hash_length = (hash_length < operation->coordinate_bytes ?
3902 hash_length : operation->coordinate_bytes);
3903
Paul Elliottba70ad42023-02-15 18:23:53 +00003904 if (required_hash_length > sizeof(operation->hash)) {
3905 /* Shouldn't happen, but better safe than sorry. */
3906 return PSA_ERROR_CORRUPTION_DETECTED;
3907 }
3908
Paul Elliott0290a762023-02-09 14:30:24 +00003909 memcpy(operation->hash, hash, required_hash_length);
3910 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003911
3912 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003913
3914#else
Paul Elliott068fe072023-01-16 13:59:15 +00003915 (void) operation;
3916 (void) key_buffer;
3917 (void) key_buffer_size;
3918 (void) alg;
3919 (void) hash;
3920 (void) hash_length;
3921 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003922 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003923
Paul Elliott068fe072023-01-16 13:59:15 +00003924 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003925#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3926 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3927 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003928}
3929
3930psa_status_t mbedtls_psa_sign_hash_complete(
3931 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3932 uint8_t *signature, size_t signature_size,
3933 size_t *signature_length)
3934{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003935#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3936 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3937 defined(MBEDTLS_ECP_RESTARTABLE)
3938
Paul Elliotta1c94092023-02-15 16:38:04 +00003939 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003940 mbedtls_mpi r;
3941 mbedtls_mpi s;
3942
Paul Elliott46845252023-02-03 14:59:11 +00003943 mbedtls_mpi_init(&r);
3944 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003945
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003946 /* Ensure max_ops is set to the current value (or default). */
3947 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3948
Paul Elliotta1c94092023-02-15 16:38:04 +00003949 if (signature_size < 2 * operation->coordinate_bytes) {
3950 status = PSA_ERROR_BUFFER_TOO_SMALL;
3951 goto exit;
3952 }
3953
Paul Elliott588f8ed2022-12-02 18:10:26 +00003954 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003955
Paul Elliott588f8ed2022-12-02 18:10:26 +00003956#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3957 status = mbedtls_to_psa_error(
3958 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003959 &r,
3960 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003961 &operation->ctx->d,
3962 operation->hash,
3963 operation->hash_length,
3964 operation->md_alg,
3965 mbedtls_psa_get_random,
3966 MBEDTLS_PSA_RANDOM_STATE,
3967 &operation->restart_ctx));
3968#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003969 status = PSA_ERROR_NOT_SUPPORTED;
3970 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003971#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3972 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003973 status = mbedtls_to_psa_error(
3974 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003975 &r,
3976 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003977 &operation->ctx->d,
3978 operation->hash,
3979 operation->hash_length,
3980 mbedtls_psa_get_random,
3981 MBEDTLS_PSA_RANDOM_STATE,
3982 mbedtls_psa_get_random,
3983 MBEDTLS_PSA_RANDOM_STATE,
3984 &operation->restart_ctx));
3985 }
3986
Paul Elliottf8e5b562023-02-19 18:43:45 +00003987 /* Hide the fact that the restart context only holds a delta of number of
3988 * ops done during the last operation, not an absolute value. */
3989 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3990
Paul Elliott724bd252023-02-08 12:35:08 +00003991 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003992 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003993 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003994 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003995 operation->coordinate_bytes)
3996 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003997
3998 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003999 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004000 }
4001
4002 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004003 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004004 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004005 operation->coordinate_bytes,
4006 operation->coordinate_bytes)
4007 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004008
4009 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004010 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004011 }
4012
Paul Elliott1bc59df2023-02-05 13:41:57 +00004013 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004014
Paul Elliott724bd252023-02-08 12:35:08 +00004015 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004016 }
Paul Elliott724bd252023-02-08 12:35:08 +00004017
4018exit:
4019
4020 mbedtls_mpi_free(&r);
4021 mbedtls_mpi_free(&s);
4022 return status;
4023
Paul Elliott588f8ed2022-12-02 18:10:26 +00004024 #else
4025
4026 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004027 (void) signature;
4028 (void) signature_size;
4029 (void) signature_length;
4030
4031 return PSA_ERROR_NOT_SUPPORTED;
4032
4033#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4034 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4035 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4036}
4037
4038psa_status_t mbedtls_psa_sign_hash_abort(
4039 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4040{
4041
4042#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4043 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4044 defined(MBEDTLS_ECP_RESTARTABLE)
4045
4046 if (operation->ctx) {
4047 mbedtls_ecdsa_free(operation->ctx);
4048 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004049 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004050 }
4051
4052 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4053
Paul Elliott93d9ca82023-02-15 18:14:21 +00004054 operation->num_ops = 0;
4055
Paul Elliott588f8ed2022-12-02 18:10:26 +00004056 return PSA_SUCCESS;
4057
4058#else
4059
4060 (void) operation;
4061
4062 return PSA_ERROR_NOT_SUPPORTED;
4063
4064#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4065 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4066 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4067}
4068
4069psa_status_t mbedtls_psa_verify_hash_start(
4070 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4071 const psa_key_attributes_t *attributes,
4072 const uint8_t *key_buffer, size_t key_buffer_size,
4073 psa_algorithm_t alg,
4074 const uint8_t *hash, size_t hash_length,
4075 const uint8_t *signature, size_t signature_length)
4076{
4077 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004078 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004079 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004080
Paul Elliott068fe072023-01-16 13:59:15 +00004081 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4082 return PSA_ERROR_NOT_SUPPORTED;
4083 }
4084
4085 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004086 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004087 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004088
4089#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004090 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4091 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004092
Paul Elliotta1c94092023-02-15 16:38:04 +00004093 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4094 mbedtls_mpi_init(&operation->r);
4095 mbedtls_mpi_init(&operation->s);
4096
Paul Elliott93d9ca82023-02-15 18:14:21 +00004097 /* Ensure num_ops is zero'ed in case of context re-use. */
4098 operation->num_ops = 0;
4099
Paul Elliott068fe072023-01-16 13:59:15 +00004100 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4101 attributes->core.bits,
4102 key_buffer,
4103 key_buffer_size,
4104 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004105
Paul Elliott068fe072023-01-16 13:59:15 +00004106 if (status != PSA_SUCCESS) {
4107 return status;
4108 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004109
Paul Elliottc569fc22023-02-10 13:02:54 +00004110 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004111
Paul Elliott1bc59df2023-02-05 13:41:57 +00004112 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004113 return PSA_ERROR_INVALID_SIGNATURE;
4114 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004115
Paul Elliott068fe072023-01-16 13:59:15 +00004116 status = mbedtls_to_psa_error(
4117 mbedtls_mpi_read_binary(&operation->r,
4118 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004119 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004120
Paul Elliott068fe072023-01-16 13:59:15 +00004121 if (status != PSA_SUCCESS) {
4122 return status;
4123 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004124
Paul Elliott068fe072023-01-16 13:59:15 +00004125 status = mbedtls_to_psa_error(
4126 mbedtls_mpi_read_binary(&operation->s,
4127 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004128 coordinate_bytes,
4129 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004130
Paul Elliott068fe072023-01-16 13:59:15 +00004131 if (status != PSA_SUCCESS) {
4132 return status;
4133 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004134
Paul Elliott2c9843f2023-02-15 17:32:42 +00004135 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004136
Paul Elliott2c9843f2023-02-15 17:32:42 +00004137 if (status != PSA_SUCCESS) {
4138 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004139 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004140
Paul Elliott0290a762023-02-09 14:30:24 +00004141 /* We only need to store the same length of hash as the private key size
4142 * here, it would be truncated by the internal implementation anyway. */
4143 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4144 coordinate_bytes);
4145
Paul Elliottba70ad42023-02-15 18:23:53 +00004146 if (required_hash_length > sizeof(operation->hash)) {
4147 /* Shouldn't happen, but better safe than sorry. */
4148 return PSA_ERROR_CORRUPTION_DETECTED;
4149 }
4150
Paul Elliott0290a762023-02-09 14:30:24 +00004151 memcpy(operation->hash, hash, required_hash_length);
4152 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004153
4154 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004155#else
Paul Elliott068fe072023-01-16 13:59:15 +00004156 (void) operation;
4157 (void) key_buffer;
4158 (void) key_buffer_size;
4159 (void) alg;
4160 (void) hash;
4161 (void) hash_length;
4162 (void) signature;
4163 (void) signature_length;
4164 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004165 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004166 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004167
Paul Elliott068fe072023-01-16 13:59:15 +00004168 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004169#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4170 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4171 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004172}
4173
4174psa_status_t mbedtls_psa_verify_hash_complete(
4175 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4176{
4177
4178#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4179 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4180 defined(MBEDTLS_ECP_RESTARTABLE)
4181
Paul Elliottf8e5b562023-02-19 18:43:45 +00004182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4183
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004184 /* Ensure max_ops is set to the current value (or default). */
4185 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4186
Paul Elliottf8e5b562023-02-19 18:43:45 +00004187 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004188 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4189 operation->hash,
4190 operation->hash_length,
4191 &operation->ctx->Q,
4192 &operation->r,
4193 &operation->s,
4194 &operation->restart_ctx));
4195
Paul Elliottf8e5b562023-02-19 18:43:45 +00004196 /* Hide the fact that the restart context only holds a delta of number of
4197 * ops done during the last operation, not an absolute value. */
4198 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4199
4200 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004201#else
4202 (void) operation;
4203
4204 return PSA_ERROR_NOT_SUPPORTED;
4205
4206#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4207 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4208 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4209}
4210
4211psa_status_t mbedtls_psa_verify_hash_abort(
4212 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4213{
4214
4215#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4216 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4217 defined(MBEDTLS_ECP_RESTARTABLE)
4218
4219 if (operation->ctx) {
4220 mbedtls_ecdsa_free(operation->ctx);
4221 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004222 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004223 }
4224
4225 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4226
Paul Elliott93d9ca82023-02-15 18:14:21 +00004227 operation->num_ops = 0;
4228
Paul Elliott588f8ed2022-12-02 18:10:26 +00004229 mbedtls_mpi_free(&operation->r);
4230 mbedtls_mpi_free(&operation->s);
4231
4232 return PSA_SUCCESS;
4233
4234#else
4235 (void) operation;
4236
4237 return PSA_ERROR_NOT_SUPPORTED;
4238
4239#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4240 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4241 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4242}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004243
mohammad1603503973b2018-03-12 15:59:30 +02004244/****************************************************************/
4245/* Symmetric cryptography */
4246/****************************************************************/
4247
Gilles Peskine449bd832023-01-11 14:50:10 +01004248static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4249 mbedtls_svc_key_id_t key,
4250 psa_algorithm_t alg,
4251 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004252{
4253 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4254 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004255 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4257 PSA_KEY_USAGE_ENCRYPT :
4258 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004259 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004260
4261 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004263 status = PSA_ERROR_BAD_STATE;
4264 goto exit;
4265 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004266
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004268 status = PSA_ERROR_INVALID_ARGUMENT;
4269 goto exit;
4270 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004271
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4273 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004274 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004276
Ronald Cron49fafa92021-03-10 08:34:23 +01004277 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004278 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004279 * so we only set it (in the driver wrapper) after resources have been
4280 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004281 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004283 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004285 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 }
4287 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004288
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004289 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004291 };
4292
Ronald Cronab99ac22020-10-01 16:38:28 +02004293 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 if (cipher_operation == MBEDTLS_ENCRYPT) {
4295 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4296 &attributes,
4297 slot->key.data,
4298 slot->key.bytes,
4299 alg);
4300 } else {
4301 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4302 &attributes,
4303 slot->key.data,
4304 slot->key.bytes,
4305 alg);
4306 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004307
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004308exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004309 if (status != PSA_SUCCESS) {
4310 psa_cipher_abort(operation);
4311 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004312
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004314
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004316}
4317
Gilles Peskine449bd832023-01-11 14:50:10 +01004318psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4319 mbedtls_svc_key_id_t key,
4320 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004321{
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004323}
4324
Gilles Peskine449bd832023-01-11 14:50:10 +01004325psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4326 mbedtls_svc_key_id_t key,
4327 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004328{
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004330}
4331
Gilles Peskine449bd832023-01-11 14:50:10 +01004332psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4333 uint8_t *iv,
4334 size_t iv_size,
4335 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004336{
Ronald Cron6d051732020-10-01 14:10:20 +02004337 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004338 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004339 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004342 status = PSA_ERROR_BAD_STATE;
4343 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004344 }
4345
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004347 status = PSA_ERROR_BAD_STATE;
4348 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004349 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004350
Ronald Cron2fb90522021-07-05 12:31:44 +02004351 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004352 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004353 status = PSA_ERROR_BUFFER_TOO_SMALL;
4354 goto exit;
4355 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004356
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004358 status = PSA_ERROR_GENERIC_ERROR;
4359 goto exit;
4360 }
4361
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 status = psa_generate_random(local_iv, default_iv_length);
4363 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004364 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 }
Ronald Cron5618a392021-03-26 09:52:26 +01004366
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 status = psa_driver_wrapper_cipher_set_iv(operation,
4368 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004369
4370exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 if (status == PSA_SUCCESS) {
4372 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004373 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004374 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004376 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004378 }
Ronald Cron6d051732020-10-01 14:10:20 +02004379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004381}
4382
Gilles Peskine449bd832023-01-11 14:50:10 +01004383psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4384 const uint8_t *iv,
4385 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004386{
Ronald Cron6d051732020-10-01 14:10:20 +02004387 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004390 status = PSA_ERROR_BAD_STATE;
4391 goto exit;
4392 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004393
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004395 status = PSA_ERROR_BAD_STATE;
4396 goto exit;
4397 }
Ronald Crona0d68172021-03-26 10:15:08 +01004398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004400 status = PSA_ERROR_INVALID_ARGUMENT;
4401 goto exit;
4402 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004403
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 status = psa_driver_wrapper_cipher_set_iv(operation,
4405 iv,
4406 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004407
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004408exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004410 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 } else {
4412 psa_cipher_abort(operation);
4413 }
4414 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004415}
4416
Gilles Peskine449bd832023-01-11 14:50:10 +01004417psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4418 const uint8_t *input,
4419 size_t input_length,
4420 uint8_t *output,
4421 size_t output_size,
4422 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004423{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004425
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004427 status = PSA_ERROR_BAD_STATE;
4428 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004429 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004430
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004432 status = PSA_ERROR_BAD_STATE;
4433 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004434 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004435
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 status = psa_driver_wrapper_cipher_update(operation,
4437 input,
4438 input_length,
4439 output,
4440 output_size,
4441 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004442
4443exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 if (status != PSA_SUCCESS) {
4445 psa_cipher_abort(operation);
4446 }
Ronald Cron6d051732020-10-01 14:10:20 +02004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004449}
4450
Gilles Peskine449bd832023-01-11 14:50:10 +01004451psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4452 uint8_t *output,
4453 size_t output_size,
4454 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004455{
David Saadab4ecc272019-02-14 13:48:10 +02004456 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004457
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004459 status = PSA_ERROR_BAD_STATE;
4460 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004461 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004462
Gilles Peskine449bd832023-01-11 14:50:10 +01004463 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004464 status = PSA_ERROR_BAD_STATE;
4465 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004466 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004467
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 status = psa_driver_wrapper_cipher_finish(operation,
4469 output,
4470 output_size,
4471 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004472
4473exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 if (status == PSA_SUCCESS) {
4475 return psa_cipher_abort(operation);
4476 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004477 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004479
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004481 }
mohammad1603503973b2018-03-12 15:59:30 +02004482}
4483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004485{
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004487 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004488 * in use. It's ok to call abort on such an object, and there's
4489 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004491 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004492
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004494
Ronald Cron49fafa92021-03-10 08:34:23 +01004495 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004496 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004497 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004498
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004500}
4501
Gilles Peskine449bd832023-01-11 14:50:10 +01004502psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4503 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004504 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004506 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 size_t output_size,
4508 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004509{
4510 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004511 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004512 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004513 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4514 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004515 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004516
David Horstmann62a56d92023-12-14 18:12:47 +00004517 LOCAL_INPUT_DECLARE(input_external, input);
4518 LOCAL_OUTPUT_DECLARE(output_external, output);
4519
David Horstmann36df4b22023-12-13 15:55:25 +00004520 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004521 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004522
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004524 status = PSA_ERROR_INVALID_ARGUMENT;
4525 goto exit;
4526 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004527
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4529 PSA_KEY_USAGE_ENCRYPT,
4530 alg);
4531 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004532 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004534
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004535 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004537 };
4538
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4540 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004541 status = PSA_ERROR_GENERIC_ERROR;
4542 goto exit;
4543 }
4544
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 if (default_iv_length > 0) {
4546 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004547 status = PSA_ERROR_BUFFER_TOO_SMALL;
4548 goto exit;
4549 }
4550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 status = psa_generate_random(local_iv, default_iv_length);
4552 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004553 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004555 }
4556
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004557 status = psa_driver_wrapper_cipher_encrypt(
4558 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004559 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004560 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004562
4563exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 unlock_status = psa_unlock_key_slot(slot);
4565 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004566 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004567 }
Ronald Cron23919522021-07-08 19:00:07 +02004568
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 if (status == PSA_SUCCESS) {
4570 if (default_iv_length > 0) {
4571 memcpy(output, local_iv, default_iv_length);
4572 }
4573 *output_length += default_iv_length;
4574 } else {
4575 *output_length = 0;
4576 }
4577
David Horstmann62a56d92023-12-14 18:12:47 +00004578 LOCAL_INPUT_FREE(input_external, input);
4579 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004580
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004582}
4583
Gilles Peskine449bd832023-01-11 14:50:10 +01004584psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4585 psa_algorithm_t alg,
4586 const uint8_t *input,
4587 size_t input_length,
4588 uint8_t *output,
4589 size_t output_size,
4590 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004591{
4592 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004593 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004594 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004595 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004596
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004598 status = PSA_ERROR_INVALID_ARGUMENT;
4599 goto exit;
4600 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004601
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4603 PSA_KEY_USAGE_DECRYPT,
4604 alg);
4605 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004606 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004608
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004609 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004611 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004612
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4614 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004615 status = PSA_ERROR_INVALID_ARGUMENT;
4616 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004618 status = PSA_ERROR_INVALID_ARGUMENT;
4619 goto exit;
4620 }
4621
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004622 status = psa_driver_wrapper_cipher_decrypt(
4623 &attributes, slot->key.data, slot->key.bytes,
4624 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004626
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004627exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 unlock_status = psa_unlock_key_slot(slot);
4629 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004630 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004632
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004634 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 }
Ronald Cron23919522021-07-08 19:00:07 +02004636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004638}
4639
4640
mohammad16035955c982018-04-26 00:53:03 +03004641/****************************************************************/
4642/* AEAD */
4643/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004644
Paul Elliottbaff51c2021-09-28 17:44:45 +01004645/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004646static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004647{
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004649}
4650
4651/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004652static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4653 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004654{
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004656
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004658#if defined(PSA_WANT_ALG_GCM)
4659 case PSA_ALG_GCM:
4660 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 * arbitrarily large nonces. Please note that we do not generally
4662 * recommend the usage of nonces of greater length than
4663 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4664 * size, which can then lead to collisions if you encrypt a very
4665 * large number of messages.*/
4666 if (nonce_length != 0) {
4667 return PSA_SUCCESS;
4668 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004669 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004670#endif /* PSA_WANT_ALG_GCM */
4671#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004672 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 if (nonce_length >= 7 && nonce_length <= 13) {
4674 return PSA_SUCCESS;
4675 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004676 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004677#endif /* PSA_WANT_ALG_CCM */
4678#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004679 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 if (nonce_length == 12) {
4681 return PSA_SUCCESS;
4682 } else if (nonce_length == 8) {
4683 return PSA_ERROR_NOT_SUPPORTED;
4684 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004685 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004686#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004687 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004688 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004690 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004691
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004693}
4694
Gilles Peskine449bd832023-01-11 14:50:10 +01004695static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004696{
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4698 return PSA_ERROR_INVALID_ARGUMENT;
4699 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004700
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004702}
4703
Gilles Peskine449bd832023-01-11 14:50:10 +01004704psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4705 psa_algorithm_t alg,
4706 const uint8_t *nonce,
4707 size_t nonce_length,
4708 const uint8_t *additional_data,
4709 size_t additional_data_length,
4710 const uint8_t *plaintext,
4711 size_t plaintext_length,
4712 uint8_t *ciphertext,
4713 size_t ciphertext_size,
4714 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004715{
Ronald Cron215633c2021-03-16 17:15:37 +01004716 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4717 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004718
mohammad1603f08a5502018-06-03 15:05:47 +03004719 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004720
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 status = psa_aead_check_algorithm(alg);
4722 if (status != PSA_SUCCESS) {
4723 return status;
4724 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004725
Ronald Cron9a986162021-03-26 12:40:07 +01004726 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4728 if (status != PSA_SUCCESS) {
4729 return status;
4730 }
mohammad16035955c982018-04-26 00:53:03 +03004731
Ronald Cron215633c2021-03-16 17:15:37 +01004732 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004734 };
mohammad16035955c982018-04-26 00:53:03 +03004735
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 status = psa_aead_check_nonce_length(alg, nonce_length);
4737 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004738 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004740
Ronald Cronde822812021-03-17 16:08:20 +01004741 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004742 &attributes, slot->key.data, slot->key.bytes,
4743 alg,
4744 nonce, nonce_length,
4745 additional_data, additional_data_length,
4746 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004748
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4750 memset(ciphertext, 0, ciphertext_size);
4751 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004752
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004753exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004755
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004757}
4758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4760 psa_algorithm_t alg,
4761 const uint8_t *nonce,
4762 size_t nonce_length,
4763 const uint8_t *additional_data,
4764 size_t additional_data_length,
4765 const uint8_t *ciphertext,
4766 size_t ciphertext_length,
4767 uint8_t *plaintext,
4768 size_t plaintext_size,
4769 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004770{
Ronald Cron215633c2021-03-16 17:15:37 +01004771 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4772 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004773
Gilles Peskineee652a32018-06-01 19:23:52 +02004774 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004775
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 status = psa_aead_check_algorithm(alg);
4777 if (status != PSA_SUCCESS) {
4778 return status;
4779 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004780
Ronald Cron9a986162021-03-26 12:40:07 +01004781 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4783 if (status != PSA_SUCCESS) {
4784 return status;
4785 }
mohammad16035955c982018-04-26 00:53:03 +03004786
Ronald Cron215633c2021-03-16 17:15:37 +01004787 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004789 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004790
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 status = psa_aead_check_nonce_length(alg, nonce_length);
4792 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004793 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004795
Ronald Cronde822812021-03-17 16:08:20 +01004796 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004797 &attributes, slot->key.data, slot->key.bytes,
4798 alg,
4799 nonce, nonce_length,
4800 additional_data, additional_data_length,
4801 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004803
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (status != PSA_SUCCESS && plaintext_size != 0) {
4805 memset(plaintext, 0, plaintext_size);
4806 }
mohammad160360a64d02018-06-03 17:20:42 +03004807
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004808exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004810
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 return status;
mohammad16035955c982018-04-26 00:53:03 +03004812}
4813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4815{
4816 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004817
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004819#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004821 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4823 return PSA_ERROR_INVALID_ARGUMENT;
4824 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004825 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004826#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004827
Przemek Stekiel86679c72022-10-06 17:06:56 +02004828#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004830 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4832 return PSA_ERROR_INVALID_ARGUMENT;
4833 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004834 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004835#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004836
Przemek Stekiel86679c72022-10-06 17:06:56 +02004837#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004839 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 if (tag_len != 16) {
4841 return PSA_ERROR_INVALID_ARGUMENT;
4842 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004843 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004844#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004845
4846 default:
4847 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004849 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004851}
4852
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004853/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004854static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4855 int is_encrypt,
4856 mbedtls_svc_key_id_t key,
4857 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004858{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004859 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4860 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4861 psa_key_slot_t *slot = NULL;
4862 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004863 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004864
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 status = psa_aead_check_algorithm(alg);
4866 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004867 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004869
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004871 status = PSA_ERROR_BAD_STATE;
4872 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004873 }
4874
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 if (operation->nonce_set || operation->lengths_set ||
4876 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004877 status = PSA_ERROR_BAD_STATE;
4878 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004879 }
4880
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004882 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004884 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004886
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4888 alg);
4889 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004890 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004892
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004893 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004894 .core = slot->attr
4895 };
4896
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004898 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004900
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 if (is_encrypt) {
4902 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4903 &attributes,
4904 slot->key.data,
4905 slot->key.bytes,
4906 alg);
4907 } else {
4908 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4909 &attributes,
4910 slot->key.data,
4911 slot->key.bytes,
4912 alg);
4913 }
4914 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004915 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004917
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004919
4920exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004922
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004924 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004926 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 } else {
4928 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004929 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004930
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004932}
4933
Paul Elliott302ff6b2021-04-20 18:10:30 +01004934/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004935psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4936 mbedtls_svc_key_id_t key,
4937 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004938{
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004940}
4941
4942/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004943psa_status_t psa_aead_decrypt_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, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004948}
4949
4950/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004951psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4952 uint8_t *nonce,
4953 size_t nonce_size,
4954 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004955{
4956 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004957 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004958 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004959
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004960 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004961
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004963 status = PSA_ERROR_BAD_STATE;
4964 goto exit;
4965 }
4966
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004968 status = PSA_ERROR_BAD_STATE;
4969 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004970 }
4971
Paul Elliotte193ea82021-10-01 13:00:16 +01004972 /* For CCM, this size may not be correct according to the PSA
4973 * specification. The PSA Crypto 1.0.1 specification states:
4974 *
4975 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4976 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4977 *
4978 * However this restriction that L has to be the smallest integer is not
4979 * applied in practice, and it is not implementable here since the
4980 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4982 operation->alg);
4983 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004984 status = PSA_ERROR_BUFFER_TOO_SMALL;
4985 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004986 }
4987
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 status = psa_generate_random(local_nonce, required_nonce_size);
4989 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004990 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004992
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004994
Paul Elliott39dc6b82021-05-11 19:16:09 +01004995exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004996 if (status == PSA_SUCCESS) {
4997 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004998 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 } else {
5000 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005001 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005002
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005004}
5005
5006/* Set the nonce for a multipart authenticated encryption or decryption
5007 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005008psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
5009 const uint8_t *nonce,
5010 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005011{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005012 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5013
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005015 status = PSA_ERROR_BAD_STATE;
5016 goto exit;
5017 }
5018
Gilles Peskine449bd832023-01-11 14:50:10 +01005019 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005020 status = PSA_ERROR_BAD_STATE;
5021 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005022 }
5023
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5025 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01005026 status = PSA_ERROR_INVALID_ARGUMENT;
5027 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01005028 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01005029
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5031 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005032
Paul Elliott39dc6b82021-05-11 19:16:09 +01005033exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005035 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 } else {
5037 psa_aead_abort(operation);
5038 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005039
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005041}
5042
5043/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005044psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5045 size_t ad_length,
5046 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005047{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005048 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5049
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005051 status = PSA_ERROR_BAD_STATE;
5052 goto exit;
5053 }
5054
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 if (operation->lengths_set || operation->ad_started ||
5056 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005057 status = PSA_ERROR_BAD_STATE;
5058 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005059 }
5060
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005062#if defined(PSA_WANT_ALG_GCM)
5063 case PSA_ALG_GCM:
5064 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 * bits. Without the guard this code will generate warnings on 32bit
5066 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005067#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 if (((uint64_t) ad_length) >> 61 != 0 ||
5069 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005070 status = PSA_ERROR_INVALID_ARGUMENT;
5071 goto exit;
5072 }
Paul Elliott325d3742021-09-27 17:56:28 +01005073#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005074 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005075#endif /* PSA_WANT_ALG_GCM */
5076#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005077 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005079 status = PSA_ERROR_INVALID_ARGUMENT;
5080 goto exit;
5081 }
5082 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005083#endif /* PSA_WANT_ALG_CCM */
5084#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005085 case PSA_ALG_CHACHA20_POLY1305:
5086 /* No length restrictions for ChaChaPoly. */
5087 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005088#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005089 default:
5090 break;
5091 }
Paul Elliott325d3742021-09-27 17:56:28 +01005092
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5094 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005095
Paul Elliott39dc6b82021-05-11 19:16:09 +01005096exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005098 operation->ad_remaining = ad_length;
5099 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005100 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 } else {
5102 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005103 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005104
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005106}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005107
5108/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005109psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5110 const uint8_t *input,
5111 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005112{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005113 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5114
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005116 status = PSA_ERROR_BAD_STATE;
5117 goto exit;
5118 }
5119
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005121 status = PSA_ERROR_BAD_STATE;
5122 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005123 }
5124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 if (operation->lengths_set) {
5126 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005127 status = PSA_ERROR_INVALID_ARGUMENT;
5128 goto exit;
5129 }
5130
5131 operation->ad_remaining -= input_length;
5132 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005133#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005135 status = PSA_ERROR_BAD_STATE;
5136 goto exit;
5137 }
5138#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005139
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 status = psa_driver_wrapper_aead_update_ad(operation, input,
5141 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005142
Paul Elliott39dc6b82021-05-11 19:16:09 +01005143exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005145 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 } else {
5147 psa_aead_abort(operation);
5148 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005149
Gilles Peskine449bd832023-01-11 14:50:10 +01005150 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005151}
5152
5153/* Encrypt or decrypt a message fragment in an active multipart AEAD
5154 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005155psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5156 const uint8_t *input,
5157 size_t input_length,
5158 uint8_t *output,
5159 size_t output_size,
5160 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005161{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005162 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005163
5164 *output_length = 0;
5165
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005167 status = PSA_ERROR_BAD_STATE;
5168 goto exit;
5169 }
5170
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005172 status = PSA_ERROR_BAD_STATE;
5173 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005174 }
5175
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005177 /* Additional data length was supplied, but not all the additional
5178 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005180 status = PSA_ERROR_INVALID_ARGUMENT;
5181 goto exit;
5182 }
5183
5184 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005186 status = PSA_ERROR_INVALID_ARGUMENT;
5187 goto exit;
5188 }
5189
5190 operation->body_remaining -= input_length;
5191 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005192#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005194 status = PSA_ERROR_BAD_STATE;
5195 goto exit;
5196 }
5197#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005198
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5200 output, output_size,
5201 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005202
Paul Elliott39dc6b82021-05-11 19:16:09 +01005203exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005205 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 } else {
5207 psa_aead_abort(operation);
5208 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005209
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005211}
5212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005214{
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 if (operation->id == 0 || !operation->nonce_set) {
5216 return PSA_ERROR_BAD_STATE;
5217 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005218
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5220 operation->body_remaining != 0)) {
5221 return PSA_ERROR_INVALID_ARGUMENT;
5222 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005223
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005225}
5226
Paul Elliott302ff6b2021-04-20 18:10:30 +01005227/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005228psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5229 uint8_t *ciphertext,
5230 size_t ciphertext_size,
5231 size_t *ciphertext_length,
5232 uint8_t *tag,
5233 size_t tag_size,
5234 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005235{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005236 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5237
Paul Elliott302ff6b2021-04-20 18:10:30 +01005238 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005239 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005240
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 status = psa_aead_final_checks(operation);
5242 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005243 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005245
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005247 status = PSA_ERROR_BAD_STATE;
5248 goto exit;
5249 }
5250
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5252 ciphertext_size,
5253 ciphertext_length,
5254 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005255
Paul Elliott39dc6b82021-05-11 19:16:09 +01005256exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005257
5258
Paul Elliottf47b0952021-05-21 18:02:33 +01005259 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005260 * the zero tag size, make sure the tag is set to something implausible.
5261 * Even if the operation succeeds, make sure we clear the rest of the
5262 * buffer to prevent potential leakage of anything previously placed in
5263 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005264 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005265
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005267
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005269}
5270
5271/* Finish authenticating and decrypting a message in a multipart AEAD
5272 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005273psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5274 uint8_t *plaintext,
5275 size_t plaintext_size,
5276 size_t *plaintext_length,
5277 const uint8_t *tag,
5278 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005279{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005280 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5281
Paul Elliott302ff6b2021-04-20 18:10:30 +01005282 *plaintext_length = 0;
5283
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 status = psa_aead_final_checks(operation);
5285 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005286 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005288
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005290 status = PSA_ERROR_BAD_STATE;
5291 goto exit;
5292 }
5293
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5295 plaintext_size,
5296 plaintext_length,
5297 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005298
5299exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005301
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005303}
5304
5305/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005306psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005307{
5308 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5309
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005311 /* The object has (apparently) been initialized but it is not (yet)
5312 * in use. It's ok to call abort on such an object, and there's
5313 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005315 }
5316
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005318
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005320
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005322}
5323
Gilles Peskinee59236f2018-01-27 23:32:46 +01005324/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005325/* Generators */
5326/****************************************************************/
5327
Przemek Stekiel69c46792022-06-10 12:59:51 +02005328#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005329 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005330 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305331 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305332 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005333#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005334#endif /* At least one builtin KDF */
5335
Przemek Stekiel69c46792022-06-10 12:59:51 +02005336#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005337 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5338 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5339static psa_status_t psa_key_derivation_start_hmac(
5340 psa_mac_operation_t *operation,
5341 psa_algorithm_t hash_alg,
5342 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005344{
5345 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5346 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005347 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5348 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5349 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005350
Steven Cooreman72f736a2021-05-07 14:14:37 +02005351 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005353
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 status = psa_driver_wrapper_mac_sign_setup(operation,
5355 &attributes,
5356 hmac_key, hmac_key_length,
5357 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005358
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 psa_reset_key_attributes(&attributes);
5360 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005361}
5362#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005363
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005364#define HKDF_STATE_INIT 0 /* no input yet */
5365#define HKDF_STATE_STARTED 1 /* got salt */
5366#define HKDF_STATE_KEYED 2 /* got key */
5367#define HKDF_STATE_OUTPUT 3 /* output started */
5368
Gilles Peskinecbe66502019-05-16 16:59:18 +02005369static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005371{
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5373 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5374 } else {
5375 return operation->alg;
5376 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005377}
5378
Gilles Peskine449bd832023-01-11 14:50:10 +01005379psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005380{
5381 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5383 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005384 /* The object has (apparently) been initialized but it is not
5385 * in use. It's ok to call abort on such an object, and there's
5386 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005388#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5390 mbedtls_free(operation->ctx.hkdf.info);
5391 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5392 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005393#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005394#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5395 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5397 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5398 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5399 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005400 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005402 }
5403
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005405 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005407 }
5408
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005410 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005412 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005413#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005415 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005417 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005418#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005419 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005420
5421 /* We leave the fields Ai and output_block to be erased safely by the
5422 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005424#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5425 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005426#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5428 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5429 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5430 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005431#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305432#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305433 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305434 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005435 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305436 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305437 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305438
5439 status = PSA_SUCCESS;
5440 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305441#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005442 {
5443 status = PSA_ERROR_BAD_STATE;
5444 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 mbedtls_platform_zeroize(operation, sizeof(*operation));
5446 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005447}
5448
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005449psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005451{
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005453 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005455 }
5456
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005457 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005459}
5460
Gilles Peskine449bd832023-01-11 14:50:10 +01005461psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5462 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005463{
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 if (operation->alg == 0) {
5465 return PSA_ERROR_BAD_STATE;
5466 }
5467 if (capacity > operation->capacity) {
5468 return PSA_ERROR_INVALID_ARGUMENT;
5469 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005470 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005472}
5473
Przemek Stekiel69c46792022-06-10 12:59:51 +02005474#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005475/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005476static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5477 psa_algorithm_t kdf_alg,
5478 uint8_t *output,
5479 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005480{
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5482 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005483 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005484 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005485#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005487#else
5488 const uint8_t last_block = 0xff;
5489#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005490
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 if (hkdf->state < HKDF_STATE_KEYED ||
5492 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005493#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005495#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 )) {
5497 return PSA_ERROR_BAD_STATE;
5498 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005499 hkdf->state = HKDF_STATE_OUTPUT;
5500
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005502 /* Copy what remains of the current block */
5503 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005505 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 }
5507 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005508 output += n;
5509 output_length -= n;
5510 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005512 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005514 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005515 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005516 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005517 * object was corrupted or if this function is called directly
5518 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 if (hkdf->block_number == last_block) {
5520 return PSA_ERROR_BAD_STATE;
5521 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005522
5523 /* We need a new block */
5524 ++hkdf->block_number;
5525 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005526
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5528 hash_alg,
5529 hkdf->prk,
5530 hash_length);
5531 if (status != PSA_SUCCESS) {
5532 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005533 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005534
5535 if (hkdf->block_number != 1) {
5536 status = psa_mac_update(&hkdf->hmac,
5537 hkdf->output_block,
5538 hash_length);
5539 if (status != PSA_SUCCESS) {
5540 return status;
5541 }
5542 }
5543 status = psa_mac_update(&hkdf->hmac,
5544 hkdf->info,
5545 hkdf->info_length);
5546 if (status != PSA_SUCCESS) {
5547 return status;
5548 }
5549 status = psa_mac_update(&hkdf->hmac,
5550 &hkdf->block_number, 1);
5551 if (status != PSA_SUCCESS) {
5552 return status;
5553 }
5554 status = psa_mac_sign_finish(&hkdf->hmac,
5555 hkdf->output_block,
5556 sizeof(hkdf->output_block),
5557 &hmac_output_length);
5558 if (status != PSA_SUCCESS) {
5559 return status;
5560 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005561 }
5562
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005564}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005565#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005566
John Durkop07cc04a2020-11-16 22:08:34 -08005567#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5568 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005569static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5570 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005572{
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5574 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005575 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5576 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005577 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005578
Janos Follath7742fee2019-06-17 12:58:10 +01005579 /* We can't be wanting more output after block 0xff, otherwise
5580 * the capacity check in psa_key_derivation_output_bytes() would have
5581 * prevented this call. It could happen only if the operation
5582 * object was corrupted or if this function is called directly
5583 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 if (tls12_prf->block_number == 0xff) {
5585 return PSA_ERROR_CORRUPTION_DETECTED;
5586 }
Janos Follath7742fee2019-06-17 12:58:10 +01005587
5588 /* We need a new block */
5589 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005590 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005591
5592 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5593 *
5594 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5595 *
5596 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5597 * HMAC_hash(secret, A(2) + seed) +
5598 * HMAC_hash(secret, A(3) + seed) + ...
5599 *
5600 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005601 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005602 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005603 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005604 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005605 * is currently extracted as `output_block` and where i is
5606 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005607 */
5608
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 status = psa_key_derivation_start_hmac(&hmac,
5610 hash_alg,
5611 tls12_prf->secret,
5612 tls12_prf->secret_length);
5613 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005614 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005616
5617 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005619 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5620 * the variable seed and in this instance means it in the context of the
5621 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 status = psa_mac_update(&hmac,
5623 tls12_prf->label,
5624 tls12_prf->label_length);
5625 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005626 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005627 }
5628 status = psa_mac_update(&hmac,
5629 tls12_prf->seed,
5630 tls12_prf->seed_length);
5631 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005632 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 }
5634 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005635 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5637 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005638 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005640 }
5641
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 status = psa_mac_sign_finish(&hmac,
5643 tls12_prf->Ai, hash_length,
5644 &hmac_output_length);
5645 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005646 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005647 }
5648 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005649 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005650 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005651
5652 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005653 status = psa_key_derivation_start_hmac(&hmac,
5654 hash_alg,
5655 tls12_prf->secret,
5656 tls12_prf->secret_length);
5657 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005658 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 }
5660 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5661 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005662 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005663 }
5664 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_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->seed, tls12_prf->seed_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_sign_finish(&hmac,
5673 tls12_prf->output_block, hash_length,
5674 &hmac_output_length);
5675 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005676 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005678
Janos Follath7742fee2019-06-17 12:58:10 +01005679
5680cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 cleanup_status = psa_mac_abort(&hmac);
5682 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005683 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005685
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005687}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005688
Janos Follath844eb0e2019-06-19 12:10:49 +01005689static psa_status_t psa_key_derivation_tls12_prf_read(
5690 psa_tls12_prf_key_derivation_t *tls12_prf,
5691 psa_algorithm_t alg,
5692 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005694{
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5696 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005697 psa_status_t status;
5698 uint8_t offset, length;
5699
Gilles Peskine449bd832023-01-11 14:50:10 +01005700 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005701 case PSA_TLS12_PRF_STATE_LABEL_SET:
5702 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5703 break;
5704 case PSA_TLS12_PRF_STATE_OUTPUT:
5705 break;
5706 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005708 }
5709
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005711 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 if (tls12_prf->left_in_block == 0) {
5713 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5714 alg);
5715 if (status != PSA_SUCCESS) {
5716 return status;
5717 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005718
5719 continue;
5720 }
5721
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005723 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005725 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005727
5728 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005730 output += length;
5731 output_length -= length;
5732 tls12_prf->left_in_block -= length;
5733 }
5734
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005736}
John Durkop07cc04a2020-11-16 22:08:34 -08005737#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5738 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005739
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005740#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5741static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5742 psa_tls12_ecjpake_to_pms_t *ecjpake,
5743 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005745{
5746 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005747 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005748
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 if (output_length != 32) {
5750 return PSA_ERROR_INVALID_ARGUMENT;
5751 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005752
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5754 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5755 &output_size);
5756 if (status != PSA_SUCCESS) {
5757 return status;
5758 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005759
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 if (output_size != output_length) {
5761 return PSA_ERROR_GENERIC_ERROR;
5762 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005763
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005765}
5766#endif
5767
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305768#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305769static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5770 psa_pbkdf2_key_derivation_t *pbkdf2,
5771 psa_algorithm_t prf_alg,
5772 uint8_t prf_output_length,
5773 psa_key_attributes_t *attributes)
5774{
5775 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305776 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305777 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305778 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305779 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305780 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305781 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305782
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305783 mac_operation.is_sign = 1;
5784 mac_operation.mac_size = prf_output_length;
5785 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305786
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305787 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5788 attributes,
5789 pbkdf2->password,
5790 pbkdf2->password_length,
5791 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305792 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305793 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305794 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305795 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5796 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305797 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305798 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305799 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305800 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305801 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305802 }
5803 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5804 &mac_output_length);
5805 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305806 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305807 }
5808
5809 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305810 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305811 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305812 }
5813
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305814 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305815
5816 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305817 /* We are passing prf_output_length as mac_size because the driver
5818 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305819 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305820 status = psa_driver_wrapper_mac_compute(attributes,
5821 pbkdf2->password,
5822 pbkdf2->password_length,
5823 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305824 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305825 &mac_output_length);
5826 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305827 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305828 }
5829
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305830 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305831 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305832
5833cleanup:
5834 /* Zeroise buffers to clear sensitive data from memory. */
5835 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5836 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305837}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305838
5839static psa_status_t psa_key_derivation_pbkdf2_read(
5840 psa_pbkdf2_key_derivation_t *pbkdf2,
5841 psa_algorithm_t kdf_alg,
5842 uint8_t *output,
5843 size_t output_length)
5844{
5845 psa_status_t status;
5846 psa_algorithm_t prf_alg;
5847 uint8_t prf_output_length;
5848 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5849 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5850 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5851
5852 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5853 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5854 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5855 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305856 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5857 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305858 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305859 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305860 } else {
5861 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305862 }
5863
5864 switch (pbkdf2->state) {
5865 case PSA_PBKDF2_STATE_PASSWORD_SET:
5866 /* Initially we need a new block so bytes_used is equal to block size*/
5867 pbkdf2->bytes_used = prf_output_length;
5868 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5869 break;
5870 case PSA_PBKDF2_STATE_OUTPUT:
5871 break;
5872 default:
5873 return PSA_ERROR_BAD_STATE;
5874 }
5875
5876 while (output_length != 0) {
5877 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5878 if (n > output_length) {
5879 n = (uint8_t) output_length;
5880 }
5881 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5882 output += n;
5883 output_length -= n;
5884 pbkdf2->bytes_used += n;
5885
5886 if (output_length == 0) {
5887 break;
5888 }
5889
5890 /* We need a new block */
5891 pbkdf2->bytes_used = 0;
5892 pbkdf2->block_number++;
5893
5894 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5895 prf_output_length,
5896 &attributes);
5897 if (status != PSA_SUCCESS) {
5898 return status;
5899 }
5900 }
5901
5902 return PSA_SUCCESS;
5903}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305904#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305905
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005906psa_status_t psa_key_derivation_output_bytes(
5907 psa_key_derivation_operation_t *operation,
5908 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005910{
5911 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005913
Gilles Peskine449bd832023-01-11 14:50:10 +01005914 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005915 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005917 }
5918
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005920 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005921 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005922 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005923 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005924 goto exit;
5925 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005927 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005928 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005929 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5930 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005931 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005932 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005934 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005935 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005936
Przemek Stekiel69c46792022-06-10 12:59:51 +02005937#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5939 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5940 output, output_length);
5941 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005942#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005943#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5944 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5946 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5947 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5948 kdf_alg, output,
5949 output_length);
5950 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005951#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5952 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005953#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005955 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5957 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005958#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305959#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305960 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305961 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5962 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305963 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305964#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005965
Gilles Peskineeab56e42018-07-12 17:12:33 +02005966 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005967 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005969 }
5970
5971exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005973 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005974 * This allows us to differentiate between exhausted operations and
5975 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5976 * operations. */
5977 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005979 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005981 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005983}
5984
David Brown7807bf72021-02-09 16:28:23 -07005985#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005986static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005987{
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 if (data_size >= 8) {
5989 mbedtls_des_key_set_parity(data);
5990 }
5991 if (data_size >= 16) {
5992 mbedtls_des_key_set_parity(data + 8);
5993 }
5994 if (data_size >= 24) {
5995 mbedtls_des_key_set_parity(data + 16);
5996 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005997}
David Brown7807bf72021-02-09 16:28:23 -07005998#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005999
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006000/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 * ECC keys on a Weierstrass elliptic curve require the generation
6002 * of a private key which is an integer
6003 * in the range [1, N - 1], where N is the boundary of the private key domain:
6004 * N is the prime p for Diffie-Hellman, or the order of the
6005 * curve’s base point for ECC.
6006 *
6007 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6008 * This function generates the private key using the following process:
6009 *
6010 * 1. Draw a byte string of length ceiling(m/8) bytes.
6011 * 2. If m is not a multiple of 8, set the most significant
6012 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6013 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6014 * 4. If k > N - 2, discard the result and return to step 1.
6015 * 5. Output k + 1 as the private key.
6016 *
6017 * This method allows compliance to NIST standards, specifically the methods titled
6018 * Key-Pair Generation by Testing Candidates in the following publications:
6019 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6020 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6021 * Diffie-Hellman keys.
6022 *
6023 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6024 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6025 *
6026 * Note: Function allocates memory for *data buffer, so given *data should be
6027 * always NULL.
6028 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006029#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6030#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006031static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006032 psa_key_slot_t *slot,
6033 size_t bits,
6034 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006035 uint8_t **data
6036 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006037{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006038 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006039 mbedtls_mpi k;
6040 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006041 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006042 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006043 size_t m;
6044 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006045
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 mbedtls_mpi_init(&k);
6047 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006048
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006049 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006051 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006053
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006055 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006056 goto cleanup;
6057 }
6058
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006059 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006061
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006063
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006064 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006065 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006066 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006067
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006068 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006069
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006070 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006072
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006073 /* Note: This function is always called with *data == NULL and it
6074 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 *data = mbedtls_calloc(1, m_bytes);
6076 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006077 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006078 goto cleanup;
6079 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006080
Gilles Peskine449bd832023-01-11 14:50:10 +01006081 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006082 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006084 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006086
6087 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006089 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006090 * (8 * ceiling(m/8) - m) bits of the first byte in
6091 * the string to zero.
6092 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006094 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006095 }
6096
6097 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 * big-endian byte string.
6099 */
6100 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006101
6102 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 * Result of comparison is returned. When it indicates error
6104 * then this function is called again.
6105 */
6106 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006107 }
6108
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006109 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6111 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006112cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 if (ret != 0) {
6114 status = mbedtls_to_psa_error(ret);
6115 }
6116 if (status != PSA_SUCCESS) {
6117 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006118 *data = NULL;
6119 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 mbedtls_mpi_free(&k);
6121 mbedtls_mpi_free(&diff_N_2);
6122 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006123}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006124
6125/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6126 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6127 *
6128 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6129 * draw a 32-byte string and process it as specified in
6130 * Elliptic Curves for Security [RFC7748] §5.
6131 *
6132 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6133 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6134 *
6135 * Note: Function allocates memory for *data buffer, so given *data should be
6136 * always NULL.
6137 */
6138
6139static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6140 size_t bits,
6141 psa_key_derivation_operation_t *operation,
6142 uint8_t **data
6143 )
6144{
6145 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006146 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006147
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006149 case 255:
6150 output_length = 32;
6151 break;
6152 case 448:
6153 output_length = 56;
6154 break;
6155 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006156 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006157 break;
6158 }
6159
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006161
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 if (*data == NULL) {
6163 return PSA_ERROR_INSUFFICIENT_MEMORY;
6164 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006165
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006167
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006169 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006171
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006173 case 255:
6174 (*data)[0] &= 248;
6175 (*data)[31] &= 127;
6176 (*data)[31] |= 64;
6177 break;
6178 case 448:
6179 (*data)[0] &= 252;
6180 (*data)[55] |= 128;
6181 break;
6182 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006184 break;
6185 }
6186
6187 return status;
6188}
Valerio Setti86587ab2023-06-27 13:09:30 +02006189#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6190static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6191 psa_key_slot_t *slot, size_t bits,
6192 psa_key_derivation_operation_t *operation, uint8_t **data)
6193{
6194 (void) slot;
6195 (void) bits;
6196 (void) operation;
6197 (void) data;
6198 return PSA_ERROR_NOT_SUPPORTED;
6199}
6200
6201static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6202 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6203{
6204 (void) bits;
6205 (void) operation;
6206 (void) data;
6207 return PSA_ERROR_NOT_SUPPORTED;
6208}
6209#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6210#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006211
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006212static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006213 psa_key_slot_t *slot,
6214 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006216{
6217 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306219 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006220 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006221 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006222
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6224 return PSA_ERROR_INVALID_ARGUMENT;
6225 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006226
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006227#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006228 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6230 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6231 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006232 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6234 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006235 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 }
6237 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006238 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6240 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006241 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006243 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006244 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006245#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006246 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 if (key_type_is_raw_bytes(slot->attr.type)) {
6248 if (bits % 8 != 0) {
6249 return PSA_ERROR_INVALID_ARGUMENT;
6250 }
6251 data = mbedtls_calloc(1, bytes);
6252 if (data == NULL) {
6253 return PSA_ERROR_INSUFFICIENT_MEMORY;
6254 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006255
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 status = psa_key_derivation_output_bytes(operation, data, bytes);
6257 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006258 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 }
David Brown12ca5032021-02-11 11:02:00 -07006260#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6262 psa_des_set_key_parity(data, bytes);
6263 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006264#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 } else {
6266 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006267 }
Ronald Crondd04d422020-11-28 15:14:42 +01006268
Ronald Cronbf33c932020-11-28 18:06:53 +01006269 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006270 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006272 };
6273
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6275 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6276 &storage_size);
6277 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306278 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 }
Archanad8a83dc2021-06-14 10:04:16 +05306280 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 status = psa_allocate_buffer_to_slot(slot, storage_size);
6282 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306283 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 }
Archanad8a83dc2021-06-14 10:04:16 +05306285
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 status = psa_driver_wrapper_import_key(&attributes,
6287 data, bytes,
6288 slot->key.data,
6289 slot->key.bytes,
6290 &slot->key.bytes, &bits);
6291 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006292 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006294
6295exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 mbedtls_free(data);
6297 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006298}
6299
Gilles Peskine449bd832023-01-11 14:50:10 +01006300psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6301 psa_key_derivation_operation_t *operation,
6302 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006303{
6304 psa_status_t status;
6305 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006306 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006307
Ronald Cron81709fc2020-11-14 12:10:32 +01006308 *key = MBEDTLS_SVC_KEY_ID_INIT;
6309
Gilles Peskine0f84d622019-09-12 19:03:13 +02006310 /* Reject any attempt to create a zero-length key so that we don't
6311 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 if (psa_get_key_bits(attributes) == 0) {
6313 return PSA_ERROR_INVALID_ARGUMENT;
6314 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006315
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 if (operation->alg == PSA_ALG_NONE) {
6317 return PSA_ERROR_BAD_STATE;
6318 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006319
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 if (!operation->can_output_key) {
6321 return PSA_ERROR_NOT_PERMITTED;
6322 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006323
Gilles Peskine449bd832023-01-11 14:50:10 +01006324 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6325 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006326#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006328 /* Deriving a key in a secure element is not implemented yet. */
6329 status = PSA_ERROR_NOT_SUPPORTED;
6330 }
6331#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 if (status == PSA_SUCCESS) {
6333 status = psa_generate_derived_key_internal(slot,
6334 attributes->core.bits,
6335 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006336 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 if (status == PSA_SUCCESS) {
6338 status = psa_finish_key_creation(slot, driver, key);
6339 }
6340 if (status != PSA_SUCCESS) {
6341 psa_fail_key_creation(slot, driver);
6342 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006343
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006345}
6346
Gilles Peskineeab56e42018-07-12 17:12:33 +02006347
6348
6349/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006350/* Key derivation */
6351/****************************************************************/
6352
Steven Cooreman932ffb72021-02-15 12:14:32 +01006353#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006354static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006355{
6356#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6358 return 1;
6359 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006360#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006361#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6363 return 1;
6364 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006365#endif
6366#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6368 return 1;
6369 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006370#endif
6371#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6373 return 1;
6374 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006375#endif
6376#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6378 return 1;
6379 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006380#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006381#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6383 return 1;
6384 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006385#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306386#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6387 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6388 return 1;
6389 }
6390#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306391#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6392 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6393 return 1;
6394 }
6395#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006397}
6398
Gilles Peskine449bd832023-01-11 14:50:10 +01006399static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006400{
6401 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 psa_status_t status = psa_hash_setup(&operation, alg);
6403 psa_hash_abort(&operation);
6404 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006405}
6406
Gilles Peskine969c5d62019-01-16 15:53:06 +01006407static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006408 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006410{
Janos Follath5fe19732019-06-20 15:09:30 +01006411 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6412 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006414
Gilles Peskine969c5d62019-01-16 15:53:06 +01006415 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006416 if (!is_kdf_alg_supported(kdf_alg)) {
6417 return PSA_ERROR_NOT_SUPPORTED;
6418 }
John Durkop07cc04a2020-11-16 22:08:34 -08006419
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006420 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306421 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6423 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306424 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6425 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6426 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306427 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306428 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006429 if (hash_size == 0) {
6430 return PSA_ERROR_NOT_SUPPORTED;
6431 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006432
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006433 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6434 * we might fail later, which is somewhat unfriendly and potentially
6435 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 psa_status_t status = psa_hash_try_support(hash_alg);
6437 if (status != PSA_SUCCESS) {
6438 return status;
6439 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006440 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006441
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6443 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6444 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6445 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006446 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006447#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006448 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6450 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006451 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006453#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6454 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 operation->capacity = 255 * hash_size;
6456 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006457}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006458
Gilles Peskine449bd832023-01-11 14:50:10 +01006459static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006460{
6461#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 if (alg == PSA_ALG_ECDH) {
6463 return PSA_SUCCESS;
6464 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006465#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006466#if defined(PSA_WANT_ALG_FFDH)
6467 if (alg == PSA_ALG_FFDH) {
6468 return PSA_SUCCESS;
6469 }
6470#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006471 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006473}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006474
6475static int psa_key_derivation_allows_free_form_secret_input(
6476 psa_algorithm_t kdf_alg)
6477{
6478#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6479 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6480 return 0;
6481 }
6482#endif
6483 (void) kdf_alg;
6484 return 1;
6485}
John Durkop07cc04a2020-11-16 22:08:34 -08006486#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006487
Gilles Peskine449bd832023-01-11 14:50:10 +01006488psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6489 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006490{
6491 psa_status_t status;
6492
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 if (operation->alg != 0) {
6494 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006495 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006496
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6498 return PSA_ERROR_INVALID_ARGUMENT;
6499 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6500#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6501 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6502 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6503 status = psa_key_agreement_try_support(ka_alg);
6504 if (status != PSA_SUCCESS) {
6505 return status;
6506 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006507 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6508 return PSA_ERROR_INVALID_ARGUMENT;
6509 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006510 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6511#else
6512 return PSA_ERROR_NOT_SUPPORTED;
6513#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6514 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6515#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6516 status = psa_key_derivation_setup_kdf(operation, alg);
6517#else
6518 return PSA_ERROR_NOT_SUPPORTED;
6519#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6520 } else {
6521 return PSA_ERROR_INVALID_ARGUMENT;
6522 }
6523
6524 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006525 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 }
6527 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006528}
6529
Przemek Stekiel69c46792022-06-10 12:59:51 +02006530#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006531static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6532 psa_algorithm_t kdf_alg,
6533 psa_key_derivation_step_t step,
6534 const uint8_t *data,
6535 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006536{
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006538 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006540 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006541#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6543 return PSA_ERROR_INVALID_ARGUMENT;
6544 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006545#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 if (hkdf->state != HKDF_STATE_INIT) {
6547 return PSA_ERROR_BAD_STATE;
6548 } else {
6549 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6550 hash_alg,
6551 data, data_length);
6552 if (status != PSA_SUCCESS) {
6553 return status;
6554 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006555 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006556 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006557 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006558 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006559#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006560 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006561 /* We shouldn't be in different state as HKDF_EXPAND only allows
6562 * two inputs: SECRET (this case) and INFO which does not modify
6563 * the state. It could happen only if the hkdf
6564 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 if (hkdf->state != HKDF_STATE_INIT) {
6566 return PSA_ERROR_BAD_STATE;
6567 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006568
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006569 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6571 return PSA_ERROR_INVALID_ARGUMENT;
6572 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006573
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 memcpy(hkdf->prk, data, data_length);
6575 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006576#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006577 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006578 /* HKDF: If no salt was provided, use an empty salt.
6579 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006581#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6583 return PSA_ERROR_BAD_STATE;
6584 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006585#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006586 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6587 hash_alg,
6588 NULL, 0);
6589 if (status != PSA_SUCCESS) {
6590 return status;
6591 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006592 hkdf->state = HKDF_STATE_STARTED;
6593 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 if (hkdf->state != HKDF_STATE_STARTED) {
6595 return PSA_ERROR_BAD_STATE;
6596 }
6597 status = psa_mac_update(&hkdf->hmac,
6598 data, data_length);
6599 if (status != PSA_SUCCESS) {
6600 return status;
6601 }
6602 status = psa_mac_sign_finish(&hkdf->hmac,
6603 hkdf->prk,
6604 sizeof(hkdf->prk),
6605 &data_length);
6606 if (status != PSA_SUCCESS) {
6607 return status;
6608 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006609 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006610
Gilles Peskine2b522db2019-04-12 15:11:49 +02006611 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006612 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006613#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006615 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006617 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006618 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006619#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006620 {
6621 /* Block 0 is empty, and the next block will be
6622 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006624 }
6625
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006627 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006628#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6630 return PSA_ERROR_INVALID_ARGUMENT;
6631 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006632#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006633#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6635 hkdf->state == HKDF_STATE_INIT) {
6636 return PSA_ERROR_BAD_STATE;
6637 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006638#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 if (hkdf->state == HKDF_STATE_OUTPUT) {
6640 return PSA_ERROR_BAD_STATE;
6641 }
6642 if (hkdf->info_set) {
6643 return PSA_ERROR_BAD_STATE;
6644 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006645 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 if (data_length != 0) {
6647 hkdf->info = mbedtls_calloc(1, data_length);
6648 if (hkdf->info == NULL) {
6649 return PSA_ERROR_INSUFFICIENT_MEMORY;
6650 }
6651 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006652 }
6653 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006655 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006657 }
6658}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006659#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006660
John Durkop07cc04a2020-11-16 22:08:34 -08006661#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6662 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006663static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6664 const uint8_t *data,
6665 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006666{
Gilles Peskine449bd832023-01-11 14:50:10 +01006667 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6668 return PSA_ERROR_BAD_STATE;
6669 }
Janos Follathf08e2652019-06-13 09:05:41 +01006670
Gilles Peskine449bd832023-01-11 14:50:10 +01006671 if (data_length != 0) {
6672 prf->seed = mbedtls_calloc(1, data_length);
6673 if (prf->seed == NULL) {
6674 return PSA_ERROR_INSUFFICIENT_MEMORY;
6675 }
Janos Follathf08e2652019-06-13 09:05:41 +01006676
Gilles Peskine449bd832023-01-11 14:50:10 +01006677 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006678 prf->seed_length = data_length;
6679 }
Janos Follathf08e2652019-06-13 09:05:41 +01006680
Gilles Peskine43f958b2020-12-13 14:55:14 +01006681 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006682
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006684}
6685
Gilles Peskine449bd832023-01-11 14:50:10 +01006686static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6687 const uint8_t *data,
6688 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006689{
Gilles Peskine449bd832023-01-11 14:50:10 +01006690 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6691 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6692 return PSA_ERROR_BAD_STATE;
6693 }
Janos Follath81550542019-06-13 14:26:34 +01006694
Gilles Peskine449bd832023-01-11 14:50:10 +01006695 if (data_length != 0) {
6696 prf->secret = mbedtls_calloc(1, data_length);
6697 if (prf->secret == NULL) {
6698 return PSA_ERROR_INSUFFICIENT_MEMORY;
6699 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006700
Gilles Peskine449bd832023-01-11 14:50:10 +01006701 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006702 prf->secret_length = data_length;
6703 }
Janos Follath81550542019-06-13 14:26:34 +01006704
Gilles Peskine43f958b2020-12-13 14:55:14 +01006705 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006706
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006708}
6709
Gilles Peskine449bd832023-01-11 14:50:10 +01006710static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6711 const uint8_t *data,
6712 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006713{
Gilles Peskine449bd832023-01-11 14:50:10 +01006714 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6715 return PSA_ERROR_BAD_STATE;
6716 }
Janos Follath63028dd2019-06-13 09:15:47 +01006717
Gilles Peskine449bd832023-01-11 14:50:10 +01006718 if (data_length != 0) {
6719 prf->label = mbedtls_calloc(1, data_length);
6720 if (prf->label == NULL) {
6721 return PSA_ERROR_INSUFFICIENT_MEMORY;
6722 }
Janos Follath63028dd2019-06-13 09:15:47 +01006723
Gilles Peskine449bd832023-01-11 14:50:10 +01006724 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006725 prf->label_length = data_length;
6726 }
Janos Follath63028dd2019-06-13 09:15:47 +01006727
Gilles Peskine43f958b2020-12-13 14:55:14 +01006728 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006729
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006731}
6732
Gilles Peskine449bd832023-01-11 14:50:10 +01006733static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6734 psa_key_derivation_step_t step,
6735 const uint8_t *data,
6736 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006737{
Gilles Peskine449bd832023-01-11 14:50:10 +01006738 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006739 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006740 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006741 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006742 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006743 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006745 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006747 }
6748}
John Durkop07cc04a2020-11-16 22:08:34 -08006749#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6750 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6751
6752#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6753static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6754 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006755 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006757{
6758 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6760 4 + data_length + prf->other_secret_length :
6761 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006762
Gilles Peskine449bd832023-01-11 14:50:10 +01006763 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6764 return PSA_ERROR_INVALID_ARGUMENT;
6765 }
John Durkop07cc04a2020-11-16 22:08:34 -08006766
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 uint8_t *pms = mbedtls_calloc(1, pms_len);
6768 if (pms == NULL) {
6769 return PSA_ERROR_INSUFFICIENT_MEMORY;
6770 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006771 uint8_t *cur = pms;
6772
6773 /* pure-PSK:
6774 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006775 *
6776 * The premaster secret is formed as follows: if the PSK is N octets
6777 * long, concatenate a uint16 with the value N, N zero octets, a second
6778 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006779 *
6780 * mixed-PSK:
6781 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6782 * follows: concatenate a uint16 with the length of the other secret,
6783 * the other secret itself, uint16 with the length of PSK, and the
6784 * PSK itself.
6785 * For details please check:
6786 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6787 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6788 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006789 */
6790
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6792 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6793 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6794 if (prf->other_secret_length != 0) {
6795 memcpy(cur, prf->other_secret, prf->other_secret_length);
6796 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006797 cur += prf->other_secret_length;
6798 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006799 } else {
6800 *cur++ = MBEDTLS_BYTE_1(data_length);
6801 *cur++ = MBEDTLS_BYTE_0(data_length);
6802 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006803 cur += data_length;
6804 }
6805
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 *cur++ = MBEDTLS_BYTE_1(data_length);
6807 *cur++ = MBEDTLS_BYTE_0(data_length);
6808 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006809 cur += data_length;
6810
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006811 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006812
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006813 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006815}
Janos Follath6660f0e2019-06-17 08:44:03 +01006816
Przemek Stekiele47201b2022-04-19 13:53:28 +02006817static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6818 psa_tls12_prf_key_derivation_t *prf,
6819 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006821{
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6823 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006824 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006825
6826 if (data_length != 0) {
6827 prf->other_secret = mbedtls_calloc(1, data_length);
6828 if (prf->other_secret == NULL) {
6829 return PSA_ERROR_INSUFFICIENT_MEMORY;
6830 }
6831
6832 memcpy(prf->other_secret, data, data_length);
6833 prf->other_secret_length = data_length;
6834 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006835 prf->other_secret_length = 0;
6836 }
6837
6838 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6839
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006841}
6842
Janos Follath6660f0e2019-06-17 08:44:03 +01006843static psa_status_t psa_tls12_prf_psk_to_ms_input(
6844 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006845 psa_key_derivation_step_t step,
6846 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006848{
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006850 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 return psa_tls12_prf_psk_to_ms_set_key(prf,
6852 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006853 break;
6854 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6856 data,
6857 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006858 break;
6859 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006861 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006862
Przemek Stekiele47201b2022-04-19 13:53:28 +02006863 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006864}
John Durkop07cc04a2020-11-16 22:08:34 -08006865#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006866
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006867#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6868static psa_status_t psa_tls12_ecjpake_to_pms_input(
6869 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006870 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006871 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006873{
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6875 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6876 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006877 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006878
6879 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 if (data[0] != 0x04) {
6881 return PSA_ERROR_INVALID_ARGUMENT;
6882 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006883
6884 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006886
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006888}
6889#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306890
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306891#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306892static psa_status_t psa_pbkdf2_set_input_cost(
6893 psa_pbkdf2_key_derivation_t *pbkdf2,
6894 psa_key_derivation_step_t step,
6895 uint64_t data)
6896{
6897 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6898 return PSA_ERROR_INVALID_ARGUMENT;
6899 }
6900
6901 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6902 return PSA_ERROR_BAD_STATE;
6903 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306904
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306905 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306906 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306907 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306908
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306909 if (data == 0) {
6910 return PSA_ERROR_INVALID_ARGUMENT;
6911 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306912
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306913 pbkdf2->input_cost = data;
6914 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6915
6916 return PSA_SUCCESS;
6917}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306918
6919static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6920 const uint8_t *data,
6921 size_t data_length)
6922{
Gilles Peskineead17662023-08-20 22:02:51 +02006923 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6924 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6925 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6926 /* Appending to existing salt. No state change. */
6927 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306928 return PSA_ERROR_BAD_STATE;
6929 }
6930
Gilles Peskineca57d782023-07-20 19:08:06 +02006931 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006932 /* Appending an empty string, nothing to do. */
6933 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306934 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306935
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306936 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6937 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306938 return PSA_ERROR_INSUFFICIENT_MEMORY;
6939 }
6940
Gilles Peskineead17662023-08-20 22:02:51 +02006941 if (pbkdf2->salt_length != 0) {
6942 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6943 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306944 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306945 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306946 mbedtls_free(pbkdf2->salt);
6947 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306948 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306949 return PSA_SUCCESS;
6950}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306951
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306952#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306953static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306954 const uint8_t *input,
6955 size_t input_len,
6956 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306957 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306958{
6959 psa_status_t status = PSA_SUCCESS;
6960 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6961 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306962 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306963 } else {
6964 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306965 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306966 }
6967 return status;
6968}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306969#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306970
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306971#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306972static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6973 size_t input_len,
6974 uint8_t *output,
6975 size_t *output_len)
6976{
6977 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306978 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306979 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306980 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306981 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6982 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6983 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306984 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306985 * mac_size as the driver function sets mac_output_length = mac_size
6986 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306987 status = psa_driver_wrapper_mac_compute(&attributes,
6988 zeros, sizeof(zeros),
6989 PSA_ALG_CMAC, input, input_len,
6990 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306991 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6992 128U,
6993 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306994 output_len);
6995 } else {
6996 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306997 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306998 }
6999 return status;
7000}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307001#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307002
7003static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307004 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307005 const uint8_t *data,
7006 size_t data_length)
7007{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307008 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307009 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7010 return PSA_ERROR_BAD_STATE;
7011 }
7012
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307013#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307014 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7015 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7016 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7017 pbkdf2->password,
7018 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307019 } else
7020#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7021#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7022 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307023 status = psa_pbkdf2_cmac_set_password(data, data_length,
7024 pbkdf2->password,
7025 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307026 } else
7027#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7028 {
7029 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307030 }
7031
7032 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7033
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307034 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307035}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307036
7037static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307038 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307039 psa_key_derivation_step_t step,
7040 const uint8_t *data,
7041 size_t data_length)
7042{
7043 switch (step) {
7044 case PSA_KEY_DERIVATION_INPUT_SALT:
7045 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7046 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307047 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307048 default:
7049 return PSA_ERROR_INVALID_ARGUMENT;
7050 }
7051}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307052#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307053
Gilles Peskineb8965192019-09-24 16:21:10 +02007054/** Check whether the given key type is acceptable for the given
7055 * input step of a key derivation.
7056 *
7057 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7058 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7059 * Both secret and non-secret inputs can alternatively have the type
7060 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7061 * that the input was passed as a buffer rather than via a key object.
7062 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007063static int psa_key_derivation_check_input_type(
7064 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007066{
Gilles Peskine449bd832023-01-11 14:50:10 +01007067 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007068 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 if (key_type == PSA_KEY_TYPE_DERIVE) {
7070 return PSA_SUCCESS;
7071 }
7072 if (key_type == PSA_KEY_TYPE_NONE) {
7073 return PSA_SUCCESS;
7074 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007075 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007076 case PSA_KEY_DERIVATION_INPUT_OTHER_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 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007083 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007084 case PSA_KEY_DERIVATION_INPUT_LABEL:
7085 case PSA_KEY_DERIVATION_INPUT_SALT:
7086 case PSA_KEY_DERIVATION_INPUT_INFO:
7087 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7089 return PSA_SUCCESS;
7090 }
7091 if (key_type == PSA_KEY_TYPE_NONE) {
7092 return PSA_SUCCESS;
7093 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007094 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307095 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7096 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7097 return PSA_SUCCESS;
7098 }
7099 if (key_type == PSA_KEY_TYPE_DERIVE) {
7100 return PSA_SUCCESS;
7101 }
7102 if (key_type == PSA_KEY_TYPE_NONE) {
7103 return PSA_SUCCESS;
7104 }
7105 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007106 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007108}
7109
Janos Follathb80a94e2019-06-12 15:54:46 +01007110static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007111 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007112 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007113 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007114 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007116{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007117 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007118 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007119
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 status = psa_key_derivation_check_input_type(step, key_type);
7121 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007122 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007123 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007124
Przemek Stekiel69c46792022-06-10 12:59:51 +02007125#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007126 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7127 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7128 step, data, data_length);
7129 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007130#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007131#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7133 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7134 step, data, data_length);
7135 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007136#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7137#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7139 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7140 step, data, data_length);
7141 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007142#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007143#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007145 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7147 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007148#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307149#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307150 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307151 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7152 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307153 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307154#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007155 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007156 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007157 (void) data;
7158 (void) data_length;
7159 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007161 }
7162
Gilles Peskine224b0d62019-09-23 18:13:17 +02007163exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 if (status != PSA_SUCCESS) {
7165 psa_key_derivation_abort(operation);
7166 }
7167 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007168}
7169
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307170static psa_status_t psa_key_derivation_input_integer_internal(
7171 psa_key_derivation_operation_t *operation,
7172 psa_key_derivation_step_t step,
7173 uint64_t value)
7174{
7175 psa_status_t status;
7176 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7177
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307178#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307179 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307180 status = psa_pbkdf2_set_input_cost(
7181 &operation->ctx.pbkdf2, step, value);
7182 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307183#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307184 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307185 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307186 (void) value;
7187 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307188 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307189 }
7190
7191 if (status != PSA_SUCCESS) {
7192 psa_key_derivation_abort(operation);
7193 }
7194 return status;
7195}
7196
Janos Follath51f4a0f2019-06-14 11:35:55 +01007197psa_status_t psa_key_derivation_input_bytes(
7198 psa_key_derivation_operation_t *operation,
7199 psa_key_derivation_step_t step,
7200 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007202{
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 return psa_key_derivation_input_internal(operation, step,
7204 PSA_KEY_TYPE_NONE,
7205 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007206}
7207
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307208psa_status_t psa_key_derivation_input_integer(
7209 psa_key_derivation_operation_t *operation,
7210 psa_key_derivation_step_t step,
7211 uint64_t value)
7212{
7213 return psa_key_derivation_input_integer_internal(operation, step, value);
7214}
7215
Janos Follath51f4a0f2019-06-14 11:35:55 +01007216psa_status_t psa_key_derivation_input_key(
7217 psa_key_derivation_operation_t *operation,
7218 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007220{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007222 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007223 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007224
Ronald Cron5c522922020-11-14 16:35:34 +01007225 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7227 if (status != PSA_SUCCESS) {
7228 psa_key_derivation_abort(operation);
7229 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007230 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007231
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307232 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7233 * permission to output to a key object. */
7234 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7235 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007236 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007238
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 status = psa_key_derivation_input_internal(operation,
7240 step, slot->attr.type,
7241 slot->key.data,
7242 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007243
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007245
Gilles Peskine449bd832023-01-11 14:50:10 +01007246 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007247}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007248
7249
7250
7251/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007252/* Key agreement */
7253/****************************************************************/
7254
Gilles Peskine449bd832023-01-11 14:50:10 +01007255psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7256 const uint8_t *key_buffer,
7257 size_t key_buffer_size,
7258 psa_algorithm_t alg,
7259 const uint8_t *peer_key,
7260 size_t peer_key_length,
7261 uint8_t *shared_secret,
7262 size_t shared_secret_size,
7263 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007264{
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007266#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007267 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7269 key_buffer_size, alg,
7270 peer_key, peer_key_length,
7271 shared_secret,
7272 shared_secret_size,
7273 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007274#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007275
7276#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7277 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007278 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007279 peer_key,
7280 peer_key_length,
7281 key_buffer,
7282 key_buffer_size,
7283 shared_secret,
7284 shared_secret_size,
7285 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007286#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7287
Gilles Peskine01d718c2018-09-18 12:01:02 +02007288 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007289 (void) attributes;
7290 (void) key_buffer;
7291 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007292 (void) peer_key;
7293 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007294 (void) shared_secret;
7295 (void) shared_secret_size;
7296 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007298 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007299}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007300
Aditya Deshpande17845b82022-10-13 17:21:01 +01007301/** Internal function for raw key agreement
7302 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007303 * to the driver's implementation if a driver is present.
7304 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007305 * (psa_key_agreement_raw_builtin).
7306 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007307static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7308 psa_key_slot_t *private_key,
7309 const uint8_t *peer_key,
7310 size_t peer_key_length,
7311 uint8_t *shared_secret,
7312 size_t shared_secret_size,
7313 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007314{
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7316 return PSA_ERROR_NOT_SUPPORTED;
7317 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007318
7319 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007320 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007321 };
7322
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 return psa_driver_wrapper_key_agreement(&attributes,
7324 private_key->key.data,
7325 private_key->key.bytes, alg,
7326 peer_key, peer_key_length,
7327 shared_secret,
7328 shared_secret_size,
7329 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007330}
7331
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007332/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007333 * to potentially free embedded data structures and wipe confidential data.
7334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007335static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7336 psa_key_derivation_step_t step,
7337 psa_key_slot_t *private_key,
7338 const uint8_t *peer_key,
7339 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007340{
7341 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007342 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007343 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007345
7346 /* Step 1: run the secret agreement algorithm to generate the shared
7347 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007348 status = psa_key_agreement_raw_internal(ka_alg,
7349 private_key,
7350 peer_key, peer_key_length,
7351 shared_secret,
7352 sizeof(shared_secret),
7353 &shared_secret_length);
7354 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007355 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007357
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007358 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007359 * the shared secret. A shared secret is permitted wherever a key
7360 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 status = psa_key_derivation_input_internal(operation, step,
7362 PSA_KEY_TYPE_DERIVE,
7363 shared_secret,
7364 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007365exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7367 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007368}
7369
Gilles Peskine449bd832023-01-11 14:50:10 +01007370psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7371 psa_key_derivation_step_t step,
7372 mbedtls_svc_key_id_t private_key,
7373 const uint8_t *peer_key,
7374 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007375{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007376 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007377 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007378 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007379
Gilles Peskine449bd832023-01-11 14:50:10 +01007380 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7381 return PSA_ERROR_INVALID_ARGUMENT;
7382 }
Ronald Cron5c522922020-11-14 16:35:34 +01007383 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007384 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7385 if (status != PSA_SUCCESS) {
7386 return status;
7387 }
7388 status = psa_key_agreement_internal(operation, step,
7389 slot,
7390 peer_key, peer_key_length);
7391 if (status != PSA_SUCCESS) {
7392 psa_key_derivation_abort(operation);
7393 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007394 /* If a private key has been added as SECRET, we allow the derived
7395 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007397 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007399 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007400
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007402
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007404}
7405
Gilles Peskine449bd832023-01-11 14:50:10 +01007406psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7407 mbedtls_svc_key_id_t private_key,
7408 const uint8_t *peer_key,
7409 size_t peer_key_length,
7410 uint8_t *output,
7411 size_t output_size,
7412 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007413{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007414 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007415 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007416 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007417 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007418
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007420 status = PSA_ERROR_INVALID_ARGUMENT;
7421 goto exit;
7422 }
Ronald Cron5c522922020-11-14 16:35:34 +01007423 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7425 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007426 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007428
Gilles Peskine3e561302022-04-14 00:17:15 +02007429 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7430 * for the output size. The PSA specification only guarantees that this
7431 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7432 * but it might be nice to allow smaller buffers if the output fits.
7433 * At the time of writing this comment, with only ECDH implemented,
7434 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7435 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7436 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007437 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7439 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007440 status = PSA_ERROR_BUFFER_TOO_SMALL;
7441 goto exit;
7442 }
7443
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 status = psa_key_agreement_raw_internal(alg, slot,
7445 peer_key, peer_key_length,
7446 output, output_size,
7447 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007448
7449exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007451 /* If an error happens and is not handled properly, the output
7452 * may be used as a key to protect sensitive data. Arrange for such
7453 * a key to be random, which is likely to result in decryption or
7454 * verification errors. This is better than filling the buffer with
7455 * some constant data such as zeros, which would result in the data
7456 * being protected with a reproducible, easily knowable key.
7457 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007459 *output_length = output_size;
7460 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007461
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007465}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007466
7467
Gilles Peskine30524eb2020-11-13 17:02:26 +01007468
Gilles Peskine86a440b2018-11-12 18:39:40 +01007469/****************************************************************/
7470/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007471/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007472
Gilles Peskine672a7712023-04-28 21:00:28 +02007473#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7474#include "entropy_poll.h"
7475#endif
7476
Gilles Peskine30524eb2020-11-13 17:02:26 +01007477/** Initialize the PSA random generator.
7478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007479static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007480{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007481#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007483#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7484
Gilles Peskine30524eb2020-11-13 17:02:26 +01007485 /* Set default configuration if
7486 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007488 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 }
7490 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007491 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007495#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7496 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7497 /* The PSA entropy injection feature depends on using NV seed as an entropy
7498 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 mbedtls_entropy_add_source(&rng->entropy,
7500 mbedtls_nv_seed_poll, NULL,
7501 MBEDTLS_ENTROPY_BLOCK_SIZE,
7502 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007503#endif
7504
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007506#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007507}
7508
7509/** Deinitialize the PSA random generator.
7510 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007511static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007512{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007513#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007515#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7517 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007518#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007519}
7520
7521/** Seed the PSA random generator.
7522 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007523static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007524{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007525#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7526 /* Do nothing: the external RNG seeds itself. */
7527 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007529#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007530 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7532 drbg_seed, sizeof(drbg_seed) - 1);
7533 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007534#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007535}
7536
Gilles Peskine449bd832023-01-11 14:50:10 +01007537psa_status_t psa_generate_random(uint8_t *output,
7538 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007539{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007540 GUARD_MODULE_INITIALIZED;
7541
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007542#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7543
7544 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7546 output, output_size,
7547 &output_length);
7548 if (status != PSA_SUCCESS) {
7549 return status;
7550 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007551 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007552 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 if (output_length != output_size) {
7554 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7555 }
7556 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007557
7558#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7559
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007561 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7563 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7564 output_size);
7565 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7566 output, request_size);
7567 if (ret != 0) {
7568 return mbedtls_to_psa_error(ret);
7569 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007570 output_size -= request_size;
7571 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007572 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007574#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007575}
7576
Gilles Peskine8814fc42020-12-14 15:33:44 +01007577/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007578 *
7579 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7580 * `psa_generate_random(...)`. The state parameter is ignored since the
7581 * PSA API doesn't support passing an explicit state.
7582 *
7583 * In the non-external case, psa_generate_random() calls an
7584 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7585 * and semantics as mbedtls_psa_get_random(). As an optimization,
7586 * instead of doing this back-and-forth between the PSA API and the
7587 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7588 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007589 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007590#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7591int mbedtls_psa_get_random(void *p_rng,
7592 unsigned char *output,
7593 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007594{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007595 /* This function takes a pointer to the RNG state because that's what
7596 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7597 * its own state internally and doesn't let the caller access that state.
7598 * So we just ignore the state parameter, and in practice we'll pass
7599 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007600 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 psa_status_t status = psa_generate_random(output, output_size);
7602 if (status == PSA_SUCCESS) {
7603 return 0;
7604 } else {
7605 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7606 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007607}
7608#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7609
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007610#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007611psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7612 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007613{
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 if (global_data.initialized) {
7615 return PSA_ERROR_NOT_PERMITTED;
7616 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007617
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7619 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7620 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7621 return PSA_ERROR_INVALID_ARGUMENT;
7622 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007623
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007625}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007626#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007627
Ronald Cron3772afe2021-02-08 16:10:05 +01007628/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007629 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007630 * \param type The key type
7631 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007632 *
7633 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007634 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007635 * \retval #PSA_ERROR_INVALID_ARGUMENT
7636 * The size in bits of the key is not valid.
7637 * \retval #PSA_ERROR_NOT_SUPPORTED
7638 * The type and/or the size in bits of the key or the combination of
7639 * the two is not supported.
7640 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007641static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007643{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007644 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007645
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 if (key_type_is_raw_bytes(type)) {
7647 status = psa_validate_unstructured_key_bit_size(type, bits);
7648 if (status != PSA_SUCCESS) {
7649 return status;
7650 }
7651 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007652#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7654 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7655 return PSA_ERROR_NOT_SUPPORTED;
7656 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007657 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007658 return PSA_ERROR_NOT_SUPPORTED;
7659 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007660
Ronald Cron01b2aba2020-10-05 09:42:02 +02007661 /* Accept only byte-aligned keys, for the same reasons as
7662 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007663 if (bits % 8 != 0) {
7664 return PSA_ERROR_NOT_SUPPORTED;
7665 }
7666 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007667#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007668
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007669#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007670 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007671 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007672 return PSA_SUCCESS;
7673 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007674#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007675
Valerio Settia55f0422023-07-10 15:34:41 +02007676#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007677 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007678 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007679 return PSA_ERROR_NOT_SUPPORTED;
7680 }
7681 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007682#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007683 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007685 }
7686
Gilles Peskine449bd832023-01-11 14:50:10 +01007687 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007688}
7689
Ronald Cron55ed0592020-10-05 10:30:40 +02007690psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007691 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007693{
7694 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007695 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007696
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 if ((attributes->domain_parameters == NULL) &&
7698 (attributes->domain_parameters_size != 0)) {
7699 return PSA_ERROR_INVALID_ARGUMENT;
7700 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007701
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 if (key_type_is_raw_bytes(type)) {
7703 status = psa_generate_random(key_buffer, key_buffer_size);
7704 if (status != PSA_SUCCESS) {
7705 return status;
7706 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007707
David Brown12ca5032021-02-11 11:02:00 -07007708#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 if (type == PSA_KEY_TYPE_DES) {
7710 psa_des_set_key_parity(key_buffer, key_buffer_size);
7711 }
David Brown8107e312021-02-12 08:08:46 -07007712#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007713 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007714
Valerio Setti76df8c12023-07-11 14:11:28 +02007715#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7717 return mbedtls_psa_rsa_generate_key(attributes,
7718 key_buffer,
7719 key_buffer_size,
7720 key_buffer_length);
7721 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007722#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007723
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007724#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7726 return mbedtls_psa_ecp_generate_key(attributes,
7727 key_buffer,
7728 key_buffer_size,
7729 key_buffer_length);
7730 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007731#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007732
Valerio Settia55f0422023-07-10 15:34:41 +02007733#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007734 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7735 return mbedtls_psa_ffdh_generate_key(attributes,
7736 key_buffer,
7737 key_buffer_size,
7738 key_buffer_length);
7739 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007740#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007741 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007742 (void) key_buffer_length;
7743 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007744 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007745
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007747}
Darryl Green0c6575a2018-11-07 16:05:30 +00007748
Gilles Peskine449bd832023-01-11 14:50:10 +01007749psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7750 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007751{
7752 psa_status_t status;
7753 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007754 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007755 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007756
Ronald Cron81709fc2020-11-14 12:10:32 +01007757 *key = MBEDTLS_SVC_KEY_ID_INIT;
7758
Gilles Peskine0f84d622019-09-12 19:03:13 +02007759 /* Reject any attempt to create a zero-length key so that we don't
7760 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007761 if (psa_get_key_bits(attributes) == 0) {
7762 return PSA_ERROR_INVALID_ARGUMENT;
7763 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007764
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007765 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7767 return PSA_ERROR_INVALID_ARGUMENT;
7768 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007769
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7771 &slot, &driver);
7772 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007773 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007774 }
Gilles Peskine11792082019-08-06 18:36:36 +02007775
Ronald Cron977c2472020-10-13 08:32:21 +02007776 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307777 * storage ( thus not in the case of generating a key in a secure element
7778 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7779 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007780 if (slot->key.data == NULL) {
7781 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7782 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007783 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 attributes->core.type, attributes->core.bits);
7785 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007786 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007788
7789 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 attributes->core.type,
7791 attributes->core.bits);
7792 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007793 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 attributes, &key_buffer_size);
7795 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007796 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007797 }
Ronald Cron977c2472020-10-13 08:32:21 +02007798 }
Ronald Cron977c2472020-10-13 08:32:21 +02007799
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7801 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007802 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 }
Ronald Cron977c2472020-10-13 08:32:21 +02007804 }
7805
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 status = psa_driver_wrapper_generate_key(attributes,
7807 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007808
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 if (status != PSA_SUCCESS) {
7810 psa_remove_key_data_from_memory(slot);
7811 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007812
Gilles Peskine11792082019-08-06 18:36:36 +02007813exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 if (status == PSA_SUCCESS) {
7815 status = psa_finish_key_creation(slot, driver, key);
7816 }
7817 if (status != PSA_SUCCESS) {
7818 psa_fail_key_creation(slot, driver);
7819 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007820
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007822}
7823
Gilles Peskinee59236f2018-01-27 23:32:46 +01007824/****************************************************************/
7825/* Module setup */
7826/****************************************************************/
7827
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007828#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007829psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007830 void (* entropy_init)(mbedtls_entropy_context *ctx),
7831 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007832{
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7834 return PSA_ERROR_BAD_STATE;
7835 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007836 global_data.rng.entropy_init = entropy_init;
7837 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007839}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007840#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007841
Gilles Peskine449bd832023-01-11 14:50:10 +01007842void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007843{
Gilles Peskine449bd832023-01-11 14:50:10 +01007844 psa_wipe_all_key_slots();
7845 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7846 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007847 }
7848 /* Wipe all remaining data, including configuration.
7849 * In particular, this sets all state indicator to the value
7850 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007852
7853 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007854 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007855}
7856
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007857#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7858/** Recover a transaction that was interrupted by a power failure.
7859 *
7860 * This function is called during initialization, before psa_crypto_init()
7861 * returns. If this function returns a failure status, the initialization
7862 * fails.
7863 */
7864static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007866{
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007868 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7869 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 /* TODO - fall through to the failure case until this
7871 * is implemented.
7872 * https://github.com/ARMmbed/mbed-crypto/issues/218
7873 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007874 default:
7875 /* We found an unsupported transaction in the storage.
7876 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007878 }
7879}
7880#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7881
Gilles Peskine449bd832023-01-11 14:50:10 +01007882psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007883{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007884 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007885
Gilles Peskinec6b69072018-11-20 21:42:52 +01007886 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 if (global_data.initialized != 0) {
7888 return PSA_SUCCESS;
7889 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007890
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007891 /* Init drivers */
7892 status = psa_driver_wrapper_init();
7893 if (status != PSA_SUCCESS) {
7894 goto exit;
7895 }
7896 global_data.drivers_initialized = 1;
7897
Gilles Peskine30524eb2020-11-13 17:02:26 +01007898 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007899 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007900 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 status = mbedtls_psa_random_seed(&global_data.rng);
7902 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007903 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007904 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007905 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007906
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 status = psa_initialize_key_slots();
7908 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01007909 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007911
Gilles Peskine4b734222019-07-24 15:56:31 +02007912#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 status = psa_crypto_load_transaction();
7914 if (status == PSA_SUCCESS) {
7915 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7916 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007917 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 }
7919 status = psa_crypto_stop_transaction();
7920 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007921 /* There's no transaction to complete. It's all good. */
7922 status = PSA_SUCCESS;
7923 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007924#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007925
Gilles Peskinec6b69072018-11-20 21:42:52 +01007926 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007927 global_data.initialized = 1;
7928
7929exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 if (status != PSA_SUCCESS) {
7931 mbedtls_psa_crypto_free();
7932 }
7933 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007934}
7935
Yanray Wangffc3c482023-07-11 12:01:04 +08007936#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007937psa_status_t psa_crypto_driver_pake_get_password_len(
7938 const psa_crypto_driver_pake_inputs_t *inputs,
7939 size_t *password_len)
7940{
7941 if (inputs->password_len == 0) {
7942 return PSA_ERROR_BAD_STATE;
7943 }
7944
7945 *password_len = inputs->password_len;
7946
7947 return PSA_SUCCESS;
7948}
7949
7950psa_status_t psa_crypto_driver_pake_get_password(
7951 const psa_crypto_driver_pake_inputs_t *inputs,
7952 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7953{
7954 if (inputs->password_len == 0) {
7955 return PSA_ERROR_BAD_STATE;
7956 }
7957
7958 if (buffer_size < inputs->password_len) {
7959 return PSA_ERROR_BUFFER_TOO_SMALL;
7960 }
7961
7962 memcpy(buffer, inputs->password, inputs->password_len);
7963 *buffer_length = inputs->password_len;
7964
7965 return PSA_SUCCESS;
7966}
7967
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007968psa_status_t psa_crypto_driver_pake_get_user_len(
7969 const psa_crypto_driver_pake_inputs_t *inputs,
7970 size_t *user_len)
7971{
7972 if (inputs->user_len == 0) {
7973 return PSA_ERROR_BAD_STATE;
7974 }
7975
7976 *user_len = inputs->user_len;
7977
7978 return PSA_SUCCESS;
7979}
7980
7981psa_status_t psa_crypto_driver_pake_get_user(
7982 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007983 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007984{
7985 if (inputs->user_len == 0) {
7986 return PSA_ERROR_BAD_STATE;
7987 }
7988
Przemek Stekielc0e62502023-03-14 11:49:36 +01007989 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007990 return PSA_ERROR_BUFFER_TOO_SMALL;
7991 }
7992
Przemek Stekielc0e62502023-03-14 11:49:36 +01007993 memcpy(user_id, inputs->user, inputs->user_len);
7994 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007995
7996 return PSA_SUCCESS;
7997}
7998
7999psa_status_t psa_crypto_driver_pake_get_peer_len(
8000 const psa_crypto_driver_pake_inputs_t *inputs,
8001 size_t *peer_len)
8002{
8003 if (inputs->peer_len == 0) {
8004 return PSA_ERROR_BAD_STATE;
8005 }
8006
8007 *peer_len = inputs->peer_len;
8008
8009 return PSA_SUCCESS;
8010}
8011
8012psa_status_t psa_crypto_driver_pake_get_peer(
8013 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008014 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008015{
8016 if (inputs->peer_len == 0) {
8017 return PSA_ERROR_BAD_STATE;
8018 }
8019
Przemek Stekielc0e62502023-03-14 11:49:36 +01008020 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008021 return PSA_ERROR_BUFFER_TOO_SMALL;
8022 }
8023
Przemek Stekielc0e62502023-03-14 11:49:36 +01008024 memcpy(peer_id, inputs->peer, inputs->peer_len);
8025 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008026
8027 return PSA_SUCCESS;
8028}
8029
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008030psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8031 const psa_crypto_driver_pake_inputs_t *inputs,
8032 psa_pake_cipher_suite_t *cipher_suite)
8033{
8034 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8035 return PSA_ERROR_BAD_STATE;
8036 }
8037
8038 *cipher_suite = inputs->cipher_suite;
8039
8040 return PSA_SUCCESS;
8041}
8042
Neil Armstronga7d08c32022-06-01 18:21:20 +02008043psa_status_t psa_pake_setup(
8044 psa_pake_operation_t *operation,
8045 const psa_pake_cipher_suite_t *cipher_suite)
8046{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008047 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008048
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008049 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008050 status = PSA_ERROR_BAD_STATE;
8051 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008052 }
8053
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008054 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008055 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008056 status = PSA_ERROR_INVALID_ARGUMENT;
8057 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008058 }
8059
Przemek Stekiel51eac532022-12-07 11:04:51 +01008060 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8061
Przemek Stekiele12ed362022-12-21 12:54:46 +01008062 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008063 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8064 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008065 operation->data.inputs.cipher_suite = *cipher_suite;
8066
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008067#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008068 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008069 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008070 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008071
David Horstmann16f01512023-06-14 17:21:07 +01008072 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008073 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008074 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008075#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008076 {
8077 status = PSA_ERROR_NOT_SUPPORTED;
8078 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008079 }
8080
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008081 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8082
Przemek Stekiel51eac532022-12-07 11:04:51 +01008083 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008084exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008085 psa_pake_abort(operation);
8086 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008087}
8088
8089psa_status_t psa_pake_set_password_key(
8090 psa_pake_operation_t *operation,
8091 mbedtls_svc_key_id_t password)
8092{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008093 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008094 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8095 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008096 psa_key_attributes_t attributes;
8097 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008098
Przemek Stekiel51eac532022-12-07 11:04:51 +01008099 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008100 status = PSA_ERROR_BAD_STATE;
8101 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008102 }
8103
Przemek Stekiel6c764412022-11-22 14:05:12 +01008104 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8105 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008106 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008107 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008108 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008109 }
8110
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008111 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008112 .core = slot->attr
8113 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008114
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008115 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008116
Przemek Stekiel51eac532022-12-07 11:04:51 +01008117 if (type != PSA_KEY_TYPE_PASSWORD &&
8118 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8119 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008120 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008121 }
8122
Przemek Stekiel51eac532022-12-07 11:04:51 +01008123 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8124 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008125 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008126 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008127 }
8128
8129 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8130 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008131 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008132exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008133 if (status != PSA_SUCCESS) {
8134 psa_pake_abort(operation);
8135 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008136 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008137 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008138}
8139
8140psa_status_t psa_pake_set_user(
8141 psa_pake_operation_t *operation,
8142 const uint8_t *user_id,
8143 size_t user_id_len)
8144{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008145 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008146
8147 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008148 status = PSA_ERROR_BAD_STATE;
8149 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008150 }
8151
Przemek Stekiel51eac532022-12-07 11:04:51 +01008152 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008153 status = PSA_ERROR_INVALID_ARGUMENT;
8154 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008155 }
8156
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008157 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008158 status = PSA_ERROR_BAD_STATE;
8159 goto exit;
8160 }
8161
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008162 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8163 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008164 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8165 goto exit;
8166 }
8167
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008168 memcpy(operation->data.inputs.user, user_id, user_id_len);
8169 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008170
8171 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008172exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008173 psa_pake_abort(operation);
8174 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008175}
8176
8177psa_status_t psa_pake_set_peer(
8178 psa_pake_operation_t *operation,
8179 const uint8_t *peer_id,
8180 size_t peer_id_len)
8181{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008183
8184 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008185 status = PSA_ERROR_BAD_STATE;
8186 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008187 }
8188
Przemek Stekiel51eac532022-12-07 11:04:51 +01008189 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008190 status = PSA_ERROR_INVALID_ARGUMENT;
8191 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008192 }
8193
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008194 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008195 status = PSA_ERROR_BAD_STATE;
8196 goto exit;
8197 }
8198
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008199 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8200 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008201 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8202 goto exit;
8203 }
8204
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008205 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8206 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008207
8208 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008209exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008210 psa_pake_abort(operation);
8211 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008212}
8213
8214psa_status_t psa_pake_set_role(
8215 psa_pake_operation_t *operation,
8216 psa_pake_role_t role)
8217{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008218 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008219
Przemek Stekiel51eac532022-12-07 11:04:51 +01008220 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008221 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008222 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008223 }
8224
Przemek Stekiel09104b82023-03-06 14:11:51 +01008225 switch (operation->alg) {
8226#if defined(PSA_WANT_ALG_JPAKE)
8227 case PSA_ALG_JPAKE:
8228 if (role == PSA_PAKE_ROLE_NONE) {
8229 return PSA_SUCCESS;
8230 }
8231 status = PSA_ERROR_INVALID_ARGUMENT;
8232 break;
8233#endif
8234 default:
8235 (void) role;
8236 status = PSA_ERROR_NOT_SUPPORTED;
8237 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008238 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008239exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008240 psa_pake_abort(operation);
8241 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008242}
8243
David Horstmanne7f21e62023-05-12 18:17:21 +01008244/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008245#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008246static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008247 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008248{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008249 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008250 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008251 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008252
David Horstmann024e5c52023-06-14 15:48:21 +01008253 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008254 is_x1 = (stage->outputs < 1);
8255 } else {
8256 is_x1 = (stage->inputs < 1);
8257 }
8258
David Horstmann74a3d8c2023-06-14 18:28:19 +01008259 key_share_step = is_x1 ?
8260 PSA_JPAKE_X1_STEP_KEY_SHARE :
8261 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008262 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008263 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8264 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8265 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8266 } else {
8267 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008268 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008269 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008270}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008271#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008272
Przemek Stekiel2797d372022-12-22 11:19:22 +01008273static psa_status_t psa_pake_complete_inputs(
8274 psa_pake_operation_t *operation)
8275{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008276 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008277 /* Create copy of the inputs on stack as inputs share memory
8278 with the driver context which will be setup by the driver. */
8279 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008280
Przemek Stekielfde11282023-03-13 16:06:09 +01008281 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008282 return PSA_ERROR_BAD_STATE;
8283 }
8284
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008285 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008286 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8287 return PSA_ERROR_BAD_STATE;
8288 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008289 }
8290
Przemek Stekiel18620a32023-01-17 16:34:52 +01008291 /* Clear driver context */
8292 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8293
8294 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008295
8296 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008297 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008298
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008299 /* User and peer are translated to role. */
8300 mbedtls_free(inputs.user);
8301 mbedtls_free(inputs.peer);
8302
Przemek Stekiel2797d372022-12-22 11:19:22 +01008303 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008304#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008305 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008306 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008307 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008308#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008309 {
8310 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008311 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008312 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008313 return status;
8314}
8315
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008316#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008317static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008318 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008319 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008320 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008321{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008322 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8323 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8324 step != PSA_PAKE_STEP_ZK_PROOF) {
8325 return PSA_ERROR_INVALID_ARGUMENT;
8326 }
8327
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008328 psa_jpake_computation_stage_t *computation_stage =
8329 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008330
David Horstmann5da95602023-06-08 15:37:12 +01008331 if (computation_stage->round != PSA_JPAKE_FIRST &&
8332 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008333 return PSA_ERROR_BAD_STATE;
8334 }
8335
David Horstmanne7f21e62023-05-12 18:17:21 +01008336 /* Check that the step we are given is the one we were expecting */
8337 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008338 return PSA_ERROR_BAD_STATE;
8339 }
8340
David Horstmanne7f21e62023-05-12 18:17:21 +01008341 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8342 computation_stage->inputs == 0 &&
8343 computation_stage->outputs == 0) {
8344 /* Start of the round, so function decides whether we are inputting
8345 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008346 computation_stage->io_mode = io_mode;
8347 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008348 /* Middle of the round so the mode we are in must match the function
8349 * called by the user */
8350 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008351 }
8352
8353 return PSA_SUCCESS;
8354}
8355
David Horstmanne7f21e62023-05-12 18:17:21 +01008356static psa_status_t psa_jpake_epilogue(
8357 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008358 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008359{
David Horstmanne7f21e62023-05-12 18:17:21 +01008360 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008361 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008362
David Horstmanne7f21e62023-05-12 18:17:21 +01008363 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8364 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008365 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008366 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008367 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008368 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008369 }
8370 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008371 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008372 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008373 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008374 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008375 }
8376 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008377 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8378 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008379 /* End of a round, move to the next round */
8380 stage->inputs = 0;
8381 stage->outputs = 0;
8382 stage->round++;
8383 }
8384 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008385 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008386 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008387 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008388 return PSA_SUCCESS;
8389}
David Horstmanne7f21e62023-05-12 18:17:21 +01008390
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008391#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008392
Neil Armstronga7d08c32022-06-01 18:21:20 +02008393psa_status_t psa_pake_output(
8394 psa_pake_operation_t *operation,
8395 psa_pake_step_t step,
8396 uint8_t *output,
8397 size_t output_size,
8398 size_t *output_length)
8399{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008400 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008401 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008402 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008403
8404 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008405 status = psa_pake_complete_inputs(operation);
8406 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008407 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008408 }
8409 }
8410
8411 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008412 status = PSA_ERROR_BAD_STATE;
8413 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008414 }
8415
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008416 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008417 status = PSA_ERROR_INVALID_ARGUMENT;
8418 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008419 }
8420
Przemek Stekiele12ed362022-12-21 12:54:46 +01008421 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008422#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008423 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008424 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008425 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008426 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008427 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008428 driver_step = convert_jpake_computation_stage_to_driver_step(
8429 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008430 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008431#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008432 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008433 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008434 status = PSA_ERROR_NOT_SUPPORTED;
8435 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008436 }
8437
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008438 status = psa_driver_wrapper_pake_output(operation, driver_step,
8439 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008440
8441 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008442 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008443 }
8444
8445 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008446#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008447 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008448 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008449 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008450 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008451 }
8452 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008453#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008454 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008455 status = PSA_ERROR_NOT_SUPPORTED;
8456 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008457 }
8458
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008459 return PSA_SUCCESS;
8460exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008461 psa_pake_abort(operation);
8462 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008463}
8464
8465psa_status_t psa_pake_input(
8466 psa_pake_operation_t *operation,
8467 psa_pake_step_t step,
8468 const uint8_t *input,
8469 size_t input_length)
8470{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008471 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008472 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008473 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8474 operation->primitive,
8475 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008476
8477 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008478 status = psa_pake_complete_inputs(operation);
8479 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008480 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008481 }
8482 }
8483
8484 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008485 status = PSA_ERROR_BAD_STATE;
8486 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008487 }
8488
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008489 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008490 status = PSA_ERROR_INVALID_ARGUMENT;
8491 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008492 }
8493
Przemek Stekiele12ed362022-12-21 12:54:46 +01008494 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008495#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008496 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008497 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008498 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008499 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008500 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008501 driver_step = convert_jpake_computation_stage_to_driver_step(
8502 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008503 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008504#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008505 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008506 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008507 status = PSA_ERROR_NOT_SUPPORTED;
8508 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008509 }
8510
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008511 status = psa_driver_wrapper_pake_input(operation, driver_step,
8512 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008513
8514 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008515 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008516 }
8517
8518 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008519#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008520 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008521 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008522 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008523 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008524 }
8525 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008526#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008527 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008528 status = PSA_ERROR_NOT_SUPPORTED;
8529 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008530 }
8531
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008532 return PSA_SUCCESS;
8533exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008534 psa_pake_abort(operation);
8535 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008536}
8537
8538psa_status_t psa_pake_get_implicit_key(
8539 psa_pake_operation_t *operation,
8540 psa_key_derivation_operation_t *output)
8541{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008542 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008543 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008544 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008545 size_t shared_key_len = 0;
8546
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008547 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008548 status = PSA_ERROR_BAD_STATE;
8549 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008550 }
8551
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008552#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008553 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008554 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008555 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008556 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008557 status = PSA_ERROR_BAD_STATE;
8558 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008559 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008560 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008561#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008562 {
8563 status = PSA_ERROR_NOT_SUPPORTED;
8564 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008565 }
8566
Przemek Stekiel0c781802022-11-29 14:53:13 +01008567 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8568 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008569 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008570 &shared_key_len);
8571
8572 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008573 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008574 }
8575
8576 status = psa_key_derivation_input_bytes(output,
8577 PSA_KEY_DERIVATION_INPUT_SECRET,
8578 shared_key,
8579 shared_key_len);
8580
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008581 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008582exit:
8583 abort_status = psa_pake_abort(operation);
8584 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008585}
8586
8587psa_status_t psa_pake_abort(
8588 psa_pake_operation_t *operation)
8589{
Przemek Stekield69dca92023-01-31 19:59:20 +01008590 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008591
Przemek Stekield69dca92023-01-31 19:59:20 +01008592 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008593 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008594 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008595
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008596 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8597 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008598 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008599 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008600 }
8601 if (operation->data.inputs.user != NULL) {
8602 mbedtls_free(operation->data.inputs.user);
8603 }
8604 if (operation->data.inputs.peer != NULL) {
8605 mbedtls_free(operation->data.inputs.peer);
8606 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008607 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008608 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008609
Przemek Stekield69dca92023-01-31 19:59:20 +01008610 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008611}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008612#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008613
David Horstmann00d7a042023-12-07 18:39:17 +00008614/* Memory copying test hooks. These are called before input copy, after input
8615 * copy, before output copy and after output copy, respectively.
8616 * They are used by memory-poisoning tests to temporarily unpoison buffers
8617 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008618#if defined(MBEDTLS_TEST_HOOKS)
8619void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8620void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8621void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8622void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8623#endif
David Horstmannfde97392023-10-30 20:29:43 +00008624
David Horstmann1b7279a2023-11-15 15:18:30 +00008625/** Copy from an input buffer to a local copy.
8626 *
8627 * \param[in] input Pointer to input buffer.
8628 * \param[in] input_len Length of the input buffer.
8629 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8630 * \param[out] input_copy_len Length of the local copy buffer.
8631 * \return #PSA_SUCCESS, if the buffer was successfully
8632 * copied.
8633 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8634 * copy is too small to hold contents of the
8635 * input buffer.
8636 */
8637MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008638psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8639 uint8_t *input_copy, size_t input_copy_len)
8640{
8641 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008642 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008643 }
8644
David Horstmann372b8bb2023-11-24 16:21:04 +00008645#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008646 if (psa_input_pre_copy_hook != NULL) {
8647 psa_input_pre_copy_hook(input, input_len);
8648 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008649#endif
8650
David Horstmann777e7412023-11-15 17:33:47 +00008651 if (input_len > 0) {
8652 memcpy(input_copy, input, input_len);
8653 }
David Horstmannfde97392023-10-30 20:29:43 +00008654
David Horstmann372b8bb2023-11-24 16:21:04 +00008655#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008656 if (psa_input_post_copy_hook != NULL) {
8657 psa_input_post_copy_hook(input, input_len);
8658 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008659#endif
8660
David Horstmannfde97392023-10-30 20:29:43 +00008661 return PSA_SUCCESS;
8662}
8663
David Horstmann1b7279a2023-11-15 15:18:30 +00008664/** Copy from a local output buffer into a user-supplied one.
8665 *
8666 * \param[in] output_copy Pointer to a local buffer containing the output.
8667 * \param[in] output_copy_len Length of the local buffer.
8668 * \param[out] output Pointer to user-supplied output buffer.
8669 * \param[out] output_len Length of the user-supplied output buffer.
8670 * \return #PSA_SUCCESS, if the buffer was successfully
8671 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008672 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008673 * user-supplied output buffer is too small to
8674 * hold the contents of the local buffer.
8675 */
8676MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008677psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8678 uint8_t *output, size_t output_len)
8679{
8680 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008681 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008682 }
David Horstmann777e7412023-11-15 17:33:47 +00008683
David Horstmann372b8bb2023-11-24 16:21:04 +00008684#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008685 if (psa_output_pre_copy_hook != NULL) {
8686 psa_output_pre_copy_hook(output, output_len);
8687 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008688#endif
8689
David Horstmann777e7412023-11-15 17:33:47 +00008690 if (output_copy_len > 0) {
8691 memcpy(output, output_copy, output_copy_len);
8692 }
8693
David Horstmann372b8bb2023-11-24 16:21:04 +00008694#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008695 if (psa_output_post_copy_hook != NULL) {
8696 psa_output_post_copy_hook(output, output_len);
8697 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008698#endif
8699
David Horstmann8978f5c2023-10-30 20:37:12 +00008700 return PSA_SUCCESS;
8701}
8702
David Horstmannf1734052023-11-20 17:15:32 +00008703psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8704 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008705{
8706 psa_status_t status;
8707
David Horstmann9db14482023-11-23 15:50:37 +00008708 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008709
David Horstmannc5cc1c32023-11-15 18:11:26 +00008710 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008711 return PSA_SUCCESS;
8712 }
8713
David Horstmannf1734052023-11-20 17:15:32 +00008714 local_input->buffer = mbedtls_calloc(input_len, 1);
8715 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008716 /* Since we dealt with the zero-length case above, we know that
8717 * a NULL return value means a failure of allocation. */
8718 return PSA_ERROR_INSUFFICIENT_MEMORY;
8719 }
David Horstmannf1734052023-11-20 17:15:32 +00008720 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008721
David Horstmannf1734052023-11-20 17:15:32 +00008722 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008723
8724 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008725 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008726 if (status != PSA_SUCCESS) {
8727 goto error;
8728 }
8729
8730 return PSA_SUCCESS;
8731
8732error:
David Horstmannf1734052023-11-20 17:15:32 +00008733 mbedtls_free(local_input->buffer);
8734 local_input->buffer = NULL;
8735 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008736 return status;
8737}
8738
David Horstmannf1734052023-11-20 17:15:32 +00008739void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008740{
David Horstmannf1734052023-11-20 17:15:32 +00008741 mbedtls_free(local_input->buffer);
8742 local_input->buffer = NULL;
8743 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008744}
8745
David Horstmann89875a42023-11-20 12:54:09 +00008746psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8747 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008748{
David Horstmann9db14482023-11-23 15:50:37 +00008749 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008750
David Horstmannc5cc1c32023-11-15 18:11:26 +00008751 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008752 return PSA_SUCCESS;
8753 }
David Horstmann89875a42023-11-20 12:54:09 +00008754 local_output->buffer = mbedtls_calloc(output_len, 1);
8755 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008756 /* Since we dealt with the zero-length case above, we know that
8757 * a NULL return value means a failure of allocation. */
8758 return PSA_ERROR_INSUFFICIENT_MEMORY;
8759 }
David Horstmann89875a42023-11-20 12:54:09 +00008760 local_output->length = output_len;
8761 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008762
8763 return PSA_SUCCESS;
8764}
8765
Gabor Mezei1882c512024-01-24 13:07:17 +01008766psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8767 psa_crypto_local_output_t *local_output)
8768{
8769 psa_status_t status;
8770 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8771
8772 if (output_len == 0) {
8773 return PSA_SUCCESS;
8774 }
8775 local_output->buffer = mbedtls_calloc(output_len, 1);
8776 if (local_output->buffer == NULL) {
8777 /* Since we dealt with the zero-length case above, we know that
8778 * a NULL return value means a failure of allocation. */
8779 return PSA_ERROR_INSUFFICIENT_MEMORY;
8780 }
8781 local_output->length = output_len;
8782 local_output->original = output;
8783
8784 status = psa_crypto_copy_input(output, output_len,
8785 local_output->buffer, local_output->length);
8786 if (status != PSA_SUCCESS) {
8787 goto error;
8788 }
8789
8790 return PSA_SUCCESS;
8791
8792error:
8793 mbedtls_free(local_output->buffer);
8794 local_output->buffer = NULL;
8795 local_output->length = 0;
8796 return status;
8797}
8798
David Horstmann89875a42023-11-20 12:54:09 +00008799psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008800{
David Horstmannc335a4e2023-11-15 15:57:32 +00008801 psa_status_t status;
8802
David Horstmann89875a42023-11-20 12:54:09 +00008803 if (local_output->buffer == NULL) {
8804 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008805 return PSA_SUCCESS;
8806 }
David Horstmann89875a42023-11-20 12:54:09 +00008807 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008808 /* We have an internal copy but nothing to copy back to. */
8809 return PSA_ERROR_CORRUPTION_DETECTED;
8810 }
8811
David Horstmann89875a42023-11-20 12:54:09 +00008812 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8813 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008814 if (status != PSA_SUCCESS) {
8815 return status;
8816 }
David Horstmann9467ea32023-11-08 17:44:18 +00008817
David Horstmann89875a42023-11-20 12:54:09 +00008818 mbedtls_free(local_output->buffer);
8819 local_output->buffer = NULL;
8820 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008821
8822 return PSA_SUCCESS;
8823}
8824
Gilles Peskinee59236f2018-01-27 23:32:46 +01008825#endif /* MBEDTLS_PSA_CRYPTO_C */