blob: cc7dc09d60d3d34570851e6745c62bce20e5e973 [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,
Ryan Everettf028fe12024-01-08 17:14:44 +00002202 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 size_t data_length,
2204 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002205{
2206 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002207 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002208 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002209 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002210 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302211 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002212
Ronald Cron81709fc2020-11-14 12:10:32 +01002213 *key = MBEDTLS_SVC_KEY_ID_INIT;
2214
Gilles Peskine0f84d622019-09-12 19:03:13 +02002215 /* Reject zero-length symmetric keys (including raw data key objects).
2216 * This also rejects any key which might be encoded as an empty string,
2217 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 if (data_length == 0) {
2219 return PSA_ERROR_INVALID_ARGUMENT;
2220 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002221
Archana449608b2021-09-08 15:36:05 +05302222 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 if (data_length > SIZE_MAX / 8) {
2224 return PSA_ERROR_NOT_SUPPORTED;
2225 }
Archana6ed4bda2021-08-04 10:47:15 +05302226
Ryan Everettf028fe12024-01-08 17:14:44 +00002227 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2230 &slot, &driver);
2231 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002232 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002234
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002235 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302236 * storage ( thus not in the case of importing a key in a secure element
2237 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2238 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (slot->key.data == NULL) {
2240 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302241 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 attributes, data, data_length, &storage_size);
2243 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302244 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 }
Archanad8a83dc2021-06-14 10:04:16 +05302246 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 status = psa_allocate_buffer_to_slot(slot, storage_size);
2248 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002249 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002251 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002252
2253 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 status = psa_driver_wrapper_import_key(attributes,
2255 data, data_length,
2256 slot->key.data,
2257 slot->key.bytes,
2258 &slot->key.bytes, &bits);
2259 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002260 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002262
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002264 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002266 status = PSA_ERROR_INVALID_ARGUMENT;
2267 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002268 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002269
Archana6ed4bda2021-08-04 10:47:15 +05302270 /* Enforce a size limit, and in particular ensure that the bit
2271 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302273 status = PSA_ERROR_NOT_SUPPORTED;
2274 goto exit;
2275 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 status = psa_validate_optional_attributes(slot, attributes);
2277 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002278 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002280
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002282exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002283 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 if (status != PSA_SUCCESS) {
2285 psa_fail_key_creation(slot, driver);
2286 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002289}
2290
Gilles Peskined7729582019-08-05 15:55:54 +02002291#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2292psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002294{
2295 psa_status_t status;
2296 psa_key_slot_t *slot = NULL;
2297 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002298 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002299
2300 /* Leaving attributes unspecified is not currently supported.
2301 * It could make sense to query the key type and size from the
2302 * secure element, but not all secure elements support this
2303 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2305 return PSA_ERROR_NOT_SUPPORTED;
2306 }
2307 if (psa_get_key_bits(attributes) == 0) {
2308 return PSA_ERROR_NOT_SUPPORTED;
2309 }
Gilles Peskined7729582019-08-05 15:55:54 +02002310
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2312 &slot, &driver);
2313 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002314 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 }
Gilles Peskined7729582019-08-05 15:55:54 +02002316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002318
2319exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if (status != PSA_SUCCESS) {
2321 psa_fail_key_creation(slot, driver);
2322 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002323
Gilles Peskined7729582019-08-05 15:55:54 +02002324 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 psa_close_key(key);
2326 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002327}
2328#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2329
Gilles Peskine449bd832023-01-11 14:50:10 +01002330psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2331 const psa_key_attributes_t *specified_attributes,
2332 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002333{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002334 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002335 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002336 psa_key_slot_t *source_slot = NULL;
2337 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002338 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002339 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302340 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002341
Ronald Cron81709fc2020-11-14 12:10:32 +01002342 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2343
Archana8a180362021-07-05 02:18:48 +05302344 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2346 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002347 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002349
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 status = psa_validate_optional_attributes(source_slot,
2351 specified_attributes);
2352 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002353 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002355
Archana9d17bf42021-09-10 06:22:44 +05302356 /* The target key type and number of bits have been validated by
2357 * psa_validate_optional_attributes() to be either equal to zero or
2358 * equal to the ones of the source key. So it is safe to inherit
2359 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302360 * */
Archana9d17bf42021-09-10 06:22:44 +05302361 actual_attributes.core.bits = source_slot->attr.bits;
2362 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302363
2364
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 status = psa_restrict_key_policy(source_slot->attr.type,
2366 &actual_attributes.core.policy,
2367 &source_slot->attr.policy);
2368 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002369 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002371
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2373 &target_slot, &driver);
2374 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002375 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 }
2377 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2378 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302379 /*
Archana9d17bf42021-09-10 06:22:44 +05302380 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302381 * the source key would need to be exported as plaintext and re-imported
2382 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302383 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302384 * appropriate API invocations from the application, if needed.
2385 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002386 status = PSA_ERROR_NOT_SUPPORTED;
2387 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002388 }
Archana8a180362021-07-05 02:18:48 +05302389 /*
2390 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302391 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302392 * - For opaque keys this translates to an invocation of the drivers'
2393 * copy_key entry point through the dispatch layer.
2394 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2396 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2397 &storage_size);
2398 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302399 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 }
Archana374fe5b2021-09-08 15:50:28 +05302401
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2403 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302404 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 }
Archana374fe5b2021-09-08 15:50:28 +05302406
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 status = psa_driver_wrapper_copy_key(&actual_attributes,
2408 source_slot->key.data,
2409 source_slot->key.bytes,
2410 target_slot->key.data,
2411 target_slot->key.bytes,
2412 &target_slot->key.bytes);
2413 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302414 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 }
2416 } else {
2417 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302418 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 source_slot->key.bytes);
2420 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302421 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 }
Archana8a180362021-07-05 02:18:48 +05302423 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002425exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (status != PSA_SUCCESS) {
2427 psa_fail_key_creation(target_slot, driver);
2428 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002429
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002431
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002433}
2434
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002435
2436
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002437/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002438/* Message digests */
2439/****************************************************************/
2440
Gilles Peskine449bd832023-01-11 14:50:10 +01002441psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002442{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002443 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 if (operation->id == 0) {
2445 return PSA_SUCCESS;
2446 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002447
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002449 operation->id = 0;
2450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002452}
2453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2455 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002456{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002457 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002458
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002459 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002460 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002461 status = PSA_ERROR_BAD_STATE;
2462 goto exit;
2463 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002466 status = PSA_ERROR_INVALID_ARGUMENT;
2467 goto exit;
2468 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002469
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002470 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2471 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002473
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002475
2476exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 if (status != PSA_SUCCESS) {
2478 psa_hash_abort(operation);
2479 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002480
2481 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002482}
2483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2485 const uint8_t *input,
2486 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002487{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002488 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2489
Gilles Peskine449bd832023-01-11 14:50:10 +01002490 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002491 status = PSA_ERROR_BAD_STATE;
2492 goto exit;
2493 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002494
Steven Cooremanc8288352021-03-04 14:02:19 +01002495 /* Don't require hash implementations to behave correctly on a
2496 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 if (input_length == 0) {
2498 return PSA_SUCCESS;
2499 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002500
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002502
2503exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 if (status != PSA_SUCCESS) {
2505 psa_hash_abort(operation);
2506 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002507
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002509}
2510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2512 uint8_t *hash,
2513 size_t hash_size,
2514 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002515{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002516 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 if (operation->id == 0) {
2518 return PSA_ERROR_BAD_STATE;
2519 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002520
Steven Cooreman1e582352021-02-18 17:24:37 +01002521 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 operation, hash, hash_size, hash_length);
2523 psa_hash_abort(operation);
2524 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002525}
2526
Gilles Peskine449bd832023-01-11 14:50:10 +01002527psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2528 const uint8_t *hash,
2529 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002530{
Ronald Cron69a63422021-10-18 09:47:58 +02002531 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002532 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002533 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 operation,
2535 actual_hash, sizeof(actual_hash),
2536 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002537
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002539 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002541
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002543 status = PSA_ERROR_INVALID_SIGNATURE;
2544 goto exit;
2545 }
2546
Dave Rodgman78701152023-08-29 14:20:18 +01002547 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002548 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002550
2551exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2553 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002554 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002558}
2559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560psa_status_t psa_hash_compute(psa_algorithm_t alg,
2561 const uint8_t *input, size_t input_length,
2562 uint8_t *hash, size_t hash_size,
2563 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002564{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002565 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 if (!PSA_ALG_IS_HASH(alg)) {
2567 return PSA_ERROR_INVALID_ARGUMENT;
2568 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2571 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002572}
2573
Gilles Peskine449bd832023-01-11 14:50:10 +01002574psa_status_t psa_hash_compare(psa_algorithm_t alg,
2575 const uint8_t *input, size_t input_length,
2576 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002577{
Ronald Cron69a63422021-10-18 09:47:58 +02002578 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002579 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 if (!PSA_ALG_IS_HASH(alg)) {
2582 return PSA_ERROR_INVALID_ARGUMENT;
2583 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002584
Steven Cooreman1e582352021-02-18 17:24:37 +01002585 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 alg, input, input_length,
2587 actual_hash, sizeof(actual_hash),
2588 &actual_hash_length);
2589 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002590 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 }
2592 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002593 status = PSA_ERROR_INVALID_SIGNATURE;
2594 goto exit;
2595 }
Dave Rodgman78701152023-08-29 14:20:18 +01002596 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002597 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002599
2600exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2602 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002603}
2604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2606 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002607{
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 if (source_operation->id == 0 ||
2609 target_operation->id != 0) {
2610 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002611 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2614 target_operation);
2615 if (status != PSA_SUCCESS) {
2616 psa_hash_abort(target_operation);
2617 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002618
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002620}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002621
2622
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002623/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002624/* MAC */
2625/****************************************************************/
2626
Gilles Peskine449bd832023-01-11 14:50:10 +01002627psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002628{
Steven Cooremane6804192021-03-19 18:28:56 +01002629 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (operation->id == 0) {
2631 return PSA_SUCCESS;
2632 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002633
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002635 operation->mac_size = 0;
2636 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002637 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002638
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002640}
2641
Ronald Cron2dff3b22021-06-17 16:33:22 +02002642static psa_status_t psa_mac_finalize_alg_and_key_validation(
2643 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002644 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002646{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002647 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 psa_key_type_t key_type = psa_get_key_type(attributes);
2649 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (!PSA_ALG_IS_MAC(alg)) {
2652 return PSA_ERROR_INVALID_ARGUMENT;
2653 }
Steven Cooremane6804192021-03-19 18:28:56 +01002654
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002655 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 status = psa_mac_key_can_do(alg, key_type);
2657 if (status != PSA_SUCCESS) {
2658 return status;
2659 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002660
Steven Cooremand1a68f12021-05-10 11:13:41 +02002661 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002665 /* A very short MAC is too short for security since it can be
2666 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2667 * so we make this our minimum, even though 32 bits is still
2668 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002670 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2673 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002674 /* It's impossible to "truncate" to a larger length than the full length
2675 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002677 }
2678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002680 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2681 * that is disabled in the compile-time configuration. The result can
2682 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2683 * configuration into account. In this case, force a return of
2684 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2685 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2686 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2687 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2688 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002690 }
2691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002693}
2694
Gilles Peskine449bd832023-01-11 14:50:10 +01002695static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2696 mbedtls_svc_key_id_t key,
2697 psa_algorithm_t alg,
2698 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002699{
2700 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2701 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002702 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002703 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002704
2705 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002707 status = PSA_ERROR_BAD_STATE;
2708 goto exit;
2709 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002710
2711 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 key,
2713 &slot,
2714 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2715 alg);
2716 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002717 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002719
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002720 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002721 .core = slot->attr
2722 };
2723
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2725 &operation->mac_size);
2726 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002727 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002729
2730 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002731 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 if (is_sign) {
2733 status = psa_driver_wrapper_mac_sign_setup(operation,
2734 &attributes,
2735 slot->key.data,
2736 slot->key.bytes,
2737 alg);
2738 } else {
2739 status = psa_driver_wrapper_mac_verify_setup(operation,
2740 &attributes,
2741 slot->key.data,
2742 slot->key.bytes,
2743 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002744 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002745
Gilles Peskinefbfac682018-07-08 20:51:54 +02002746exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 if (status != PSA_SUCCESS) {
2748 psa_mac_abort(operation);
2749 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002750
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002752
Gilles Peskine449bd832023-01-11 14:50:10 +01002753 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002754}
2755
Gilles Peskine449bd832023-01-11 14:50:10 +01002756psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2757 mbedtls_svc_key_id_t key,
2758 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002759{
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002761}
2762
Gilles Peskine449bd832023-01-11 14:50:10 +01002763psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2764 mbedtls_svc_key_id_t key,
2765 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002766{
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002768}
2769
Gilles Peskine449bd832023-01-11 14:50:10 +01002770psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2771 const uint8_t *input,
2772 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002773{
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 if (operation->id == 0) {
2775 return PSA_ERROR_BAD_STATE;
2776 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002777
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002778 /* Don't require hash implementations to behave correctly on a
2779 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 if (input_length == 0) {
2781 return PSA_SUCCESS;
2782 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002783
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2785 input, input_length);
2786 if (status != PSA_SUCCESS) {
2787 psa_mac_abort(operation);
2788 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002791}
2792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2794 uint8_t *mac,
2795 size_t mac_size,
2796 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002797{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002798 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2799 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002802 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002803 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002804 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002807 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002808 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002809 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002810
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002811 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2812 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002814 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002815 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002816 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002817
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002819 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002820 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002821 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002822
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 status = psa_driver_wrapper_mac_sign_finish(operation,
2824 mac, operation->mac_size,
2825 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002826
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002827exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002828 /* In case of success, set the potential excess room in the output buffer
2829 * to an invalid value, to avoid potentially leaking a longer MAC.
2830 * In case of error, set the output length and content to a safe default,
2831 * such that in case the caller misses an error check, the output would be
2832 * an unachievable MAC.
2833 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002835 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002836 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002837 }
mohammad16036df908f2018-04-02 08:34:15 -07002838
Paul Elliottdc42ca82023-02-24 18:11:59 +00002839 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002840
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002842
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002844}
2845
Gilles Peskine449bd832023-01-11 14:50:10 +01002846psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2847 const uint8_t *mac,
2848 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002849{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002850 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2851 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002852
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002854 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002855 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002856 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002859 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002860 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002861 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002864 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002865 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002866 }
2867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 status = psa_driver_wrapper_mac_verify_finish(operation,
2869 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002870
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002871exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002875}
2876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2878 psa_algorithm_t alg,
2879 const uint8_t *input,
2880 size_t input_length,
2881 uint8_t *mac,
2882 size_t mac_size,
2883 size_t *mac_length,
2884 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002885{
2886 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002887 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2888 psa_key_slot_t *slot;
2889 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002890 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002891
Ronald Cron51131b52021-06-17 17:17:20 +02002892 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 key,
2894 &slot,
2895 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2896 alg);
2897 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002898 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002900
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002901 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002902 .core = slot->attr
2903 };
2904
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2906 &operation_mac_size);
2907 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002908 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002912 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002913 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002914 }
2915
2916 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 &attributes,
2918 slot->key.data, slot->key.bytes,
2919 alg,
2920 input, input_length,
2921 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002922
2923exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002924 /* In case of success, set the potential excess room in the output buffer
2925 * to an invalid value, to avoid potentially leaking a longer MAC.
2926 * In case of error, set the output length and content to a safe default,
2927 * such that in case the caller misses an error check, the output would be
2928 * an unachievable MAC.
2929 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002931 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002932 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002933 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002934
2935 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002938
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002940}
2941
Gilles Peskine449bd832023-01-11 14:50:10 +01002942psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002943 psa_algorithm_t alg,
2944 const uint8_t *input,
2945 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002946 uint8_t *mac,
2947 size_t mac_size,
2948 size_t *mac_length)
2949{
2950 return psa_mac_compute_internal(key, alg,
2951 input, input_length,
2952 mac, mac_size, mac_length, 1);
2953}
2954
2955psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2956 psa_algorithm_t alg,
2957 const uint8_t *input,
2958 size_t input_length,
2959 const uint8_t *mac,
2960 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002961{
2962 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002963 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2964 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002965
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 status = psa_mac_compute_internal(key, alg,
2967 input, input_length,
2968 actual_mac, sizeof(actual_mac),
2969 &actual_mac_length, 0);
2970 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002971 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002973
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 if (mac_length != actual_mac_length) {
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 }
Dave Rodgman78701152023-08-29 14:20:18 +01002978 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002979 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002980 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002981 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002982
2983exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002987}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002988
Gilles Peskinee59236f2018-01-27 23:32:46 +01002989/****************************************************************/
2990/* Asymmetric cryptography */
2991/****************************************************************/
2992
Gilles Peskine449bd832023-01-11 14:50:10 +01002993static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2994 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002995{
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 if (input_is_message) {
2997 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2998 return PSA_ERROR_INVALID_ARGUMENT;
2999 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003000
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 if (PSA_ALG_IS_SIGN_HASH(alg)) {
3002 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
3003 return PSA_ERROR_INVALID_ARGUMENT;
3004 }
3005 }
3006 } else {
3007 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
3008 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003009 }
3010 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003011
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003013}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003014
Gilles Peskine449bd832023-01-11 14:50:10 +01003015static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
3016 int input_is_message,
3017 psa_algorithm_t alg,
3018 const uint8_t *input,
3019 size_t input_length,
3020 uint8_t *signature,
3021 size_t signature_size,
3022 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003023{
3024 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3025 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3026 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003027 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003028
3029 *signature_length = 0;
3030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 status = psa_sign_verify_check_alg(input_is_message, alg);
3032 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003033 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003035
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003036 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02003037 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003038 * buffer can in principle be empty since it doesn't actually have
3039 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 if (signature_size == 0) {
3041 return PSA_ERROR_BUFFER_TOO_SMALL;
3042 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003043
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003044 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 key, &slot,
3046 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
3047 PSA_KEY_USAGE_SIGN_HASH,
3048 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003049
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003051 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003055 status = PSA_ERROR_INVALID_ARGUMENT;
3056 goto exit;
3057 }
3058
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003059 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003061 };
3062
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003064 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003065 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003066 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 signature, signature_size, signature_length);
3068 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003069
3070 status = psa_driver_wrapper_sign_hash(
3071 &attributes, slot->key.data, slot->key.bytes,
3072 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003074 }
3075
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003076
3077exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003078 psa_wipe_tag_output_buffer(signature, status, signature_size,
3079 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003080
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003082
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003084}
3085
Gilles Peskine449bd832023-01-11 14:50:10 +01003086static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3087 int input_is_message,
3088 psa_algorithm_t alg,
3089 const uint8_t *input,
3090 size_t input_length,
3091 const uint8_t *signature,
3092 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003093{
3094 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3095 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3096 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 status = psa_sign_verify_check_alg(input_is_message, alg);
3099 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003100 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003102
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003103 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 key, &slot,
3105 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3106 PSA_KEY_USAGE_VERIFY_HASH,
3107 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 if (status != PSA_SUCCESS) {
3110 return status;
3111 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003112
3113 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003115 };
3116
Gilles Peskine449bd832023-01-11 14:50:10 +01003117 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003118 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003119 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003120 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 signature, signature_length);
3122 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003123 status = psa_driver_wrapper_verify_hash(
3124 &attributes, slot->key.data, slot->key.bytes,
3125 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003127 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003128
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003130
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003132
3133}
3134
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003135psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003136 const psa_key_attributes_t *attributes,
3137 const uint8_t *key_buffer,
3138 size_t key_buffer_size,
3139 psa_algorithm_t alg,
3140 const uint8_t *input,
3141 size_t input_length,
3142 uint8_t *signature,
3143 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003145{
3146 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003147
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003149 size_t hash_length;
3150 uint8_t hash[PSA_HASH_MAX_SIZE];
3151
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003152 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 PSA_ALG_SIGN_GET_HASH(alg),
3154 input, input_length,
3155 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003156
Gilles Peskine449bd832023-01-11 14:50:10 +01003157 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003158 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003160
3161 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 attributes, key_buffer, key_buffer_size,
3163 alg, hash, hash_length,
3164 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003165 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003166
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003168}
3169
Gilles Peskine449bd832023-01-11 14:50:10 +01003170psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3171 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003172 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003173 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003174 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 size_t signature_size,
3176 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003177{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003178 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3179 LOCAL_INPUT_DECLARE(input_external, input);
3180 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3181
3182 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3183 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3184 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3185 signature_size, signature_length);
3186
Thomas Daubney3e65f522024-01-30 12:37:25 +00003187#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003188exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003189#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003190 LOCAL_INPUT_FREE(input_external, input);
3191 LOCAL_OUTPUT_FREE(signature_external, signature);
3192 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003193}
3194
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003195psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003196 const psa_key_attributes_t *attributes,
3197 const uint8_t *key_buffer,
3198 size_t key_buffer_size,
3199 psa_algorithm_t alg,
3200 const uint8_t *input,
3201 size_t input_length,
3202 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003203 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003204{
3205 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003206
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003208 size_t hash_length;
3209 uint8_t hash[PSA_HASH_MAX_SIZE];
3210
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003211 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 PSA_ALG_SIGN_GET_HASH(alg),
3213 input, input_length,
3214 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003217 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003218 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003219
3220 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 attributes, key_buffer, key_buffer_size,
3222 alg, hash, hash_length,
3223 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003224 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003225
Gilles Peskine449bd832023-01-11 14:50:10 +01003226 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003227}
3228
Gilles Peskine449bd832023-01-11 14:50:10 +01003229psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3230 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003231 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003233 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003235{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003236 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3237 LOCAL_INPUT_DECLARE(input_external, input);
3238 LOCAL_INPUT_DECLARE(signature_external, signature);
3239
3240 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3241 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3242 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3243 signature_length);
3244
Thomas Daubney3e65f522024-01-30 12:37:25 +00003245#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003246exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003247#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003248 LOCAL_INPUT_FREE(input_external, input);
3249 LOCAL_INPUT_FREE(signature_external, signature);
3250
3251 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003252}
3253
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003254psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003255 const psa_key_attributes_t *attributes,
3256 const uint8_t *key_buffer, size_t key_buffer_size,
3257 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003259{
Gilles Peskine449bd832023-01-11 14:50:10 +01003260 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3261 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3262 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003263#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003264 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3265 return mbedtls_psa_rsa_sign_hash(
3266 attributes,
3267 key_buffer, key_buffer_size,
3268 alg, hash, hash_length,
3269 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003270#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3271 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 } else {
3273 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003274 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003275 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3276 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003277#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3279 return mbedtls_psa_ecdsa_sign_hash(
3280 attributes,
3281 key_buffer, key_buffer_size,
3282 alg, hash, hash_length,
3283 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003284#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3285 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 } else {
3287 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003288 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003289 }
Ronald Cron4501c982021-03-19 20:09:32 +01003290
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 (void) key_buffer;
3292 (void) key_buffer_size;
3293 (void) hash;
3294 (void) hash_length;
3295 (void) signature;
3296 (void) signature_size;
3297 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003298
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003300}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003301
Gilles Peskine449bd832023-01-11 14:50:10 +01003302psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3303 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003304 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003306 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 size_t signature_size,
3308 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003309{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003310 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3311 LOCAL_INPUT_DECLARE(hash_external, hash);
3312 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3313
3314 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3315 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3316 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3317 signature_size, signature_length);
3318
Thomas Daubney3e65f522024-01-30 12:37:25 +00003319#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003320exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003321#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003322 LOCAL_INPUT_FREE(hash_external, hash);
3323 LOCAL_OUTPUT_FREE(signature_external, signature);
3324
3325 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003326}
3327
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003328psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003329 const psa_key_attributes_t *attributes,
3330 const uint8_t *key_buffer, size_t key_buffer_size,
3331 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003333{
Gilles Peskine449bd832023-01-11 14:50:10 +01003334 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3335 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3336 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003337#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3339 return mbedtls_psa_rsa_verify_hash(
3340 attributes,
3341 key_buffer, key_buffer_size,
3342 alg, hash, hash_length,
3343 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003344#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3345 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003346 } else {
3347 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003348 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3350 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003351#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3353 return mbedtls_psa_ecdsa_verify_hash(
3354 attributes,
3355 key_buffer, key_buffer_size,
3356 alg, hash, hash_length,
3357 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003358#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3359 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 } else {
3361 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003362 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003363 }
Ronald Cron4501c982021-03-19 20:09:32 +01003364
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 (void) key_buffer;
3366 (void) key_buffer_size;
3367 (void) hash;
3368 (void) hash_length;
3369 (void) signature;
3370 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003371
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003373}
3374
Gilles Peskine449bd832023-01-11 14:50:10 +01003375psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3376 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003377 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003379 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003380 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003381{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003382 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3383 LOCAL_INPUT_DECLARE(hash_external, hash);
3384 LOCAL_INPUT_DECLARE(signature_external, signature);
3385
3386 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3387 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3388 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3389 signature_length);
3390
Thomas Daubney3e65f522024-01-30 12:37:25 +00003391#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003392exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003393#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003394 LOCAL_INPUT_FREE(hash_external, hash);
3395 LOCAL_INPUT_FREE(signature_external, signature);
3396
3397 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003398}
3399
Gilles Peskine449bd832023-01-11 14:50:10 +01003400psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3401 psa_algorithm_t alg,
3402 const uint8_t *input,
3403 size_t input_length,
3404 const uint8_t *salt,
3405 size_t salt_length,
3406 uint8_t *output,
3407 size_t output_size,
3408 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003409{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003410 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003411 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003412 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003413 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003414
Darryl Green5cc689a2018-07-24 15:34:10 +01003415 (void) input;
3416 (void) input_length;
3417 (void) salt;
3418 (void) output;
3419 (void) output_size;
3420
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003421 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003422
Gilles Peskine449bd832023-01-11 14:50:10 +01003423 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3424 return PSA_ERROR_INVALID_ARGUMENT;
3425 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003426
Ronald Cron5c522922020-11-14 16:35:34 +01003427 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003428 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3429 if (status != PSA_SUCCESS) {
3430 return status;
3431 }
3432 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3433 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003434 status = PSA_ERROR_INVALID_ARGUMENT;
3435 goto exit;
3436 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003437
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003438 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003439 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003440 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003441
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003442 status = psa_driver_wrapper_asymmetric_encrypt(
3443 &attributes, slot->key.data, slot->key.bytes,
3444 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003445 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003446exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003447 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003448
Gilles Peskine449bd832023-01-11 14:50:10 +01003449 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003450}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003451
Gilles Peskine449bd832023-01-11 14:50:10 +01003452psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3453 psa_algorithm_t alg,
3454 const uint8_t *input,
3455 size_t input_length,
3456 const uint8_t *salt,
3457 size_t salt_length,
3458 uint8_t *output,
3459 size_t output_size,
3460 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003461{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003462 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003463 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003464 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003465 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003466
Darryl Green5cc689a2018-07-24 15:34:10 +01003467 (void) input;
3468 (void) input_length;
3469 (void) salt;
3470 (void) output;
3471 (void) output_size;
3472
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003473 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003474
Gilles Peskine449bd832023-01-11 14:50:10 +01003475 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3476 return PSA_ERROR_INVALID_ARGUMENT;
3477 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003478
Ronald Cron5c522922020-11-14 16:35:34 +01003479 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003480 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3481 if (status != PSA_SUCCESS) {
3482 return status;
3483 }
3484 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003485 status = PSA_ERROR_INVALID_ARGUMENT;
3486 goto exit;
3487 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003488
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003489 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003490 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003491 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003492
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003493 status = psa_driver_wrapper_asymmetric_decrypt(
3494 &attributes, slot->key.data, slot->key.bytes,
3495 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003496 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003497
3498exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003499 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003500
Gilles Peskine449bd832023-01-11 14:50:10 +01003501 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003502}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003503
Paul Elliott9fe12f62022-11-30 19:16:02 +00003504/****************************************************************/
3505/* Asymmetric interruptible cryptography */
3506/****************************************************************/
3507
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003508static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3509
Paul Elliott9fe12f62022-11-30 19:16:02 +00003510void psa_interruptible_set_max_ops(uint32_t max_ops)
3511{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003512 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003513}
3514
3515uint32_t psa_interruptible_get_max_ops(void)
3516{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003517 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003518}
3519
Paul Elliott9fe12f62022-11-30 19:16:02 +00003520uint32_t psa_sign_hash_get_num_ops(
3521 const psa_sign_hash_interruptible_operation_t *operation)
3522{
Paul Elliott296ede92022-12-15 17:00:30 +00003523 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003524}
3525
3526uint32_t psa_verify_hash_get_num_ops(
3527 const psa_verify_hash_interruptible_operation_t *operation)
3528{
Paul Elliott296ede92022-12-15 17:00:30 +00003529 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003530}
3531
Paul Elliott59ad9452022-12-18 15:09:02 +00003532static psa_status_t psa_sign_hash_abort_internal(
3533 psa_sign_hash_interruptible_operation_t *operation)
3534{
3535 if (operation->id == 0) {
3536 /* The object has (apparently) been initialized but it is not (yet)
3537 * in use. It's ok to call abort on such an object, and there's
3538 * nothing to do. */
3539 return PSA_SUCCESS;
3540 }
3541
3542 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3543
3544 status = psa_driver_wrapper_sign_hash_abort(operation);
3545
3546 operation->id = 0;
3547
Paul Elliotte6145dc2023-02-07 12:51:21 +00003548 /* Do not clear either the error_occurred or num_ops elements here as they
3549 * only want to be cleared by the application calling abort, not by abort
3550 * being called at completion of an operation. */
3551
Paul Elliott59ad9452022-12-18 15:09:02 +00003552 return status;
3553}
3554
Paul Elliott9fe12f62022-11-30 19:16:02 +00003555psa_status_t psa_sign_hash_start(
3556 psa_sign_hash_interruptible_operation_t *operation,
3557 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3558 const uint8_t *hash, size_t hash_length)
3559{
3560 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3561 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3562 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003563 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003564
Paul Elliottc9774412023-02-06 15:14:07 +00003565 /* Check that start has not been previously called, or operation has not
3566 * previously errored. */
3567 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003568 return PSA_ERROR_BAD_STATE;
3569 }
3570
Paul Elliott9fe12f62022-11-30 19:16:02 +00003571 status = psa_sign_verify_check_alg(0, alg);
3572 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003573 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003574 return status;
3575 }
3576
3577 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3578 PSA_KEY_USAGE_SIGN_HASH,
3579 alg);
3580
3581 if (status != PSA_SUCCESS) {
3582 goto exit;
3583 }
3584
3585 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3586 status = PSA_ERROR_INVALID_ARGUMENT;
3587 goto exit;
3588 }
3589
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003590 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003591 .core = slot->attr
3592 };
3593
Paul Elliott296ede92022-12-15 17:00:30 +00003594 /* Ensure ops count gets reset, in case of operation re-use. */
3595 operation->num_ops = 0;
3596
Paul Elliott9fe12f62022-11-30 19:16:02 +00003597 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3598 slot->key.data,
3599 slot->key.bytes, alg,
3600 hash, hash_length);
3601exit:
3602
3603 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003604 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003605 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003606 }
3607
3608 unlock_status = psa_unlock_key_slot(slot);
3609
Paul Elliottc9774412023-02-06 15:14:07 +00003610 if (unlock_status != PSA_SUCCESS) {
3611 operation->error_occurred = 1;
3612 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003613
Paul Elliottc9774412023-02-06 15:14:07 +00003614 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003615}
3616
3617
3618psa_status_t psa_sign_hash_complete(
3619 psa_sign_hash_interruptible_operation_t *operation,
3620 uint8_t *signature, size_t signature_size,
3621 size_t *signature_length)
3622{
3623 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3624
3625 *signature_length = 0;
3626
Paul Elliottc9774412023-02-06 15:14:07 +00003627 /* Check that start has been called first, and that operation has not
3628 * previously errored. */
3629 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003630 status = PSA_ERROR_BAD_STATE;
3631 goto exit;
3632 }
3633
Paul Elliott096abc42023-02-03 18:33:23 +00003634 /* Immediately reject a zero-length signature buffer. This guarantees that
3635 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003636 if (signature_size == 0) {
3637 status = PSA_ERROR_BUFFER_TOO_SMALL;
3638 goto exit;
3639 }
3640
3641 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3642 signature_size,
3643 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003644
Paul Elliott296ede92022-12-15 17:00:30 +00003645 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003646 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003647
Paul Elliottebe225c2023-02-10 14:32:53 +00003648exit:
3649
Paul Elliott59200a22023-02-21 15:07:40 +00003650 psa_wipe_tag_output_buffer(signature, status, signature_size,
3651 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003652
Paul Elliott53bb3122023-02-10 14:22:22 +00003653 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003654 if (status != PSA_SUCCESS) {
3655 operation->error_occurred = 1;
3656 }
3657
Paul Elliott59ad9452022-12-18 15:09:02 +00003658 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003659 }
3660
3661 return status;
3662}
3663
3664psa_status_t psa_sign_hash_abort(
3665 psa_sign_hash_interruptible_operation_t *operation)
3666{
Paul Elliott59ad9452022-12-18 15:09:02 +00003667 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3668
3669 status = psa_sign_hash_abort_internal(operation);
3670
3671 /* We clear the number of ops done here, so that it is not cleared when
3672 * the operation fails or succeeds, only on manual abort. */
3673 operation->num_ops = 0;
3674
Paul Elliottc9774412023-02-06 15:14:07 +00003675 /* Likewise, failure state. */
3676 operation->error_occurred = 0;
3677
Paul Elliott59ad9452022-12-18 15:09:02 +00003678 return status;
3679}
3680
3681static psa_status_t psa_verify_hash_abort_internal(
3682 psa_verify_hash_interruptible_operation_t *operation)
3683{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003684 if (operation->id == 0) {
3685 /* The object has (apparently) been initialized but it is not (yet)
3686 * in use. It's ok to call abort on such an object, and there's
3687 * nothing to do. */
3688 return PSA_SUCCESS;
3689 }
3690
Paul Elliott59ad9452022-12-18 15:09:02 +00003691 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3692
3693 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003694
3695 operation->id = 0;
3696
Paul Elliotte6145dc2023-02-07 12:51:21 +00003697 /* Do not clear either the error_occurred or num_ops elements here as they
3698 * only want to be cleared by the application calling abort, not by abort
3699 * being called at completion of an operation. */
3700
Paul Elliott59ad9452022-12-18 15:09:02 +00003701 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003702}
3703
3704psa_status_t psa_verify_hash_start(
3705 psa_verify_hash_interruptible_operation_t *operation,
3706 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3707 const uint8_t *hash, size_t hash_length,
3708 const uint8_t *signature, size_t signature_length)
3709{
3710 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3711 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3712 psa_key_slot_t *slot;
3713
Paul Elliottc9774412023-02-06 15:14:07 +00003714 /* Check that start has not been previously called, or operation has not
3715 * previously errored. */
3716 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003717 return PSA_ERROR_BAD_STATE;
3718 }
3719
3720 status = psa_sign_verify_check_alg(0, alg);
3721 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003722 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003723 return status;
3724 }
3725
3726 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3727 PSA_KEY_USAGE_VERIFY_HASH,
3728 alg);
3729
3730 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003731 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003732 return status;
3733 }
3734
3735 psa_key_attributes_t attributes = {
3736 .core = slot->attr
3737 };
3738
Paul Elliott296ede92022-12-15 17:00:30 +00003739 /* Ensure ops count gets reset, in case of operation re-use. */
3740 operation->num_ops = 0;
3741
Paul Elliott9fe12f62022-11-30 19:16:02 +00003742 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3743 slot->key.data,
3744 slot->key.bytes,
3745 alg, hash, hash_length,
3746 signature, signature_length);
3747
3748 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003749 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003750 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003751 }
3752
3753 unlock_status = psa_unlock_key_slot(slot);
3754
Paul Elliottc9774412023-02-06 15:14:07 +00003755 if (unlock_status != PSA_SUCCESS) {
3756 operation->error_occurred = 1;
3757 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003758
Paul Elliottc9774412023-02-06 15:14:07 +00003759 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003760}
3761
3762psa_status_t psa_verify_hash_complete(
3763 psa_verify_hash_interruptible_operation_t *operation)
3764{
3765 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3766
Paul Elliottc9774412023-02-06 15:14:07 +00003767 /* Check that start has been called first, and that operation has not
3768 * previously errored. */
3769 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003770 status = PSA_ERROR_BAD_STATE;
3771 goto exit;
3772 }
3773
3774 status = psa_driver_wrapper_verify_hash_complete(operation);
3775
Paul Elliott296ede92022-12-15 17:00:30 +00003776 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003777 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003778 operation);
3779
Paul Elliottebe225c2023-02-10 14:32:53 +00003780exit:
3781
Paul Elliott9fe12f62022-11-30 19:16:02 +00003782 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003783 if (status != PSA_SUCCESS) {
3784 operation->error_occurred = 1;
3785 }
3786
Paul Elliott59ad9452022-12-18 15:09:02 +00003787 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003788 }
3789
3790 return status;
3791}
3792
3793psa_status_t psa_verify_hash_abort(
3794 psa_verify_hash_interruptible_operation_t *operation)
3795{
Paul Elliott59ad9452022-12-18 15:09:02 +00003796 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003797
Paul Elliott59ad9452022-12-18 15:09:02 +00003798 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003799
Paul Elliott59ad9452022-12-18 15:09:02 +00003800 /* We clear the number of ops done here, so that it is not cleared when
3801 * the operation fails or succeeds, only on manual abort. */
3802 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003803
Paul Elliottc9774412023-02-06 15:14:07 +00003804 /* Likewise, failure state. */
3805 operation->error_occurred = 0;
3806
Paul Elliott59ad9452022-12-18 15:09:02 +00003807 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003808}
3809
Paul Elliott588f8ed2022-12-02 18:10:26 +00003810/****************************************************************/
3811/* Asymmetric interruptible cryptography internal */
3812/* implementations */
3813/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003814
Paul Elliott588f8ed2022-12-02 18:10:26 +00003815void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3816{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003817
Paul Elliott588f8ed2022-12-02 18:10:26 +00003818#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3819 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3820 defined(MBEDTLS_ECP_RESTARTABLE)
3821
3822 /* Internal implementation uses zero to indicate infinite number max ops,
3823 * therefore avoid this value, and set to minimum possible. */
3824 if (max_ops == 0) {
3825 max_ops = 1;
3826 }
3827
Paul Elliott588f8ed2022-12-02 18:10:26 +00003828 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003829#else
3830 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003831#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3832 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3833 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3834}
3835
Paul Elliott588f8ed2022-12-02 18:10:26 +00003836uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003837 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003838{
3839#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3840 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3841 defined(MBEDTLS_ECP_RESTARTABLE)
3842
Paul Elliott93d9ca82023-02-15 18:14:21 +00003843 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003844#else
3845 (void) operation;
3846 return 0;
3847#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3848 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3849 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3850}
3851
3852uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003853 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003854{
3855 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3856 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3857 defined(MBEDTLS_ECP_RESTARTABLE)
3858
Paul Elliott93d9ca82023-02-15 18:14:21 +00003859 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003860#else
3861 (void) operation;
3862 return 0;
3863#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3864 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3865 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3866}
3867
3868psa_status_t mbedtls_psa_sign_hash_start(
3869 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3870 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3871 size_t key_buffer_size, psa_algorithm_t alg,
3872 const uint8_t *hash, size_t hash_length)
3873{
3874 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003875 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003876
Paul Elliott068fe072023-01-16 13:59:15 +00003877 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3878 return PSA_ERROR_NOT_SUPPORTED;
3879 }
3880
3881 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003882 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003883 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003884
3885#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003886 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3887 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003888
Paul Elliotta1c94092023-02-15 16:38:04 +00003889 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3890
Paul Elliott93d9ca82023-02-15 18:14:21 +00003891 /* Ensure num_ops is zero'ed in case of context re-use. */
3892 operation->num_ops = 0;
3893
Paul Elliott068fe072023-01-16 13:59:15 +00003894 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3895 attributes->core.bits,
3896 key_buffer,
3897 key_buffer_size,
3898 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003899
Paul Elliott068fe072023-01-16 13:59:15 +00003900 if (status != PSA_SUCCESS) {
3901 return status;
3902 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003903
Paul Elliott1bc59df2023-02-05 13:41:57 +00003904 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003905 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003906
Paul Elliott068fe072023-01-16 13:59:15 +00003907 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003908 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003909 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003910
Paul Elliott0290a762023-02-09 14:30:24 +00003911 /* We only need to store the same length of hash as the private key size
3912 * here, it would be truncated by the internal implementation anyway. */
3913 required_hash_length = (hash_length < operation->coordinate_bytes ?
3914 hash_length : operation->coordinate_bytes);
3915
Paul Elliottba70ad42023-02-15 18:23:53 +00003916 if (required_hash_length > sizeof(operation->hash)) {
3917 /* Shouldn't happen, but better safe than sorry. */
3918 return PSA_ERROR_CORRUPTION_DETECTED;
3919 }
3920
Paul Elliott0290a762023-02-09 14:30:24 +00003921 memcpy(operation->hash, hash, required_hash_length);
3922 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003923
3924 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003925
3926#else
Paul Elliott068fe072023-01-16 13:59:15 +00003927 (void) operation;
3928 (void) key_buffer;
3929 (void) key_buffer_size;
3930 (void) alg;
3931 (void) hash;
3932 (void) hash_length;
3933 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003934 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003935
Paul Elliott068fe072023-01-16 13:59:15 +00003936 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003937#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3938 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3939 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003940}
3941
3942psa_status_t mbedtls_psa_sign_hash_complete(
3943 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3944 uint8_t *signature, size_t signature_size,
3945 size_t *signature_length)
3946{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003947#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3948 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3949 defined(MBEDTLS_ECP_RESTARTABLE)
3950
Paul Elliotta1c94092023-02-15 16:38:04 +00003951 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003952 mbedtls_mpi r;
3953 mbedtls_mpi s;
3954
Paul Elliott46845252023-02-03 14:59:11 +00003955 mbedtls_mpi_init(&r);
3956 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003957
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003958 /* Ensure max_ops is set to the current value (or default). */
3959 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3960
Paul Elliotta1c94092023-02-15 16:38:04 +00003961 if (signature_size < 2 * operation->coordinate_bytes) {
3962 status = PSA_ERROR_BUFFER_TOO_SMALL;
3963 goto exit;
3964 }
3965
Paul Elliott588f8ed2022-12-02 18:10:26 +00003966 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003967
Paul Elliott588f8ed2022-12-02 18:10:26 +00003968#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3969 status = mbedtls_to_psa_error(
3970 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003971 &r,
3972 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003973 &operation->ctx->d,
3974 operation->hash,
3975 operation->hash_length,
3976 operation->md_alg,
3977 mbedtls_psa_get_random,
3978 MBEDTLS_PSA_RANDOM_STATE,
3979 &operation->restart_ctx));
3980#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003981 status = PSA_ERROR_NOT_SUPPORTED;
3982 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003983#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3984 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003985 status = mbedtls_to_psa_error(
3986 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003987 &r,
3988 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003989 &operation->ctx->d,
3990 operation->hash,
3991 operation->hash_length,
3992 mbedtls_psa_get_random,
3993 MBEDTLS_PSA_RANDOM_STATE,
3994 mbedtls_psa_get_random,
3995 MBEDTLS_PSA_RANDOM_STATE,
3996 &operation->restart_ctx));
3997 }
3998
Paul Elliottf8e5b562023-02-19 18:43:45 +00003999 /* Hide the fact that the restart context only holds a delta of number of
4000 * ops done during the last operation, not an absolute value. */
4001 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4002
Paul Elliott724bd252023-02-08 12:35:08 +00004003 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00004004 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004005 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004006 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004007 operation->coordinate_bytes)
4008 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004009
4010 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004011 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004012 }
4013
4014 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004015 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004016 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004017 operation->coordinate_bytes,
4018 operation->coordinate_bytes)
4019 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004020
4021 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004022 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004023 }
4024
Paul Elliott1bc59df2023-02-05 13:41:57 +00004025 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004026
Paul Elliott724bd252023-02-08 12:35:08 +00004027 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004028 }
Paul Elliott724bd252023-02-08 12:35:08 +00004029
4030exit:
4031
4032 mbedtls_mpi_free(&r);
4033 mbedtls_mpi_free(&s);
4034 return status;
4035
Paul Elliott588f8ed2022-12-02 18:10:26 +00004036 #else
4037
4038 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004039 (void) signature;
4040 (void) signature_size;
4041 (void) signature_length;
4042
4043 return PSA_ERROR_NOT_SUPPORTED;
4044
4045#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4046 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4047 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4048}
4049
4050psa_status_t mbedtls_psa_sign_hash_abort(
4051 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4052{
4053
4054#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4055 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4056 defined(MBEDTLS_ECP_RESTARTABLE)
4057
4058 if (operation->ctx) {
4059 mbedtls_ecdsa_free(operation->ctx);
4060 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004061 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004062 }
4063
4064 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4065
Paul Elliott93d9ca82023-02-15 18:14:21 +00004066 operation->num_ops = 0;
4067
Paul Elliott588f8ed2022-12-02 18:10:26 +00004068 return PSA_SUCCESS;
4069
4070#else
4071
4072 (void) operation;
4073
4074 return PSA_ERROR_NOT_SUPPORTED;
4075
4076#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4077 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4078 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4079}
4080
4081psa_status_t mbedtls_psa_verify_hash_start(
4082 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4083 const psa_key_attributes_t *attributes,
4084 const uint8_t *key_buffer, size_t key_buffer_size,
4085 psa_algorithm_t alg,
4086 const uint8_t *hash, size_t hash_length,
4087 const uint8_t *signature, size_t signature_length)
4088{
4089 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004090 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004091 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004092
Paul Elliott068fe072023-01-16 13:59:15 +00004093 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4094 return PSA_ERROR_NOT_SUPPORTED;
4095 }
4096
4097 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004098 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004099 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004100
4101#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004102 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4103 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004104
Paul Elliotta1c94092023-02-15 16:38:04 +00004105 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4106 mbedtls_mpi_init(&operation->r);
4107 mbedtls_mpi_init(&operation->s);
4108
Paul Elliott93d9ca82023-02-15 18:14:21 +00004109 /* Ensure num_ops is zero'ed in case of context re-use. */
4110 operation->num_ops = 0;
4111
Paul Elliott068fe072023-01-16 13:59:15 +00004112 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4113 attributes->core.bits,
4114 key_buffer,
4115 key_buffer_size,
4116 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004117
Paul Elliott068fe072023-01-16 13:59:15 +00004118 if (status != PSA_SUCCESS) {
4119 return status;
4120 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004121
Paul Elliottc569fc22023-02-10 13:02:54 +00004122 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004123
Paul Elliott1bc59df2023-02-05 13:41:57 +00004124 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004125 return PSA_ERROR_INVALID_SIGNATURE;
4126 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004127
Paul Elliott068fe072023-01-16 13:59:15 +00004128 status = mbedtls_to_psa_error(
4129 mbedtls_mpi_read_binary(&operation->r,
4130 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004131 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004132
Paul Elliott068fe072023-01-16 13:59:15 +00004133 if (status != PSA_SUCCESS) {
4134 return status;
4135 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004136
Paul Elliott068fe072023-01-16 13:59:15 +00004137 status = mbedtls_to_psa_error(
4138 mbedtls_mpi_read_binary(&operation->s,
4139 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004140 coordinate_bytes,
4141 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004142
Paul Elliott068fe072023-01-16 13:59:15 +00004143 if (status != PSA_SUCCESS) {
4144 return status;
4145 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004146
Paul Elliott2c9843f2023-02-15 17:32:42 +00004147 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004148
Paul Elliott2c9843f2023-02-15 17:32:42 +00004149 if (status != PSA_SUCCESS) {
4150 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004151 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004152
Paul Elliott0290a762023-02-09 14:30:24 +00004153 /* We only need to store the same length of hash as the private key size
4154 * here, it would be truncated by the internal implementation anyway. */
4155 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4156 coordinate_bytes);
4157
Paul Elliottba70ad42023-02-15 18:23:53 +00004158 if (required_hash_length > sizeof(operation->hash)) {
4159 /* Shouldn't happen, but better safe than sorry. */
4160 return PSA_ERROR_CORRUPTION_DETECTED;
4161 }
4162
Paul Elliott0290a762023-02-09 14:30:24 +00004163 memcpy(operation->hash, hash, required_hash_length);
4164 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004165
4166 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004167#else
Paul Elliott068fe072023-01-16 13:59:15 +00004168 (void) operation;
4169 (void) key_buffer;
4170 (void) key_buffer_size;
4171 (void) alg;
4172 (void) hash;
4173 (void) hash_length;
4174 (void) signature;
4175 (void) signature_length;
4176 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004177 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004178 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004179
Paul Elliott068fe072023-01-16 13:59:15 +00004180 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004181#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4182 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4183 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004184}
4185
4186psa_status_t mbedtls_psa_verify_hash_complete(
4187 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4188{
4189
4190#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4191 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4192 defined(MBEDTLS_ECP_RESTARTABLE)
4193
Paul Elliottf8e5b562023-02-19 18:43:45 +00004194 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4195
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004196 /* Ensure max_ops is set to the current value (or default). */
4197 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4198
Paul Elliottf8e5b562023-02-19 18:43:45 +00004199 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004200 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4201 operation->hash,
4202 operation->hash_length,
4203 &operation->ctx->Q,
4204 &operation->r,
4205 &operation->s,
4206 &operation->restart_ctx));
4207
Paul Elliottf8e5b562023-02-19 18:43:45 +00004208 /* Hide the fact that the restart context only holds a delta of number of
4209 * ops done during the last operation, not an absolute value. */
4210 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4211
4212 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004213#else
4214 (void) operation;
4215
4216 return PSA_ERROR_NOT_SUPPORTED;
4217
4218#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4219 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4220 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4221}
4222
4223psa_status_t mbedtls_psa_verify_hash_abort(
4224 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4225{
4226
4227#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4228 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4229 defined(MBEDTLS_ECP_RESTARTABLE)
4230
4231 if (operation->ctx) {
4232 mbedtls_ecdsa_free(operation->ctx);
4233 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004234 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004235 }
4236
4237 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4238
Paul Elliott93d9ca82023-02-15 18:14:21 +00004239 operation->num_ops = 0;
4240
Paul Elliott588f8ed2022-12-02 18:10:26 +00004241 mbedtls_mpi_free(&operation->r);
4242 mbedtls_mpi_free(&operation->s);
4243
4244 return PSA_SUCCESS;
4245
4246#else
4247 (void) operation;
4248
4249 return PSA_ERROR_NOT_SUPPORTED;
4250
4251#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4252 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4253 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4254}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004255
mohammad1603503973b2018-03-12 15:59:30 +02004256/****************************************************************/
4257/* Symmetric cryptography */
4258/****************************************************************/
4259
Gilles Peskine449bd832023-01-11 14:50:10 +01004260static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4261 mbedtls_svc_key_id_t key,
4262 psa_algorithm_t alg,
4263 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004264{
4265 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4266 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004267 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4269 PSA_KEY_USAGE_ENCRYPT :
4270 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004271 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004272
4273 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004275 status = PSA_ERROR_BAD_STATE;
4276 goto exit;
4277 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004278
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004280 status = PSA_ERROR_INVALID_ARGUMENT;
4281 goto exit;
4282 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004283
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4285 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004286 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004288
Ronald Cron49fafa92021-03-10 08:34:23 +01004289 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004290 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004291 * so we only set it (in the driver wrapper) after resources have been
4292 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004293 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004295 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004297 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 }
4299 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004300
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004301 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004303 };
4304
Ronald Cronab99ac22020-10-01 16:38:28 +02004305 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 if (cipher_operation == MBEDTLS_ENCRYPT) {
4307 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4308 &attributes,
4309 slot->key.data,
4310 slot->key.bytes,
4311 alg);
4312 } else {
4313 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4314 &attributes,
4315 slot->key.data,
4316 slot->key.bytes,
4317 alg);
4318 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004319
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004320exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 if (status != PSA_SUCCESS) {
4322 psa_cipher_abort(operation);
4323 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004324
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004326
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004328}
4329
Gilles Peskine449bd832023-01-11 14:50:10 +01004330psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4331 mbedtls_svc_key_id_t key,
4332 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004333{
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004335}
4336
Gilles Peskine449bd832023-01-11 14:50:10 +01004337psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4338 mbedtls_svc_key_id_t key,
4339 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004340{
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004342}
4343
Gilles Peskine449bd832023-01-11 14:50:10 +01004344psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4345 uint8_t *iv,
4346 size_t iv_size,
4347 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004348{
Ronald Cron6d051732020-10-01 14:10:20 +02004349 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004350 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004351 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004354 status = PSA_ERROR_BAD_STATE;
4355 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004356 }
4357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004359 status = PSA_ERROR_BAD_STATE;
4360 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004361 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004362
Ronald Cron2fb90522021-07-05 12:31:44 +02004363 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004365 status = PSA_ERROR_BUFFER_TOO_SMALL;
4366 goto exit;
4367 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004368
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004370 status = PSA_ERROR_GENERIC_ERROR;
4371 goto exit;
4372 }
4373
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 status = psa_generate_random(local_iv, default_iv_length);
4375 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004376 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 }
Ronald Cron5618a392021-03-26 09:52:26 +01004378
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 status = psa_driver_wrapper_cipher_set_iv(operation,
4380 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004381
4382exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (status == PSA_SUCCESS) {
4384 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004385 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004386 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004388 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004390 }
Ronald Cron6d051732020-10-01 14:10:20 +02004391
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004393}
4394
Gilles Peskine449bd832023-01-11 14:50:10 +01004395psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4396 const uint8_t *iv,
4397 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004398{
Ronald Cron6d051732020-10-01 14:10:20 +02004399 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004400
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004402 status = PSA_ERROR_BAD_STATE;
4403 goto exit;
4404 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004405
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004407 status = PSA_ERROR_BAD_STATE;
4408 goto exit;
4409 }
Ronald Crona0d68172021-03-26 10:15:08 +01004410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004412 status = PSA_ERROR_INVALID_ARGUMENT;
4413 goto exit;
4414 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004415
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 status = psa_driver_wrapper_cipher_set_iv(operation,
4417 iv,
4418 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004419
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004420exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004422 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 } else {
4424 psa_cipher_abort(operation);
4425 }
4426 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004427}
4428
Gilles Peskine449bd832023-01-11 14:50:10 +01004429psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4430 const uint8_t *input,
4431 size_t input_length,
4432 uint8_t *output,
4433 size_t output_size,
4434 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004435{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004436 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004437
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004439 status = PSA_ERROR_BAD_STATE;
4440 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004441 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004442
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004444 status = PSA_ERROR_BAD_STATE;
4445 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004446 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 status = psa_driver_wrapper_cipher_update(operation,
4449 input,
4450 input_length,
4451 output,
4452 output_size,
4453 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004454
4455exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 if (status != PSA_SUCCESS) {
4457 psa_cipher_abort(operation);
4458 }
Ronald Cron6d051732020-10-01 14:10:20 +02004459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004461}
4462
Gilles Peskine449bd832023-01-11 14:50:10 +01004463psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4464 uint8_t *output,
4465 size_t output_size,
4466 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004467{
David Saadab4ecc272019-02-14 13:48:10 +02004468 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004469
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004471 status = PSA_ERROR_BAD_STATE;
4472 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004473 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004474
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004476 status = PSA_ERROR_BAD_STATE;
4477 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004478 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004479
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 status = psa_driver_wrapper_cipher_finish(operation,
4481 output,
4482 output_size,
4483 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004484
4485exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 if (status == PSA_SUCCESS) {
4487 return psa_cipher_abort(operation);
4488 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004489 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004491
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004493 }
mohammad1603503973b2018-03-12 15:59:30 +02004494}
4495
Gilles Peskine449bd832023-01-11 14:50:10 +01004496psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004497{
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004499 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004500 * in use. It's ok to call abort on such an object, and there's
4501 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004503 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004504
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004506
Ronald Cron49fafa92021-03-10 08:34:23 +01004507 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004508 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004509 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004510
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004512}
4513
Gilles Peskine449bd832023-01-11 14:50:10 +01004514psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4515 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004516 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004518 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 size_t output_size,
4520 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004521{
4522 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004523 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004524 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004525 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4526 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004527 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004528
David Horstmann62a56d92023-12-14 18:12:47 +00004529 LOCAL_INPUT_DECLARE(input_external, input);
4530 LOCAL_OUTPUT_DECLARE(output_external, output);
4531
David Horstmann36df4b22023-12-13 15:55:25 +00004532 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004533 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004534
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004536 status = PSA_ERROR_INVALID_ARGUMENT;
4537 goto exit;
4538 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004539
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4541 PSA_KEY_USAGE_ENCRYPT,
4542 alg);
4543 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004544 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004546
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004547 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004549 };
4550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4552 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004553 status = PSA_ERROR_GENERIC_ERROR;
4554 goto exit;
4555 }
4556
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 if (default_iv_length > 0) {
4558 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004559 status = PSA_ERROR_BUFFER_TOO_SMALL;
4560 goto exit;
4561 }
4562
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 status = psa_generate_random(local_iv, default_iv_length);
4564 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004565 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004567 }
4568
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004569 status = psa_driver_wrapper_cipher_encrypt(
4570 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004571 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004572 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004574
4575exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 unlock_status = psa_unlock_key_slot(slot);
4577 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004578 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004579 }
Ronald Cron23919522021-07-08 19:00:07 +02004580
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 if (status == PSA_SUCCESS) {
4582 if (default_iv_length > 0) {
4583 memcpy(output, local_iv, default_iv_length);
4584 }
4585 *output_length += default_iv_length;
4586 } else {
4587 *output_length = 0;
4588 }
4589
David Horstmann62a56d92023-12-14 18:12:47 +00004590 LOCAL_INPUT_FREE(input_external, input);
4591 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004592
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004594}
4595
Gilles Peskine449bd832023-01-11 14:50:10 +01004596psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4597 psa_algorithm_t alg,
4598 const uint8_t *input,
4599 size_t input_length,
4600 uint8_t *output,
4601 size_t output_size,
4602 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004603{
4604 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004605 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004606 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004607 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004608
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004610 status = PSA_ERROR_INVALID_ARGUMENT;
4611 goto exit;
4612 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004613
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4615 PSA_KEY_USAGE_DECRYPT,
4616 alg);
4617 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004618 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004620
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004621 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004623 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004624
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4626 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004627 status = PSA_ERROR_INVALID_ARGUMENT;
4628 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004630 status = PSA_ERROR_INVALID_ARGUMENT;
4631 goto exit;
4632 }
4633
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004634 status = psa_driver_wrapper_cipher_decrypt(
4635 &attributes, slot->key.data, slot->key.bytes,
4636 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004638
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004639exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 unlock_status = psa_unlock_key_slot(slot);
4641 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004642 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004644
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004646 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 }
Ronald Cron23919522021-07-08 19:00:07 +02004648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004650}
4651
4652
mohammad16035955c982018-04-26 00:53:03 +03004653/****************************************************************/
4654/* AEAD */
4655/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004656
Paul Elliottbaff51c2021-09-28 17:44:45 +01004657/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004658static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004659{
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004661}
4662
4663/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004664static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4665 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004666{
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004668
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004670#if defined(PSA_WANT_ALG_GCM)
4671 case PSA_ALG_GCM:
4672 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 * arbitrarily large nonces. Please note that we do not generally
4674 * recommend the usage of nonces of greater length than
4675 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4676 * size, which can then lead to collisions if you encrypt a very
4677 * large number of messages.*/
4678 if (nonce_length != 0) {
4679 return PSA_SUCCESS;
4680 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004681 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004682#endif /* PSA_WANT_ALG_GCM */
4683#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004684 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 if (nonce_length >= 7 && nonce_length <= 13) {
4686 return PSA_SUCCESS;
4687 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004688 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004689#endif /* PSA_WANT_ALG_CCM */
4690#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004691 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 if (nonce_length == 12) {
4693 return PSA_SUCCESS;
4694 } else if (nonce_length == 8) {
4695 return PSA_ERROR_NOT_SUPPORTED;
4696 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004697 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004698#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004699 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004700 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004702 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004703
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004705}
4706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004708{
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4710 return PSA_ERROR_INVALID_ARGUMENT;
4711 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004712
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004714}
4715
Gilles Peskine449bd832023-01-11 14:50:10 +01004716psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4717 psa_algorithm_t alg,
4718 const uint8_t *nonce,
4719 size_t nonce_length,
4720 const uint8_t *additional_data,
4721 size_t additional_data_length,
4722 const uint8_t *plaintext,
4723 size_t plaintext_length,
4724 uint8_t *ciphertext,
4725 size_t ciphertext_size,
4726 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004727{
Ronald Cron215633c2021-03-16 17:15:37 +01004728 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4729 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004730
mohammad1603f08a5502018-06-03 15:05:47 +03004731 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004732
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 status = psa_aead_check_algorithm(alg);
4734 if (status != PSA_SUCCESS) {
4735 return status;
4736 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004737
Ronald Cron9a986162021-03-26 12:40:07 +01004738 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4740 if (status != PSA_SUCCESS) {
4741 return status;
4742 }
mohammad16035955c982018-04-26 00:53:03 +03004743
Ronald Cron215633c2021-03-16 17:15:37 +01004744 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004746 };
mohammad16035955c982018-04-26 00:53:03 +03004747
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 status = psa_aead_check_nonce_length(alg, nonce_length);
4749 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004750 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004752
Ronald Cronde822812021-03-17 16:08:20 +01004753 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004754 &attributes, slot->key.data, slot->key.bytes,
4755 alg,
4756 nonce, nonce_length,
4757 additional_data, additional_data_length,
4758 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004760
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4762 memset(ciphertext, 0, ciphertext_size);
4763 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004764
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004765exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004767
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004769}
4770
Gilles Peskine449bd832023-01-11 14:50:10 +01004771psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4772 psa_algorithm_t alg,
4773 const uint8_t *nonce,
4774 size_t nonce_length,
4775 const uint8_t *additional_data,
4776 size_t additional_data_length,
4777 const uint8_t *ciphertext,
4778 size_t ciphertext_length,
4779 uint8_t *plaintext,
4780 size_t plaintext_size,
4781 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004782{
Ronald Cron215633c2021-03-16 17:15:37 +01004783 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4784 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004785
Gilles Peskineee652a32018-06-01 19:23:52 +02004786 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004787
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 status = psa_aead_check_algorithm(alg);
4789 if (status != PSA_SUCCESS) {
4790 return status;
4791 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004792
Ronald Cron9a986162021-03-26 12:40:07 +01004793 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4795 if (status != PSA_SUCCESS) {
4796 return status;
4797 }
mohammad16035955c982018-04-26 00:53:03 +03004798
Ronald Cron215633c2021-03-16 17:15:37 +01004799 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004801 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004802
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 status = psa_aead_check_nonce_length(alg, nonce_length);
4804 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004805 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004807
Ronald Cronde822812021-03-17 16:08:20 +01004808 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004809 &attributes, slot->key.data, slot->key.bytes,
4810 alg,
4811 nonce, nonce_length,
4812 additional_data, additional_data_length,
4813 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004815
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 if (status != PSA_SUCCESS && plaintext_size != 0) {
4817 memset(plaintext, 0, plaintext_size);
4818 }
mohammad160360a64d02018-06-03 17:20:42 +03004819
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004820exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004822
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 return status;
mohammad16035955c982018-04-26 00:53:03 +03004824}
4825
Gilles Peskine449bd832023-01-11 14:50:10 +01004826static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4827{
4828 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004831#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004833 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4835 return PSA_ERROR_INVALID_ARGUMENT;
4836 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004837 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004838#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004839
Przemek Stekiel86679c72022-10-06 17:06:56 +02004840#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004842 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4844 return PSA_ERROR_INVALID_ARGUMENT;
4845 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004846 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004847#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004848
Przemek Stekiel86679c72022-10-06 17:06:56 +02004849#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004851 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 if (tag_len != 16) {
4853 return PSA_ERROR_INVALID_ARGUMENT;
4854 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004855 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004856#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004857
4858 default:
4859 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004861 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004863}
4864
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004865/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004866static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4867 int is_encrypt,
4868 mbedtls_svc_key_id_t key,
4869 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004870{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004871 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4872 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4873 psa_key_slot_t *slot = NULL;
4874 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004875 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004876
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 status = psa_aead_check_algorithm(alg);
4878 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004879 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004881
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004883 status = PSA_ERROR_BAD_STATE;
4884 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004885 }
4886
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 if (operation->nonce_set || operation->lengths_set ||
4888 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004889 status = PSA_ERROR_BAD_STATE;
4890 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004891 }
4892
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004894 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004896 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004898
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4900 alg);
4901 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004902 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004904
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004905 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004906 .core = slot->attr
4907 };
4908
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004910 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004912
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 if (is_encrypt) {
4914 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4915 &attributes,
4916 slot->key.data,
4917 slot->key.bytes,
4918 alg);
4919 } else {
4920 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4921 &attributes,
4922 slot->key.data,
4923 slot->key.bytes,
4924 alg);
4925 }
4926 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004927 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004931
4932exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004934
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004936 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004938 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 } else {
4940 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004941 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004942
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004944}
4945
Paul Elliott302ff6b2021-04-20 18:10:30 +01004946/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004947psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4948 mbedtls_svc_key_id_t key,
4949 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004950{
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004952}
4953
4954/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004955psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4956 mbedtls_svc_key_id_t key,
4957 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004958{
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004960}
4961
4962/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004963psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4964 uint8_t *nonce,
4965 size_t nonce_size,
4966 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004967{
4968 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004969 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004970 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004971
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004972 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004973
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004975 status = PSA_ERROR_BAD_STATE;
4976 goto exit;
4977 }
4978
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004980 status = PSA_ERROR_BAD_STATE;
4981 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004982 }
4983
Paul Elliotte193ea82021-10-01 13:00:16 +01004984 /* For CCM, this size may not be correct according to the PSA
4985 * specification. The PSA Crypto 1.0.1 specification states:
4986 *
4987 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4988 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4989 *
4990 * However this restriction that L has to be the smallest integer is not
4991 * applied in practice, and it is not implementable here since the
4992 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4994 operation->alg);
4995 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004996 status = PSA_ERROR_BUFFER_TOO_SMALL;
4997 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004998 }
4999
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 status = psa_generate_random(local_nonce, required_nonce_size);
5001 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005002 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005004
Gilles Peskine449bd832023-01-11 14:50:10 +01005005 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005006
Paul Elliott39dc6b82021-05-11 19:16:09 +01005007exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 if (status == PSA_SUCCESS) {
5009 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005010 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005011 } else {
5012 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005013 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005014
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005016}
5017
5018/* Set the nonce for a multipart authenticated encryption or decryption
5019 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005020psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
5021 const uint8_t *nonce,
5022 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005023{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005024 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5025
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005027 status = PSA_ERROR_BAD_STATE;
5028 goto exit;
5029 }
5030
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005032 status = PSA_ERROR_BAD_STATE;
5033 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005034 }
5035
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5037 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01005038 status = PSA_ERROR_INVALID_ARGUMENT;
5039 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01005040 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01005041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5043 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005044
Paul Elliott39dc6b82021-05-11 19:16:09 +01005045exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005047 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 } else {
5049 psa_aead_abort(operation);
5050 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005051
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005053}
5054
5055/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005056psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5057 size_t ad_length,
5058 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005059{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005060 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5061
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005063 status = PSA_ERROR_BAD_STATE;
5064 goto exit;
5065 }
5066
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 if (operation->lengths_set || operation->ad_started ||
5068 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005069 status = PSA_ERROR_BAD_STATE;
5070 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005071 }
5072
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005074#if defined(PSA_WANT_ALG_GCM)
5075 case PSA_ALG_GCM:
5076 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 * bits. Without the guard this code will generate warnings on 32bit
5078 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005079#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 if (((uint64_t) ad_length) >> 61 != 0 ||
5081 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005082 status = PSA_ERROR_INVALID_ARGUMENT;
5083 goto exit;
5084 }
Paul Elliott325d3742021-09-27 17:56:28 +01005085#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005086 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005087#endif /* PSA_WANT_ALG_GCM */
5088#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005089 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005091 status = PSA_ERROR_INVALID_ARGUMENT;
5092 goto exit;
5093 }
5094 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005095#endif /* PSA_WANT_ALG_CCM */
5096#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005097 case PSA_ALG_CHACHA20_POLY1305:
5098 /* No length restrictions for ChaChaPoly. */
5099 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005100#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005101 default:
5102 break;
5103 }
Paul Elliott325d3742021-09-27 17:56:28 +01005104
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5106 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005107
Paul Elliott39dc6b82021-05-11 19:16:09 +01005108exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005110 operation->ad_remaining = ad_length;
5111 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005112 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 } else {
5114 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005115 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005116
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005118}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005119
5120/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005121psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5122 const uint8_t *input,
5123 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005124{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005125 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5126
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005128 status = PSA_ERROR_BAD_STATE;
5129 goto exit;
5130 }
5131
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005133 status = PSA_ERROR_BAD_STATE;
5134 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005135 }
5136
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 if (operation->lengths_set) {
5138 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005139 status = PSA_ERROR_INVALID_ARGUMENT;
5140 goto exit;
5141 }
5142
5143 operation->ad_remaining -= input_length;
5144 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005145#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005147 status = PSA_ERROR_BAD_STATE;
5148 goto exit;
5149 }
5150#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005151
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 status = psa_driver_wrapper_aead_update_ad(operation, input,
5153 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005154
Paul Elliott39dc6b82021-05-11 19:16:09 +01005155exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005157 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 } else {
5159 psa_aead_abort(operation);
5160 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005163}
5164
5165/* Encrypt or decrypt a message fragment in an active multipart AEAD
5166 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005167psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5168 const uint8_t *input,
5169 size_t input_length,
5170 uint8_t *output,
5171 size_t output_size,
5172 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005173{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005174 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005175
5176 *output_length = 0;
5177
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005179 status = PSA_ERROR_BAD_STATE;
5180 goto exit;
5181 }
5182
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005184 status = PSA_ERROR_BAD_STATE;
5185 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005186 }
5187
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005189 /* Additional data length was supplied, but not all the additional
5190 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005192 status = PSA_ERROR_INVALID_ARGUMENT;
5193 goto exit;
5194 }
5195
5196 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005198 status = PSA_ERROR_INVALID_ARGUMENT;
5199 goto exit;
5200 }
5201
5202 operation->body_remaining -= input_length;
5203 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005204#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005206 status = PSA_ERROR_BAD_STATE;
5207 goto exit;
5208 }
5209#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005210
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5212 output, output_size,
5213 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005214
Paul Elliott39dc6b82021-05-11 19:16:09 +01005215exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005216 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005217 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 } else {
5219 psa_aead_abort(operation);
5220 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005221
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005223}
5224
Gilles Peskine449bd832023-01-11 14:50:10 +01005225static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005226{
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 if (operation->id == 0 || !operation->nonce_set) {
5228 return PSA_ERROR_BAD_STATE;
5229 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005230
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5232 operation->body_remaining != 0)) {
5233 return PSA_ERROR_INVALID_ARGUMENT;
5234 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005235
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005237}
5238
Paul Elliott302ff6b2021-04-20 18:10:30 +01005239/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005240psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5241 uint8_t *ciphertext,
5242 size_t ciphertext_size,
5243 size_t *ciphertext_length,
5244 uint8_t *tag,
5245 size_t tag_size,
5246 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005247{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005248 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5249
Paul Elliott302ff6b2021-04-20 18:10:30 +01005250 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005251 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005252
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 status = psa_aead_final_checks(operation);
5254 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005255 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005257
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005259 status = PSA_ERROR_BAD_STATE;
5260 goto exit;
5261 }
5262
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5264 ciphertext_size,
5265 ciphertext_length,
5266 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005267
Paul Elliott39dc6b82021-05-11 19:16:09 +01005268exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005269
5270
Paul Elliottf47b0952021-05-21 18:02:33 +01005271 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005272 * the zero tag size, make sure the tag is set to something implausible.
5273 * Even if the operation succeeds, make sure we clear the rest of the
5274 * buffer to prevent potential leakage of anything previously placed in
5275 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005276 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005277
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005279
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005281}
5282
5283/* Finish authenticating and decrypting a message in a multipart AEAD
5284 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005285psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5286 uint8_t *plaintext,
5287 size_t plaintext_size,
5288 size_t *plaintext_length,
5289 const uint8_t *tag,
5290 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005291{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005292 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5293
Paul Elliott302ff6b2021-04-20 18:10:30 +01005294 *plaintext_length = 0;
5295
Gilles Peskine449bd832023-01-11 14:50:10 +01005296 status = psa_aead_final_checks(operation);
5297 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005298 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005300
Gilles Peskine449bd832023-01-11 14:50:10 +01005301 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005302 status = PSA_ERROR_BAD_STATE;
5303 goto exit;
5304 }
5305
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5307 plaintext_size,
5308 plaintext_length,
5309 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005310
5311exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005312 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005313
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005315}
5316
5317/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005318psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005319{
5320 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5321
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005323 /* The object has (apparently) been initialized but it is not (yet)
5324 * in use. It's ok to call abort on such an object, and there's
5325 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005327 }
5328
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005330
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005332
Gilles Peskine449bd832023-01-11 14:50:10 +01005333 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005334}
5335
Gilles Peskinee59236f2018-01-27 23:32:46 +01005336/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005337/* Generators */
5338/****************************************************************/
5339
Przemek Stekiel69c46792022-06-10 12:59:51 +02005340#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005341 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005342 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305343 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305344 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005345#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005346#endif /* At least one builtin KDF */
5347
Przemek Stekiel69c46792022-06-10 12:59:51 +02005348#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005349 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5350 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5351static psa_status_t psa_key_derivation_start_hmac(
5352 psa_mac_operation_t *operation,
5353 psa_algorithm_t hash_alg,
5354 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005356{
5357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5358 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5360 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5361 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005362
Steven Cooreman72f736a2021-05-07 14:14:37 +02005363 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005365
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 status = psa_driver_wrapper_mac_sign_setup(operation,
5367 &attributes,
5368 hmac_key, hmac_key_length,
5369 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005370
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 psa_reset_key_attributes(&attributes);
5372 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005373}
5374#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005375
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005376#define HKDF_STATE_INIT 0 /* no input yet */
5377#define HKDF_STATE_STARTED 1 /* got salt */
5378#define HKDF_STATE_KEYED 2 /* got key */
5379#define HKDF_STATE_OUTPUT 3 /* output started */
5380
Gilles Peskinecbe66502019-05-16 16:59:18 +02005381static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005383{
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5385 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5386 } else {
5387 return operation->alg;
5388 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005389}
5390
Gilles Peskine449bd832023-01-11 14:50:10 +01005391psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005392{
5393 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5395 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005396 /* The object has (apparently) been initialized but it is not
5397 * in use. It's ok to call abort on such an object, and there's
5398 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005400#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5402 mbedtls_free(operation->ctx.hkdf.info);
5403 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5404 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005405#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005406#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5407 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5409 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5410 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5411 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005412 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005414 }
5415
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005417 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005418 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005419 }
5420
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005422 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005424 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005425#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005427 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005429 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005430#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005431 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005432
5433 /* We leave the fields Ai and output_block to be erased safely by the
5434 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005436#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5437 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005438#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5440 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5441 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5442 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005443#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305444#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305445 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305446 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005447 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305448 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305449 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305450
5451 status = PSA_SUCCESS;
5452 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305453#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005454 {
5455 status = PSA_ERROR_BAD_STATE;
5456 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 mbedtls_platform_zeroize(operation, sizeof(*operation));
5458 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005459}
5460
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005461psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005463{
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005465 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005467 }
5468
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005469 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005471}
5472
Gilles Peskine449bd832023-01-11 14:50:10 +01005473psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5474 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005475{
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 if (operation->alg == 0) {
5477 return PSA_ERROR_BAD_STATE;
5478 }
5479 if (capacity > operation->capacity) {
5480 return PSA_ERROR_INVALID_ARGUMENT;
5481 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005482 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005484}
5485
Przemek Stekiel69c46792022-06-10 12:59:51 +02005486#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005487/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005488static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5489 psa_algorithm_t kdf_alg,
5490 uint8_t *output,
5491 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005492{
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5494 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005495 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005496 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005497#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005499#else
5500 const uint8_t last_block = 0xff;
5501#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005502
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 if (hkdf->state < HKDF_STATE_KEYED ||
5504 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005505#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005507#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 )) {
5509 return PSA_ERROR_BAD_STATE;
5510 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005511 hkdf->state = HKDF_STATE_OUTPUT;
5512
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005514 /* Copy what remains of the current block */
5515 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005517 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 }
5519 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005520 output += n;
5521 output_length -= n;
5522 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005524 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005526 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005527 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005528 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005529 * object was corrupted or if this function is called directly
5530 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 if (hkdf->block_number == last_block) {
5532 return PSA_ERROR_BAD_STATE;
5533 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005534
5535 /* We need a new block */
5536 ++hkdf->block_number;
5537 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005538
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5540 hash_alg,
5541 hkdf->prk,
5542 hash_length);
5543 if (status != PSA_SUCCESS) {
5544 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005545 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005546
5547 if (hkdf->block_number != 1) {
5548 status = psa_mac_update(&hkdf->hmac,
5549 hkdf->output_block,
5550 hash_length);
5551 if (status != PSA_SUCCESS) {
5552 return status;
5553 }
5554 }
5555 status = psa_mac_update(&hkdf->hmac,
5556 hkdf->info,
5557 hkdf->info_length);
5558 if (status != PSA_SUCCESS) {
5559 return status;
5560 }
5561 status = psa_mac_update(&hkdf->hmac,
5562 &hkdf->block_number, 1);
5563 if (status != PSA_SUCCESS) {
5564 return status;
5565 }
5566 status = psa_mac_sign_finish(&hkdf->hmac,
5567 hkdf->output_block,
5568 sizeof(hkdf->output_block),
5569 &hmac_output_length);
5570 if (status != PSA_SUCCESS) {
5571 return status;
5572 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005573 }
5574
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005576}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005577#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005578
John Durkop07cc04a2020-11-16 22:08:34 -08005579#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5580 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005581static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5582 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005584{
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5586 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005587 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5588 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005589 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005590
Janos Follath7742fee2019-06-17 12:58:10 +01005591 /* We can't be wanting more output after block 0xff, otherwise
5592 * the capacity check in psa_key_derivation_output_bytes() would have
5593 * prevented this call. It could happen only if the operation
5594 * object was corrupted or if this function is called directly
5595 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 if (tls12_prf->block_number == 0xff) {
5597 return PSA_ERROR_CORRUPTION_DETECTED;
5598 }
Janos Follath7742fee2019-06-17 12:58:10 +01005599
5600 /* We need a new block */
5601 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005602 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005603
5604 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5605 *
5606 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5607 *
5608 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5609 * HMAC_hash(secret, A(2) + seed) +
5610 * HMAC_hash(secret, A(3) + seed) + ...
5611 *
5612 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005613 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005614 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005615 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005616 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005617 * is currently extracted as `output_block` and where i is
5618 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005619 */
5620
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 status = psa_key_derivation_start_hmac(&hmac,
5622 hash_alg,
5623 tls12_prf->secret,
5624 tls12_prf->secret_length);
5625 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005626 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005627 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005628
5629 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005631 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5632 * the variable seed and in this instance means it in the context of the
5633 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 status = psa_mac_update(&hmac,
5635 tls12_prf->label,
5636 tls12_prf->label_length);
5637 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005638 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 }
5640 status = psa_mac_update(&hmac,
5641 tls12_prf->seed,
5642 tls12_prf->seed_length);
5643 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005644 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 }
5646 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005647 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5649 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005650 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005652 }
5653
Gilles Peskine449bd832023-01-11 14:50:10 +01005654 status = psa_mac_sign_finish(&hmac,
5655 tls12_prf->Ai, hash_length,
5656 &hmac_output_length);
5657 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005658 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 }
5660 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005661 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005663
5664 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 status = psa_key_derivation_start_hmac(&hmac,
5666 hash_alg,
5667 tls12_prf->secret,
5668 tls12_prf->secret_length);
5669 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005670 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 }
5672 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5673 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005674 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 }
5676 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5677 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005678 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005679 }
5680 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5681 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005682 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005683 }
5684 status = psa_mac_sign_finish(&hmac,
5685 tls12_prf->output_block, hash_length,
5686 &hmac_output_length);
5687 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005688 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005689 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005690
Janos Follath7742fee2019-06-17 12:58:10 +01005691
5692cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 cleanup_status = psa_mac_abort(&hmac);
5694 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005695 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005697
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005699}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005700
Janos Follath844eb0e2019-06-19 12:10:49 +01005701static psa_status_t psa_key_derivation_tls12_prf_read(
5702 psa_tls12_prf_key_derivation_t *tls12_prf,
5703 psa_algorithm_t alg,
5704 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005706{
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5708 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005709 psa_status_t status;
5710 uint8_t offset, length;
5711
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005713 case PSA_TLS12_PRF_STATE_LABEL_SET:
5714 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5715 break;
5716 case PSA_TLS12_PRF_STATE_OUTPUT:
5717 break;
5718 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005720 }
5721
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005723 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 if (tls12_prf->left_in_block == 0) {
5725 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5726 alg);
5727 if (status != PSA_SUCCESS) {
5728 return status;
5729 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005730
5731 continue;
5732 }
5733
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005735 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005737 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005739
5740 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005742 output += length;
5743 output_length -= length;
5744 tls12_prf->left_in_block -= length;
5745 }
5746
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005748}
John Durkop07cc04a2020-11-16 22:08:34 -08005749#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5750 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005751
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005752#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5753static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5754 psa_tls12_ecjpake_to_pms_t *ecjpake,
5755 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005757{
5758 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005759 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005760
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 if (output_length != 32) {
5762 return PSA_ERROR_INVALID_ARGUMENT;
5763 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005764
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5766 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5767 &output_size);
5768 if (status != PSA_SUCCESS) {
5769 return status;
5770 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005771
Gilles Peskine449bd832023-01-11 14:50:10 +01005772 if (output_size != output_length) {
5773 return PSA_ERROR_GENERIC_ERROR;
5774 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005775
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005777}
5778#endif
5779
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305780#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305781static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5782 psa_pbkdf2_key_derivation_t *pbkdf2,
5783 psa_algorithm_t prf_alg,
5784 uint8_t prf_output_length,
5785 psa_key_attributes_t *attributes)
5786{
5787 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305788 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305789 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305790 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305791 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305792 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305793 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305794
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305795 mac_operation.is_sign = 1;
5796 mac_operation.mac_size = prf_output_length;
5797 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305798
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305799 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5800 attributes,
5801 pbkdf2->password,
5802 pbkdf2->password_length,
5803 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305804 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305805 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305806 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305807 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5808 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305809 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305810 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305811 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305812 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305813 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305814 }
5815 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5816 &mac_output_length);
5817 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305818 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305819 }
5820
5821 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305822 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305823 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305824 }
5825
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305826 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305827
5828 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305829 /* We are passing prf_output_length as mac_size because the driver
5830 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305831 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305832 status = psa_driver_wrapper_mac_compute(attributes,
5833 pbkdf2->password,
5834 pbkdf2->password_length,
5835 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305836 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305837 &mac_output_length);
5838 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305839 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305840 }
5841
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305842 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305843 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305844
5845cleanup:
5846 /* Zeroise buffers to clear sensitive data from memory. */
5847 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5848 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305849}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305850
5851static psa_status_t psa_key_derivation_pbkdf2_read(
5852 psa_pbkdf2_key_derivation_t *pbkdf2,
5853 psa_algorithm_t kdf_alg,
5854 uint8_t *output,
5855 size_t output_length)
5856{
5857 psa_status_t status;
5858 psa_algorithm_t prf_alg;
5859 uint8_t prf_output_length;
5860 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5861 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5862 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5863
5864 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5865 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5866 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5867 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305868 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5869 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305870 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305871 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305872 } else {
5873 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305874 }
5875
5876 switch (pbkdf2->state) {
5877 case PSA_PBKDF2_STATE_PASSWORD_SET:
5878 /* Initially we need a new block so bytes_used is equal to block size*/
5879 pbkdf2->bytes_used = prf_output_length;
5880 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5881 break;
5882 case PSA_PBKDF2_STATE_OUTPUT:
5883 break;
5884 default:
5885 return PSA_ERROR_BAD_STATE;
5886 }
5887
5888 while (output_length != 0) {
5889 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5890 if (n > output_length) {
5891 n = (uint8_t) output_length;
5892 }
5893 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5894 output += n;
5895 output_length -= n;
5896 pbkdf2->bytes_used += n;
5897
5898 if (output_length == 0) {
5899 break;
5900 }
5901
5902 /* We need a new block */
5903 pbkdf2->bytes_used = 0;
5904 pbkdf2->block_number++;
5905
5906 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5907 prf_output_length,
5908 &attributes);
5909 if (status != PSA_SUCCESS) {
5910 return status;
5911 }
5912 }
5913
5914 return PSA_SUCCESS;
5915}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305916#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305917
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005918psa_status_t psa_key_derivation_output_bytes(
5919 psa_key_derivation_operation_t *operation,
5920 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005921 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005922{
5923 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005925
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005927 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005928 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005929 }
5930
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005932 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005933 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005934 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005935 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005936 goto exit;
5937 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005939 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005940 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005941 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5942 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005943 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005944 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005946 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005947 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005948
Przemek Stekiel69c46792022-06-10 12:59:51 +02005949#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5951 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5952 output, output_length);
5953 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005954#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005955#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5956 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5958 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5959 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5960 kdf_alg, output,
5961 output_length);
5962 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005963#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5964 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005965#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005967 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5969 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005970#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305971#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305972 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305973 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5974 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305975 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305976#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005977
Gilles Peskineeab56e42018-07-12 17:12:33 +02005978 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005979 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005981 }
5982
5983exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005985 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005986 * This allows us to differentiate between exhausted operations and
5987 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5988 * operations. */
5989 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005991 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005993 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005995}
5996
David Brown7807bf72021-02-09 16:28:23 -07005997#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005998static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005999{
Gilles Peskine449bd832023-01-11 14:50:10 +01006000 if (data_size >= 8) {
6001 mbedtls_des_key_set_parity(data);
6002 }
6003 if (data_size >= 16) {
6004 mbedtls_des_key_set_parity(data + 8);
6005 }
6006 if (data_size >= 24) {
6007 mbedtls_des_key_set_parity(data + 16);
6008 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006009}
David Brown7807bf72021-02-09 16:28:23 -07006010#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006011
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006012/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006013 * ECC keys on a Weierstrass elliptic curve require the generation
6014 * of a private key which is an integer
6015 * in the range [1, N - 1], where N is the boundary of the private key domain:
6016 * N is the prime p for Diffie-Hellman, or the order of the
6017 * curve’s base point for ECC.
6018 *
6019 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6020 * This function generates the private key using the following process:
6021 *
6022 * 1. Draw a byte string of length ceiling(m/8) bytes.
6023 * 2. If m is not a multiple of 8, set the most significant
6024 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6025 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6026 * 4. If k > N - 2, discard the result and return to step 1.
6027 * 5. Output k + 1 as the private key.
6028 *
6029 * This method allows compliance to NIST standards, specifically the methods titled
6030 * Key-Pair Generation by Testing Candidates in the following publications:
6031 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6032 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6033 * Diffie-Hellman keys.
6034 *
6035 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6036 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6037 *
6038 * Note: Function allocates memory for *data buffer, so given *data should be
6039 * always NULL.
6040 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006041#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6042#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006043static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006044 psa_key_slot_t *slot,
6045 size_t bits,
6046 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006047 uint8_t **data
6048 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006049{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006050 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006051 mbedtls_mpi k;
6052 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006053 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006054 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006055 size_t m;
6056 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006057
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 mbedtls_mpi_init(&k);
6059 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006060
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006061 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006063 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006065
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006067 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006068 goto cleanup;
6069 }
6070
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006071 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006073
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006075
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006076 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006077 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006078 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006079
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006080 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006081
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006082 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006084
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006085 /* Note: This function is always called with *data == NULL and it
6086 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 *data = mbedtls_calloc(1, m_bytes);
6088 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006089 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006090 goto cleanup;
6091 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006092
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006094 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006096 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006098
6099 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006101 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006102 * (8 * ceiling(m/8) - m) bits of the first byte in
6103 * the string to zero.
6104 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006106 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006107 }
6108
6109 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 * big-endian byte string.
6111 */
6112 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006113
6114 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 * Result of comparison is returned. When it indicates error
6116 * then this function is called again.
6117 */
6118 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006119 }
6120
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006121 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6123 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006124cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 if (ret != 0) {
6126 status = mbedtls_to_psa_error(ret);
6127 }
6128 if (status != PSA_SUCCESS) {
6129 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006130 *data = NULL;
6131 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 mbedtls_mpi_free(&k);
6133 mbedtls_mpi_free(&diff_N_2);
6134 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006135}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006136
6137/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6138 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6139 *
6140 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6141 * draw a 32-byte string and process it as specified in
6142 * Elliptic Curves for Security [RFC7748] §5.
6143 *
6144 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6145 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6146 *
6147 * Note: Function allocates memory for *data buffer, so given *data should be
6148 * always NULL.
6149 */
6150
6151static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6152 size_t bits,
6153 psa_key_derivation_operation_t *operation,
6154 uint8_t **data
6155 )
6156{
6157 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006158 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006159
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006161 case 255:
6162 output_length = 32;
6163 break;
6164 case 448:
6165 output_length = 56;
6166 break;
6167 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006169 break;
6170 }
6171
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006173
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 if (*data == NULL) {
6175 return PSA_ERROR_INSUFFICIENT_MEMORY;
6176 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006177
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006181 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006185 case 255:
6186 (*data)[0] &= 248;
6187 (*data)[31] &= 127;
6188 (*data)[31] |= 64;
6189 break;
6190 case 448:
6191 (*data)[0] &= 252;
6192 (*data)[55] |= 128;
6193 break;
6194 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006196 break;
6197 }
6198
6199 return status;
6200}
Valerio Setti86587ab2023-06-27 13:09:30 +02006201#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6202static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6203 psa_key_slot_t *slot, size_t bits,
6204 psa_key_derivation_operation_t *operation, uint8_t **data)
6205{
6206 (void) slot;
6207 (void) bits;
6208 (void) operation;
6209 (void) data;
6210 return PSA_ERROR_NOT_SUPPORTED;
6211}
6212
6213static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6214 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6215{
6216 (void) bits;
6217 (void) operation;
6218 (void) data;
6219 return PSA_ERROR_NOT_SUPPORTED;
6220}
6221#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6222#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006223
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006224static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006225 psa_key_slot_t *slot,
6226 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006228{
6229 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306231 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006232 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006233 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006234
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6236 return PSA_ERROR_INVALID_ARGUMENT;
6237 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006238
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006239#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006240 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6242 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6243 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006244 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006245 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6246 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006247 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 }
6249 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006250 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6252 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006253 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006255 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006256 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006257#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006258 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 if (key_type_is_raw_bytes(slot->attr.type)) {
6260 if (bits % 8 != 0) {
6261 return PSA_ERROR_INVALID_ARGUMENT;
6262 }
6263 data = mbedtls_calloc(1, bytes);
6264 if (data == NULL) {
6265 return PSA_ERROR_INSUFFICIENT_MEMORY;
6266 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006267
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 status = psa_key_derivation_output_bytes(operation, data, bytes);
6269 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006270 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 }
David Brown12ca5032021-02-11 11:02:00 -07006272#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6274 psa_des_set_key_parity(data, bytes);
6275 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006276#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 } else {
6278 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006279 }
Ronald Crondd04d422020-11-28 15:14:42 +01006280
Ronald Cronbf33c932020-11-28 18:06:53 +01006281 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006282 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006284 };
6285
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6287 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6288 &storage_size);
6289 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306290 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 }
Archanad8a83dc2021-06-14 10:04:16 +05306292 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 status = psa_allocate_buffer_to_slot(slot, storage_size);
6294 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306295 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 }
Archanad8a83dc2021-06-14 10:04:16 +05306297
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 status = psa_driver_wrapper_import_key(&attributes,
6299 data, bytes,
6300 slot->key.data,
6301 slot->key.bytes,
6302 &slot->key.bytes, &bits);
6303 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006304 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006306
6307exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006308 mbedtls_free(data);
6309 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006310}
6311
Gilles Peskine449bd832023-01-11 14:50:10 +01006312psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6313 psa_key_derivation_operation_t *operation,
6314 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006315{
6316 psa_status_t status;
6317 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006318 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006319
Ronald Cron81709fc2020-11-14 12:10:32 +01006320 *key = MBEDTLS_SVC_KEY_ID_INIT;
6321
Gilles Peskine0f84d622019-09-12 19:03:13 +02006322 /* Reject any attempt to create a zero-length key so that we don't
6323 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006324 if (psa_get_key_bits(attributes) == 0) {
6325 return PSA_ERROR_INVALID_ARGUMENT;
6326 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006327
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 if (operation->alg == PSA_ALG_NONE) {
6329 return PSA_ERROR_BAD_STATE;
6330 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006331
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 if (!operation->can_output_key) {
6333 return PSA_ERROR_NOT_PERMITTED;
6334 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006335
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6337 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006338#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006340 /* Deriving a key in a secure element is not implemented yet. */
6341 status = PSA_ERROR_NOT_SUPPORTED;
6342 }
6343#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 if (status == PSA_SUCCESS) {
6345 status = psa_generate_derived_key_internal(slot,
6346 attributes->core.bits,
6347 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006348 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 if (status == PSA_SUCCESS) {
6350 status = psa_finish_key_creation(slot, driver, key);
6351 }
6352 if (status != PSA_SUCCESS) {
6353 psa_fail_key_creation(slot, driver);
6354 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006355
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006357}
6358
Gilles Peskineeab56e42018-07-12 17:12:33 +02006359
6360
6361/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006362/* Key derivation */
6363/****************************************************************/
6364
Steven Cooreman932ffb72021-02-15 12:14:32 +01006365#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006366static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006367{
6368#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6370 return 1;
6371 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006372#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006373#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6375 return 1;
6376 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006377#endif
6378#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6380 return 1;
6381 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006382#endif
6383#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6385 return 1;
6386 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006387#endif
6388#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6390 return 1;
6391 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006392#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006393#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6395 return 1;
6396 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006397#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306398#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6399 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6400 return 1;
6401 }
6402#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306403#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6404 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6405 return 1;
6406 }
6407#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006409}
6410
Gilles Peskine449bd832023-01-11 14:50:10 +01006411static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006412{
6413 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 psa_status_t status = psa_hash_setup(&operation, alg);
6415 psa_hash_abort(&operation);
6416 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006417}
6418
Gilles Peskine969c5d62019-01-16 15:53:06 +01006419static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006420 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006422{
Janos Follath5fe19732019-06-20 15:09:30 +01006423 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6424 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006426
Gilles Peskine969c5d62019-01-16 15:53:06 +01006427 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 if (!is_kdf_alg_supported(kdf_alg)) {
6429 return PSA_ERROR_NOT_SUPPORTED;
6430 }
John Durkop07cc04a2020-11-16 22:08:34 -08006431
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006432 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306433 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6435 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306436 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6437 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6438 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306439 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306440 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 if (hash_size == 0) {
6442 return PSA_ERROR_NOT_SUPPORTED;
6443 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006444
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006445 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6446 * we might fail later, which is somewhat unfriendly and potentially
6447 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006448 psa_status_t status = psa_hash_try_support(hash_alg);
6449 if (status != PSA_SUCCESS) {
6450 return status;
6451 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006452 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006453
Gilles Peskine449bd832023-01-11 14:50:10 +01006454 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6455 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6456 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6457 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006458 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006459#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006460 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6462 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006463 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006464 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006465#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6466 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 operation->capacity = 255 * hash_size;
6468 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006469}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006470
Gilles Peskine449bd832023-01-11 14:50:10 +01006471static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006472{
6473#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 if (alg == PSA_ALG_ECDH) {
6475 return PSA_SUCCESS;
6476 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006477#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006478#if defined(PSA_WANT_ALG_FFDH)
6479 if (alg == PSA_ALG_FFDH) {
6480 return PSA_SUCCESS;
6481 }
6482#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006483 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006485}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006486
6487static int psa_key_derivation_allows_free_form_secret_input(
6488 psa_algorithm_t kdf_alg)
6489{
6490#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6491 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6492 return 0;
6493 }
6494#endif
6495 (void) kdf_alg;
6496 return 1;
6497}
John Durkop07cc04a2020-11-16 22:08:34 -08006498#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006499
Gilles Peskine449bd832023-01-11 14:50:10 +01006500psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6501 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006502{
6503 psa_status_t status;
6504
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 if (operation->alg != 0) {
6506 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006507 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006508
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6510 return PSA_ERROR_INVALID_ARGUMENT;
6511 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6512#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6513 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6514 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6515 status = psa_key_agreement_try_support(ka_alg);
6516 if (status != PSA_SUCCESS) {
6517 return status;
6518 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006519 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6520 return PSA_ERROR_INVALID_ARGUMENT;
6521 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6523#else
6524 return PSA_ERROR_NOT_SUPPORTED;
6525#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6526 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6527#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6528 status = psa_key_derivation_setup_kdf(operation, alg);
6529#else
6530 return PSA_ERROR_NOT_SUPPORTED;
6531#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6532 } else {
6533 return PSA_ERROR_INVALID_ARGUMENT;
6534 }
6535
6536 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006537 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 }
6539 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006540}
6541
Przemek Stekiel69c46792022-06-10 12:59:51 +02006542#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006543static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6544 psa_algorithm_t kdf_alg,
6545 psa_key_derivation_step_t step,
6546 const uint8_t *data,
6547 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006548{
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006550 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006552 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006553#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6555 return PSA_ERROR_INVALID_ARGUMENT;
6556 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006557#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 if (hkdf->state != HKDF_STATE_INIT) {
6559 return PSA_ERROR_BAD_STATE;
6560 } else {
6561 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6562 hash_alg,
6563 data, data_length);
6564 if (status != PSA_SUCCESS) {
6565 return status;
6566 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006567 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006569 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006570 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006571#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006573 /* We shouldn't be in different state as HKDF_EXPAND only allows
6574 * two inputs: SECRET (this case) and INFO which does not modify
6575 * the state. It could happen only if the hkdf
6576 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 if (hkdf->state != HKDF_STATE_INIT) {
6578 return PSA_ERROR_BAD_STATE;
6579 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006580
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006581 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6583 return PSA_ERROR_INVALID_ARGUMENT;
6584 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006585
Gilles Peskine449bd832023-01-11 14:50:10 +01006586 memcpy(hkdf->prk, data, data_length);
6587 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006588#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006589 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006590 /* HKDF: If no salt was provided, use an empty salt.
6591 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006592 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006593#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6595 return PSA_ERROR_BAD_STATE;
6596 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006597#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6599 hash_alg,
6600 NULL, 0);
6601 if (status != PSA_SUCCESS) {
6602 return status;
6603 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006604 hkdf->state = HKDF_STATE_STARTED;
6605 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 if (hkdf->state != HKDF_STATE_STARTED) {
6607 return PSA_ERROR_BAD_STATE;
6608 }
6609 status = psa_mac_update(&hkdf->hmac,
6610 data, data_length);
6611 if (status != PSA_SUCCESS) {
6612 return status;
6613 }
6614 status = psa_mac_sign_finish(&hkdf->hmac,
6615 hkdf->prk,
6616 sizeof(hkdf->prk),
6617 &data_length);
6618 if (status != PSA_SUCCESS) {
6619 return status;
6620 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006621 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006622
Gilles Peskine2b522db2019-04-12 15:11:49 +02006623 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006624 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006625#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006627 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006629 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006631#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006632 {
6633 /* Block 0 is empty, and the next block will be
6634 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006636 }
6637
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006639 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006640#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006641 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6642 return PSA_ERROR_INVALID_ARGUMENT;
6643 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006644#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006645#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6647 hkdf->state == HKDF_STATE_INIT) {
6648 return PSA_ERROR_BAD_STATE;
6649 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006650#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 if (hkdf->state == HKDF_STATE_OUTPUT) {
6652 return PSA_ERROR_BAD_STATE;
6653 }
6654 if (hkdf->info_set) {
6655 return PSA_ERROR_BAD_STATE;
6656 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006657 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 if (data_length != 0) {
6659 hkdf->info = mbedtls_calloc(1, data_length);
6660 if (hkdf->info == NULL) {
6661 return PSA_ERROR_INSUFFICIENT_MEMORY;
6662 }
6663 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006664 }
6665 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006666 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006667 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006668 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006669 }
6670}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006671#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006672
John Durkop07cc04a2020-11-16 22:08:34 -08006673#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6674 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006675static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6676 const uint8_t *data,
6677 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006678{
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6680 return PSA_ERROR_BAD_STATE;
6681 }
Janos Follathf08e2652019-06-13 09:05:41 +01006682
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 if (data_length != 0) {
6684 prf->seed = mbedtls_calloc(1, data_length);
6685 if (prf->seed == NULL) {
6686 return PSA_ERROR_INSUFFICIENT_MEMORY;
6687 }
Janos Follathf08e2652019-06-13 09:05:41 +01006688
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006690 prf->seed_length = data_length;
6691 }
Janos Follathf08e2652019-06-13 09:05:41 +01006692
Gilles Peskine43f958b2020-12-13 14:55:14 +01006693 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006694
Gilles Peskine449bd832023-01-11 14:50:10 +01006695 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006696}
6697
Gilles Peskine449bd832023-01-11 14:50:10 +01006698static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6699 const uint8_t *data,
6700 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006701{
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6703 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6704 return PSA_ERROR_BAD_STATE;
6705 }
Janos Follath81550542019-06-13 14:26:34 +01006706
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 if (data_length != 0) {
6708 prf->secret = mbedtls_calloc(1, data_length);
6709 if (prf->secret == NULL) {
6710 return PSA_ERROR_INSUFFICIENT_MEMORY;
6711 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006712
Gilles Peskine449bd832023-01-11 14:50:10 +01006713 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006714 prf->secret_length = data_length;
6715 }
Janos Follath81550542019-06-13 14:26:34 +01006716
Gilles Peskine43f958b2020-12-13 14:55:14 +01006717 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006718
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006720}
6721
Gilles Peskine449bd832023-01-11 14:50:10 +01006722static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6723 const uint8_t *data,
6724 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006725{
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6727 return PSA_ERROR_BAD_STATE;
6728 }
Janos Follath63028dd2019-06-13 09:15:47 +01006729
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 if (data_length != 0) {
6731 prf->label = mbedtls_calloc(1, data_length);
6732 if (prf->label == NULL) {
6733 return PSA_ERROR_INSUFFICIENT_MEMORY;
6734 }
Janos Follath63028dd2019-06-13 09:15:47 +01006735
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006737 prf->label_length = data_length;
6738 }
Janos Follath63028dd2019-06-13 09:15:47 +01006739
Gilles Peskine43f958b2020-12-13 14:55:14 +01006740 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006741
Gilles Peskine449bd832023-01-11 14:50:10 +01006742 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006743}
6744
Gilles Peskine449bd832023-01-11 14:50:10 +01006745static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6746 psa_key_derivation_step_t step,
6747 const uint8_t *data,
6748 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006749{
Gilles Peskine449bd832023-01-11 14:50:10 +01006750 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006751 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006753 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006755 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006757 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006758 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006759 }
6760}
John Durkop07cc04a2020-11-16 22:08:34 -08006761#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6762 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6763
6764#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6765static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6766 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006767 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006769{
6770 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6772 4 + data_length + prf->other_secret_length :
6773 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006774
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6776 return PSA_ERROR_INVALID_ARGUMENT;
6777 }
John Durkop07cc04a2020-11-16 22:08:34 -08006778
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 uint8_t *pms = mbedtls_calloc(1, pms_len);
6780 if (pms == NULL) {
6781 return PSA_ERROR_INSUFFICIENT_MEMORY;
6782 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006783 uint8_t *cur = pms;
6784
6785 /* pure-PSK:
6786 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006787 *
6788 * The premaster secret is formed as follows: if the PSK is N octets
6789 * long, concatenate a uint16 with the value N, N zero octets, a second
6790 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006791 *
6792 * mixed-PSK:
6793 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6794 * follows: concatenate a uint16 with the length of the other secret,
6795 * the other secret itself, uint16 with the length of PSK, and the
6796 * PSK itself.
6797 * For details please check:
6798 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6799 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6800 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006801 */
6802
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6804 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6805 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6806 if (prf->other_secret_length != 0) {
6807 memcpy(cur, prf->other_secret, prf->other_secret_length);
6808 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006809 cur += prf->other_secret_length;
6810 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 } else {
6812 *cur++ = MBEDTLS_BYTE_1(data_length);
6813 *cur++ = MBEDTLS_BYTE_0(data_length);
6814 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006815 cur += data_length;
6816 }
6817
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 *cur++ = MBEDTLS_BYTE_1(data_length);
6819 *cur++ = MBEDTLS_BYTE_0(data_length);
6820 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006821 cur += data_length;
6822
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006823 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006824
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006825 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006827}
Janos Follath6660f0e2019-06-17 08:44:03 +01006828
Przemek Stekiele47201b2022-04-19 13:53:28 +02006829static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6830 psa_tls12_prf_key_derivation_t *prf,
6831 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006833{
Gilles Peskine449bd832023-01-11 14:50:10 +01006834 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6835 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006836 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006837
6838 if (data_length != 0) {
6839 prf->other_secret = mbedtls_calloc(1, data_length);
6840 if (prf->other_secret == NULL) {
6841 return PSA_ERROR_INSUFFICIENT_MEMORY;
6842 }
6843
6844 memcpy(prf->other_secret, data, data_length);
6845 prf->other_secret_length = data_length;
6846 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006847 prf->other_secret_length = 0;
6848 }
6849
6850 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6851
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006853}
6854
Janos Follath6660f0e2019-06-17 08:44:03 +01006855static psa_status_t psa_tls12_prf_psk_to_ms_input(
6856 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006857 psa_key_derivation_step_t step,
6858 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006860{
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006862 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 return psa_tls12_prf_psk_to_ms_set_key(prf,
6864 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006865 break;
6866 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6868 data,
6869 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006870 break;
6871 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006873 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006874
Przemek Stekiele47201b2022-04-19 13:53:28 +02006875 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006876}
John Durkop07cc04a2020-11-16 22:08:34 -08006877#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006878
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006879#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6880static psa_status_t psa_tls12_ecjpake_to_pms_input(
6881 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006882 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006883 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006885{
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6887 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6888 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006889 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006890
6891 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 if (data[0] != 0x04) {
6893 return PSA_ERROR_INVALID_ARGUMENT;
6894 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006895
6896 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006897 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006898
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006900}
6901#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306902
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306903#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306904static psa_status_t psa_pbkdf2_set_input_cost(
6905 psa_pbkdf2_key_derivation_t *pbkdf2,
6906 psa_key_derivation_step_t step,
6907 uint64_t data)
6908{
6909 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6910 return PSA_ERROR_INVALID_ARGUMENT;
6911 }
6912
6913 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6914 return PSA_ERROR_BAD_STATE;
6915 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306916
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306917 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306918 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306919 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306920
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306921 if (data == 0) {
6922 return PSA_ERROR_INVALID_ARGUMENT;
6923 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306924
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306925 pbkdf2->input_cost = data;
6926 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6927
6928 return PSA_SUCCESS;
6929}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306930
6931static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6932 const uint8_t *data,
6933 size_t data_length)
6934{
Gilles Peskineead17662023-08-20 22:02:51 +02006935 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6936 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6937 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6938 /* Appending to existing salt. No state change. */
6939 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306940 return PSA_ERROR_BAD_STATE;
6941 }
6942
Gilles Peskineca57d782023-07-20 19:08:06 +02006943 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006944 /* Appending an empty string, nothing to do. */
6945 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306946 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306947
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306948 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6949 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306950 return PSA_ERROR_INSUFFICIENT_MEMORY;
6951 }
6952
Gilles Peskineead17662023-08-20 22:02:51 +02006953 if (pbkdf2->salt_length != 0) {
6954 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6955 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306956 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306957 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306958 mbedtls_free(pbkdf2->salt);
6959 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306960 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306961 return PSA_SUCCESS;
6962}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306963
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306964#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306965static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306966 const uint8_t *input,
6967 size_t input_len,
6968 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306969 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306970{
6971 psa_status_t status = PSA_SUCCESS;
6972 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6973 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306974 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306975 } else {
6976 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306977 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306978 }
6979 return status;
6980}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306981#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306982
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306983#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306984static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6985 size_t input_len,
6986 uint8_t *output,
6987 size_t *output_len)
6988{
6989 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306990 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306991 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306992 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306993 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6994 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6995 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306996 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306997 * mac_size as the driver function sets mac_output_length = mac_size
6998 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306999 status = psa_driver_wrapper_mac_compute(&attributes,
7000 zeros, sizeof(zeros),
7001 PSA_ALG_CMAC, input, input_len,
7002 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307003 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7004 128U,
7005 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307006 output_len);
7007 } else {
7008 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307009 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307010 }
7011 return status;
7012}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307013#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307014
7015static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307016 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307017 const uint8_t *data,
7018 size_t data_length)
7019{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307020 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307021 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7022 return PSA_ERROR_BAD_STATE;
7023 }
7024
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307025#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307026 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7027 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7028 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7029 pbkdf2->password,
7030 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307031 } else
7032#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7033#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7034 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307035 status = psa_pbkdf2_cmac_set_password(data, data_length,
7036 pbkdf2->password,
7037 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307038 } else
7039#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7040 {
7041 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307042 }
7043
7044 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7045
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307046 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307047}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307048
7049static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307050 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307051 psa_key_derivation_step_t step,
7052 const uint8_t *data,
7053 size_t data_length)
7054{
7055 switch (step) {
7056 case PSA_KEY_DERIVATION_INPUT_SALT:
7057 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7058 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307059 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307060 default:
7061 return PSA_ERROR_INVALID_ARGUMENT;
7062 }
7063}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307064#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307065
Gilles Peskineb8965192019-09-24 16:21:10 +02007066/** Check whether the given key type is acceptable for the given
7067 * input step of a key derivation.
7068 *
7069 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7070 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7071 * Both secret and non-secret inputs can alternatively have the type
7072 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7073 * that the input was passed as a buffer rather than via a key object.
7074 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007075static int psa_key_derivation_check_input_type(
7076 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007078{
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007080 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 if (key_type == PSA_KEY_TYPE_DERIVE) {
7082 return PSA_SUCCESS;
7083 }
7084 if (key_type == PSA_KEY_TYPE_NONE) {
7085 return PSA_SUCCESS;
7086 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007087 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007088 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 if (key_type == PSA_KEY_TYPE_DERIVE) {
7090 return PSA_SUCCESS;
7091 }
7092 if (key_type == PSA_KEY_TYPE_NONE) {
7093 return PSA_SUCCESS;
7094 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007095 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007096 case PSA_KEY_DERIVATION_INPUT_LABEL:
7097 case PSA_KEY_DERIVATION_INPUT_SALT:
7098 case PSA_KEY_DERIVATION_INPUT_INFO:
7099 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7101 return PSA_SUCCESS;
7102 }
7103 if (key_type == PSA_KEY_TYPE_NONE) {
7104 return PSA_SUCCESS;
7105 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007106 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307107 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7108 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7109 return PSA_SUCCESS;
7110 }
7111 if (key_type == PSA_KEY_TYPE_DERIVE) {
7112 return PSA_SUCCESS;
7113 }
7114 if (key_type == PSA_KEY_TYPE_NONE) {
7115 return PSA_SUCCESS;
7116 }
7117 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007118 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007120}
7121
Janos Follathb80a94e2019-06-12 15:54:46 +01007122static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007123 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007124 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007125 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007126 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007128{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007129 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007131
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 status = psa_key_derivation_check_input_type(step, key_type);
7133 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007134 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007136
Przemek Stekiel69c46792022-06-10 12:59:51 +02007137#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7139 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7140 step, data, data_length);
7141 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007142#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007143#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7145 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7146 step, data, data_length);
7147 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007148#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7149#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7151 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7152 step, data, data_length);
7153 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007154#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007155#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007157 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7159 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007160#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307161#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307162 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307163 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7164 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307165 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307166#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007167 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007168 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007169 (void) data;
7170 (void) data_length;
7171 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007173 }
7174
Gilles Peskine224b0d62019-09-23 18:13:17 +02007175exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 if (status != PSA_SUCCESS) {
7177 psa_key_derivation_abort(operation);
7178 }
7179 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007180}
7181
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307182static psa_status_t psa_key_derivation_input_integer_internal(
7183 psa_key_derivation_operation_t *operation,
7184 psa_key_derivation_step_t step,
7185 uint64_t value)
7186{
7187 psa_status_t status;
7188 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7189
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307190#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307191 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307192 status = psa_pbkdf2_set_input_cost(
7193 &operation->ctx.pbkdf2, step, value);
7194 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307195#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307196 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307197 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307198 (void) value;
7199 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307200 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307201 }
7202
7203 if (status != PSA_SUCCESS) {
7204 psa_key_derivation_abort(operation);
7205 }
7206 return status;
7207}
7208
Janos Follath51f4a0f2019-06-14 11:35:55 +01007209psa_status_t psa_key_derivation_input_bytes(
7210 psa_key_derivation_operation_t *operation,
7211 psa_key_derivation_step_t step,
7212 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007214{
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 return psa_key_derivation_input_internal(operation, step,
7216 PSA_KEY_TYPE_NONE,
7217 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007218}
7219
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307220psa_status_t psa_key_derivation_input_integer(
7221 psa_key_derivation_operation_t *operation,
7222 psa_key_derivation_step_t step,
7223 uint64_t value)
7224{
7225 return psa_key_derivation_input_integer_internal(operation, step, value);
7226}
7227
Janos Follath51f4a0f2019-06-14 11:35:55 +01007228psa_status_t psa_key_derivation_input_key(
7229 psa_key_derivation_operation_t *operation,
7230 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007231 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007232{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007233 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007234 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007235 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007236
Ronald Cron5c522922020-11-14 16:35:34 +01007237 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007238 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7239 if (status != PSA_SUCCESS) {
7240 psa_key_derivation_abort(operation);
7241 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007242 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007243
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307244 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7245 * permission to output to a key object. */
7246 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7247 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007248 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007250
Gilles Peskine449bd832023-01-11 14:50:10 +01007251 status = psa_key_derivation_input_internal(operation,
7252 step, slot->attr.type,
7253 slot->key.data,
7254 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007255
Gilles Peskine449bd832023-01-11 14:50:10 +01007256 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007257
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007259}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007260
7261
7262
7263/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007264/* Key agreement */
7265/****************************************************************/
7266
Gilles Peskine449bd832023-01-11 14:50:10 +01007267psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7268 const uint8_t *key_buffer,
7269 size_t key_buffer_size,
7270 psa_algorithm_t alg,
7271 const uint8_t *peer_key,
7272 size_t peer_key_length,
7273 uint8_t *shared_secret,
7274 size_t shared_secret_size,
7275 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007276{
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007278#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007279 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7281 key_buffer_size, alg,
7282 peer_key, peer_key_length,
7283 shared_secret,
7284 shared_secret_size,
7285 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007286#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007287
7288#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7289 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007290 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007291 peer_key,
7292 peer_key_length,
7293 key_buffer,
7294 key_buffer_size,
7295 shared_secret,
7296 shared_secret_size,
7297 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007298#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7299
Gilles Peskine01d718c2018-09-18 12:01:02 +02007300 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007301 (void) attributes;
7302 (void) key_buffer;
7303 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007304 (void) peer_key;
7305 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007306 (void) shared_secret;
7307 (void) shared_secret_size;
7308 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007310 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007311}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007312
Aditya Deshpande17845b82022-10-13 17:21:01 +01007313/** Internal function for raw key agreement
7314 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007315 * to the driver's implementation if a driver is present.
7316 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007317 * (psa_key_agreement_raw_builtin).
7318 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007319static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7320 psa_key_slot_t *private_key,
7321 const uint8_t *peer_key,
7322 size_t peer_key_length,
7323 uint8_t *shared_secret,
7324 size_t shared_secret_size,
7325 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007326{
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7328 return PSA_ERROR_NOT_SUPPORTED;
7329 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007330
7331 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007332 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007333 };
7334
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 return psa_driver_wrapper_key_agreement(&attributes,
7336 private_key->key.data,
7337 private_key->key.bytes, alg,
7338 peer_key, peer_key_length,
7339 shared_secret,
7340 shared_secret_size,
7341 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007342}
7343
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007344/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007345 * to potentially free embedded data structures and wipe confidential data.
7346 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007347static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7348 psa_key_derivation_step_t step,
7349 psa_key_slot_t *private_key,
7350 const uint8_t *peer_key,
7351 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007352{
7353 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007354 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007355 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007357
7358 /* Step 1: run the secret agreement algorithm to generate the shared
7359 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 status = psa_key_agreement_raw_internal(ka_alg,
7361 private_key,
7362 peer_key, peer_key_length,
7363 shared_secret,
7364 sizeof(shared_secret),
7365 &shared_secret_length);
7366 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007367 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007369
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007370 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007371 * the shared secret. A shared secret is permitted wherever a key
7372 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 status = psa_key_derivation_input_internal(operation, step,
7374 PSA_KEY_TYPE_DERIVE,
7375 shared_secret,
7376 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007377exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7379 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007380}
7381
Gilles Peskine449bd832023-01-11 14:50:10 +01007382psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7383 psa_key_derivation_step_t step,
7384 mbedtls_svc_key_id_t private_key,
7385 const uint8_t *peer_key,
7386 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007387{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007388 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007389 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007390 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007391
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7393 return PSA_ERROR_INVALID_ARGUMENT;
7394 }
Ronald Cron5c522922020-11-14 16:35:34 +01007395 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7397 if (status != PSA_SUCCESS) {
7398 return status;
7399 }
7400 status = psa_key_agreement_internal(operation, step,
7401 slot,
7402 peer_key, peer_key_length);
7403 if (status != PSA_SUCCESS) {
7404 psa_key_derivation_abort(operation);
7405 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007406 /* If a private key has been added as SECRET, we allow the derived
7407 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007409 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007411 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007412
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007414
Gilles Peskine449bd832023-01-11 14:50:10 +01007415 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007416}
7417
Gilles Peskine449bd832023-01-11 14:50:10 +01007418psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7419 mbedtls_svc_key_id_t private_key,
7420 const uint8_t *peer_key,
7421 size_t peer_key_length,
7422 uint8_t *output,
7423 size_t output_size,
7424 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007425{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007426 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007427 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007428 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007429 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007430
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007432 status = PSA_ERROR_INVALID_ARGUMENT;
7433 goto exit;
7434 }
Ronald Cron5c522922020-11-14 16:35:34 +01007435 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7437 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007438 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007440
Gilles Peskine3e561302022-04-14 00:17:15 +02007441 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7442 * for the output size. The PSA specification only guarantees that this
7443 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7444 * but it might be nice to allow smaller buffers if the output fits.
7445 * At the time of writing this comment, with only ECDH implemented,
7446 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7447 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7448 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007449 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7451 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007452 status = PSA_ERROR_BUFFER_TOO_SMALL;
7453 goto exit;
7454 }
7455
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 status = psa_key_agreement_raw_internal(alg, slot,
7457 peer_key, peer_key_length,
7458 output, output_size,
7459 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007460
7461exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007463 /* If an error happens and is not handled properly, the output
7464 * may be used as a key to protect sensitive data. Arrange for such
7465 * a key to be random, which is likely to result in decryption or
7466 * verification errors. This is better than filling the buffer with
7467 * some constant data such as zeros, which would result in the data
7468 * being protected with a reproducible, easily knowable key.
7469 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007471 *output_length = output_size;
7472 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007473
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007475
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007477}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007478
7479
Gilles Peskine30524eb2020-11-13 17:02:26 +01007480
Gilles Peskine86a440b2018-11-12 18:39:40 +01007481/****************************************************************/
7482/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007483/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007484
Gilles Peskine672a7712023-04-28 21:00:28 +02007485#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7486#include "entropy_poll.h"
7487#endif
7488
Gilles Peskine30524eb2020-11-13 17:02:26 +01007489/** Initialize the PSA random generator.
7490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007491static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007492{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007493#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007495#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7496
Gilles Peskine30524eb2020-11-13 17:02:26 +01007497 /* Set default configuration if
7498 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007500 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 }
7502 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007503 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007505
Gilles Peskine449bd832023-01-11 14:50:10 +01007506 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007507#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7508 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7509 /* The PSA entropy injection feature depends on using NV seed as an entropy
7510 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 mbedtls_entropy_add_source(&rng->entropy,
7512 mbedtls_nv_seed_poll, NULL,
7513 MBEDTLS_ENTROPY_BLOCK_SIZE,
7514 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007515#endif
7516
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007518#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007519}
7520
7521/** Deinitialize the PSA random generator.
7522 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007523static void mbedtls_psa_random_free(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)
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007527#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7529 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007530#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007531}
7532
7533/** Seed the PSA random generator.
7534 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007535static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007536{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007537#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7538 /* Do nothing: the external RNG seeds itself. */
7539 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007541#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007542 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7544 drbg_seed, sizeof(drbg_seed) - 1);
7545 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007546#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007547}
7548
Gilles Peskine449bd832023-01-11 14:50:10 +01007549psa_status_t psa_generate_random(uint8_t *output,
7550 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007551{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007552 GUARD_MODULE_INITIALIZED;
7553
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007554#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7555
7556 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7558 output, output_size,
7559 &output_length);
7560 if (status != PSA_SUCCESS) {
7561 return status;
7562 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007563 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007564 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 if (output_length != output_size) {
7566 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7567 }
7568 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007569
7570#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7571
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007573 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7575 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7576 output_size);
7577 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7578 output, request_size);
7579 if (ret != 0) {
7580 return mbedtls_to_psa_error(ret);
7581 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007582 output_size -= request_size;
7583 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007584 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007586#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007587}
7588
Gilles Peskine8814fc42020-12-14 15:33:44 +01007589/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007590 *
7591 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7592 * `psa_generate_random(...)`. The state parameter is ignored since the
7593 * PSA API doesn't support passing an explicit state.
7594 *
7595 * In the non-external case, psa_generate_random() calls an
7596 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7597 * and semantics as mbedtls_psa_get_random(). As an optimization,
7598 * instead of doing this back-and-forth between the PSA API and the
7599 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7600 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007601 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007602#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7603int mbedtls_psa_get_random(void *p_rng,
7604 unsigned char *output,
7605 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007606{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007607 /* This function takes a pointer to the RNG state because that's what
7608 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7609 * its own state internally and doesn't let the caller access that state.
7610 * So we just ignore the state parameter, and in practice we'll pass
7611 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007612 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 psa_status_t status = psa_generate_random(output, output_size);
7614 if (status == PSA_SUCCESS) {
7615 return 0;
7616 } else {
7617 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7618 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007619}
7620#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7621
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007622#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007623psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7624 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007625{
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 if (global_data.initialized) {
7627 return PSA_ERROR_NOT_PERMITTED;
7628 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7631 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7632 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7633 return PSA_ERROR_INVALID_ARGUMENT;
7634 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007635
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007637}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007638#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007639
Ronald Cron3772afe2021-02-08 16:10:05 +01007640/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007641 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007642 * \param type The key type
7643 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007644 *
7645 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007646 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007647 * \retval #PSA_ERROR_INVALID_ARGUMENT
7648 * The size in bits of the key is not valid.
7649 * \retval #PSA_ERROR_NOT_SUPPORTED
7650 * The type and/or the size in bits of the key or the combination of
7651 * the two is not supported.
7652 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007653static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007655{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007656 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007657
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 if (key_type_is_raw_bytes(type)) {
7659 status = psa_validate_unstructured_key_bit_size(type, bits);
7660 if (status != PSA_SUCCESS) {
7661 return status;
7662 }
7663 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007664#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7666 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7667 return PSA_ERROR_NOT_SUPPORTED;
7668 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007669 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007670 return PSA_ERROR_NOT_SUPPORTED;
7671 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007672
Ronald Cron01b2aba2020-10-05 09:42:02 +02007673 /* Accept only byte-aligned keys, for the same reasons as
7674 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 if (bits % 8 != 0) {
7676 return PSA_ERROR_NOT_SUPPORTED;
7677 }
7678 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007679#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007680
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007681#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007682 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007683 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 return PSA_SUCCESS;
7685 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007686#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007687
Valerio Settia55f0422023-07-10 15:34:41 +02007688#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007689 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007690 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007691 return PSA_ERROR_NOT_SUPPORTED;
7692 }
7693 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007694#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007695 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007697 }
7698
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007700}
7701
Ronald Cron55ed0592020-10-05 10:30:40 +02007702psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007703 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007705{
7706 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007707 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007708
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 if ((attributes->domain_parameters == NULL) &&
7710 (attributes->domain_parameters_size != 0)) {
7711 return PSA_ERROR_INVALID_ARGUMENT;
7712 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007713
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 if (key_type_is_raw_bytes(type)) {
7715 status = psa_generate_random(key_buffer, key_buffer_size);
7716 if (status != PSA_SUCCESS) {
7717 return status;
7718 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007719
David Brown12ca5032021-02-11 11:02:00 -07007720#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 if (type == PSA_KEY_TYPE_DES) {
7722 psa_des_set_key_parity(key_buffer, key_buffer_size);
7723 }
David Brown8107e312021-02-12 08:08:46 -07007724#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007726
Valerio Setti76df8c12023-07-11 14:11:28 +02007727#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7729 return mbedtls_psa_rsa_generate_key(attributes,
7730 key_buffer,
7731 key_buffer_size,
7732 key_buffer_length);
7733 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007734#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007735
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007736#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7738 return mbedtls_psa_ecp_generate_key(attributes,
7739 key_buffer,
7740 key_buffer_size,
7741 key_buffer_length);
7742 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007743#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007744
Valerio Settia55f0422023-07-10 15:34:41 +02007745#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007746 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7747 return mbedtls_psa_ffdh_generate_key(attributes,
7748 key_buffer,
7749 key_buffer_size,
7750 key_buffer_length);
7751 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007752#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007753 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 (void) key_buffer_length;
7755 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007756 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007757
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007759}
Darryl Green0c6575a2018-11-07 16:05:30 +00007760
Gilles Peskine449bd832023-01-11 14:50:10 +01007761psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7762 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007763{
7764 psa_status_t status;
7765 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007766 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007767 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007768
Ronald Cron81709fc2020-11-14 12:10:32 +01007769 *key = MBEDTLS_SVC_KEY_ID_INIT;
7770
Gilles Peskine0f84d622019-09-12 19:03:13 +02007771 /* Reject any attempt to create a zero-length key so that we don't
7772 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007773 if (psa_get_key_bits(attributes) == 0) {
7774 return PSA_ERROR_INVALID_ARGUMENT;
7775 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007776
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007777 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7779 return PSA_ERROR_INVALID_ARGUMENT;
7780 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007781
Gilles Peskine449bd832023-01-11 14:50:10 +01007782 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7783 &slot, &driver);
7784 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007785 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 }
Gilles Peskine11792082019-08-06 18:36:36 +02007787
Ronald Cron977c2472020-10-13 08:32:21 +02007788 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307789 * storage ( thus not in the case of generating a key in a secure element
7790 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7791 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007792 if (slot->key.data == NULL) {
7793 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7794 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007795 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 attributes->core.type, attributes->core.bits);
7797 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007798 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007800
7801 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 attributes->core.type,
7803 attributes->core.bits);
7804 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007805 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 attributes, &key_buffer_size);
7807 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007808 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 }
Ronald Cron977c2472020-10-13 08:32:21 +02007810 }
Ronald Cron977c2472020-10-13 08:32:21 +02007811
Gilles Peskine449bd832023-01-11 14:50:10 +01007812 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7813 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007814 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 }
Ronald Cron977c2472020-10-13 08:32:21 +02007816 }
7817
Gilles Peskine449bd832023-01-11 14:50:10 +01007818 status = psa_driver_wrapper_generate_key(attributes,
7819 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007820
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 if (status != PSA_SUCCESS) {
7822 psa_remove_key_data_from_memory(slot);
7823 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007824
Gilles Peskine11792082019-08-06 18:36:36 +02007825exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 if (status == PSA_SUCCESS) {
7827 status = psa_finish_key_creation(slot, driver, key);
7828 }
7829 if (status != PSA_SUCCESS) {
7830 psa_fail_key_creation(slot, driver);
7831 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007832
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007834}
7835
Gilles Peskinee59236f2018-01-27 23:32:46 +01007836/****************************************************************/
7837/* Module setup */
7838/****************************************************************/
7839
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007840#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007841psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 void (* entropy_init)(mbedtls_entropy_context *ctx),
7843 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007844{
Gilles Peskine449bd832023-01-11 14:50:10 +01007845 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7846 return PSA_ERROR_BAD_STATE;
7847 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007848 global_data.rng.entropy_init = entropy_init;
7849 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007850 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007851}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007852#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007853
Gilles Peskine449bd832023-01-11 14:50:10 +01007854void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007855{
Gilles Peskine449bd832023-01-11 14:50:10 +01007856 psa_wipe_all_key_slots();
7857 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7858 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007859 }
7860 /* Wipe all remaining data, including configuration.
7861 * In particular, this sets all state indicator to the value
7862 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007864
7865 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007867}
7868
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007869#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7870/** Recover a transaction that was interrupted by a power failure.
7871 *
7872 * This function is called during initialization, before psa_crypto_init()
7873 * returns. If this function returns a failure status, the initialization
7874 * fails.
7875 */
7876static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007878{
Gilles Peskine449bd832023-01-11 14:50:10 +01007879 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007880 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7881 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 /* TODO - fall through to the failure case until this
7883 * is implemented.
7884 * https://github.com/ARMmbed/mbed-crypto/issues/218
7885 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007886 default:
7887 /* We found an unsupported transaction in the storage.
7888 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007889 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007890 }
7891}
7892#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7893
Gilles Peskine449bd832023-01-11 14:50:10 +01007894psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007895{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007896 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007897
Gilles Peskinec6b69072018-11-20 21:42:52 +01007898 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007899 if (global_data.initialized != 0) {
7900 return PSA_SUCCESS;
7901 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007902
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007903 /* Init drivers */
7904 status = psa_driver_wrapper_init();
7905 if (status != PSA_SUCCESS) {
7906 goto exit;
7907 }
7908 global_data.drivers_initialized = 1;
7909
Gilles Peskine30524eb2020-11-13 17:02:26 +01007910 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007912 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 status = mbedtls_psa_random_seed(&global_data.rng);
7914 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007915 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007917 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007918
Gilles Peskine449bd832023-01-11 14:50:10 +01007919 status = psa_initialize_key_slots();
7920 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01007921 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007923
Gilles Peskine4b734222019-07-24 15:56:31 +02007924#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007925 status = psa_crypto_load_transaction();
7926 if (status == PSA_SUCCESS) {
7927 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7928 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007929 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 }
7931 status = psa_crypto_stop_transaction();
7932 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007933 /* There's no transaction to complete. It's all good. */
7934 status = PSA_SUCCESS;
7935 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007936#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007937
Gilles Peskinec6b69072018-11-20 21:42:52 +01007938 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007939 global_data.initialized = 1;
7940
7941exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 if (status != PSA_SUCCESS) {
7943 mbedtls_psa_crypto_free();
7944 }
7945 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007946}
7947
Yanray Wangffc3c482023-07-11 12:01:04 +08007948#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007949psa_status_t psa_crypto_driver_pake_get_password_len(
7950 const psa_crypto_driver_pake_inputs_t *inputs,
7951 size_t *password_len)
7952{
7953 if (inputs->password_len == 0) {
7954 return PSA_ERROR_BAD_STATE;
7955 }
7956
7957 *password_len = inputs->password_len;
7958
7959 return PSA_SUCCESS;
7960}
7961
7962psa_status_t psa_crypto_driver_pake_get_password(
7963 const psa_crypto_driver_pake_inputs_t *inputs,
7964 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7965{
7966 if (inputs->password_len == 0) {
7967 return PSA_ERROR_BAD_STATE;
7968 }
7969
7970 if (buffer_size < inputs->password_len) {
7971 return PSA_ERROR_BUFFER_TOO_SMALL;
7972 }
7973
7974 memcpy(buffer, inputs->password, inputs->password_len);
7975 *buffer_length = inputs->password_len;
7976
7977 return PSA_SUCCESS;
7978}
7979
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007980psa_status_t psa_crypto_driver_pake_get_user_len(
7981 const psa_crypto_driver_pake_inputs_t *inputs,
7982 size_t *user_len)
7983{
7984 if (inputs->user_len == 0) {
7985 return PSA_ERROR_BAD_STATE;
7986 }
7987
7988 *user_len = inputs->user_len;
7989
7990 return PSA_SUCCESS;
7991}
7992
7993psa_status_t psa_crypto_driver_pake_get_user(
7994 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007995 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007996{
7997 if (inputs->user_len == 0) {
7998 return PSA_ERROR_BAD_STATE;
7999 }
8000
Przemek Stekielc0e62502023-03-14 11:49:36 +01008001 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008002 return PSA_ERROR_BUFFER_TOO_SMALL;
8003 }
8004
Przemek Stekielc0e62502023-03-14 11:49:36 +01008005 memcpy(user_id, inputs->user, inputs->user_len);
8006 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008007
8008 return PSA_SUCCESS;
8009}
8010
8011psa_status_t psa_crypto_driver_pake_get_peer_len(
8012 const psa_crypto_driver_pake_inputs_t *inputs,
8013 size_t *peer_len)
8014{
8015 if (inputs->peer_len == 0) {
8016 return PSA_ERROR_BAD_STATE;
8017 }
8018
8019 *peer_len = inputs->peer_len;
8020
8021 return PSA_SUCCESS;
8022}
8023
8024psa_status_t psa_crypto_driver_pake_get_peer(
8025 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008026 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008027{
8028 if (inputs->peer_len == 0) {
8029 return PSA_ERROR_BAD_STATE;
8030 }
8031
Przemek Stekielc0e62502023-03-14 11:49:36 +01008032 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008033 return PSA_ERROR_BUFFER_TOO_SMALL;
8034 }
8035
Przemek Stekielc0e62502023-03-14 11:49:36 +01008036 memcpy(peer_id, inputs->peer, inputs->peer_len);
8037 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008038
8039 return PSA_SUCCESS;
8040}
8041
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008042psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8043 const psa_crypto_driver_pake_inputs_t *inputs,
8044 psa_pake_cipher_suite_t *cipher_suite)
8045{
8046 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8047 return PSA_ERROR_BAD_STATE;
8048 }
8049
8050 *cipher_suite = inputs->cipher_suite;
8051
8052 return PSA_SUCCESS;
8053}
8054
Neil Armstronga7d08c32022-06-01 18:21:20 +02008055psa_status_t psa_pake_setup(
8056 psa_pake_operation_t *operation,
8057 const psa_pake_cipher_suite_t *cipher_suite)
8058{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008059 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008060
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008061 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008062 status = PSA_ERROR_BAD_STATE;
8063 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008064 }
8065
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008066 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008067 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008068 status = PSA_ERROR_INVALID_ARGUMENT;
8069 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008070 }
8071
Przemek Stekiel51eac532022-12-07 11:04:51 +01008072 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8073
Przemek Stekiele12ed362022-12-21 12:54:46 +01008074 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008075 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8076 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008077 operation->data.inputs.cipher_suite = *cipher_suite;
8078
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008079#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008080 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008081 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008082 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008083
David Horstmann16f01512023-06-14 17:21:07 +01008084 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008085 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008086 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008087#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008088 {
8089 status = PSA_ERROR_NOT_SUPPORTED;
8090 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008091 }
8092
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008093 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8094
Przemek Stekiel51eac532022-12-07 11:04:51 +01008095 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008096exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008097 psa_pake_abort(operation);
8098 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008099}
8100
8101psa_status_t psa_pake_set_password_key(
8102 psa_pake_operation_t *operation,
8103 mbedtls_svc_key_id_t password)
8104{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008105 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008106 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8107 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008108 psa_key_attributes_t attributes;
8109 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008110
Przemek Stekiel51eac532022-12-07 11:04:51 +01008111 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008112 status = PSA_ERROR_BAD_STATE;
8113 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008114 }
8115
Przemek Stekiel6c764412022-11-22 14:05:12 +01008116 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8117 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008118 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008119 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008120 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008121 }
8122
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008123 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008124 .core = slot->attr
8125 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008126
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008127 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008128
Przemek Stekiel51eac532022-12-07 11:04:51 +01008129 if (type != PSA_KEY_TYPE_PASSWORD &&
8130 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8131 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008132 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008133 }
8134
Przemek Stekiel51eac532022-12-07 11:04:51 +01008135 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8136 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008137 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008138 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008139 }
8140
8141 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8142 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008143 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008144exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008145 if (status != PSA_SUCCESS) {
8146 psa_pake_abort(operation);
8147 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008148 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008149 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008150}
8151
8152psa_status_t psa_pake_set_user(
8153 psa_pake_operation_t *operation,
8154 const uint8_t *user_id,
8155 size_t user_id_len)
8156{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008157 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008158
8159 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008160 status = PSA_ERROR_BAD_STATE;
8161 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008162 }
8163
Przemek Stekiel51eac532022-12-07 11:04:51 +01008164 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008165 status = PSA_ERROR_INVALID_ARGUMENT;
8166 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008167 }
8168
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008169 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008170 status = PSA_ERROR_BAD_STATE;
8171 goto exit;
8172 }
8173
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008174 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8175 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008176 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8177 goto exit;
8178 }
8179
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008180 memcpy(operation->data.inputs.user, user_id, user_id_len);
8181 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008182
8183 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008184exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008185 psa_pake_abort(operation);
8186 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008187}
8188
8189psa_status_t psa_pake_set_peer(
8190 psa_pake_operation_t *operation,
8191 const uint8_t *peer_id,
8192 size_t peer_id_len)
8193{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008194 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008195
8196 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008197 status = PSA_ERROR_BAD_STATE;
8198 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008199 }
8200
Przemek Stekiel51eac532022-12-07 11:04:51 +01008201 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008202 status = PSA_ERROR_INVALID_ARGUMENT;
8203 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008204 }
8205
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008206 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008207 status = PSA_ERROR_BAD_STATE;
8208 goto exit;
8209 }
8210
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008211 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8212 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008213 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8214 goto exit;
8215 }
8216
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008217 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8218 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008219
8220 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008221exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008222 psa_pake_abort(operation);
8223 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008224}
8225
8226psa_status_t psa_pake_set_role(
8227 psa_pake_operation_t *operation,
8228 psa_pake_role_t role)
8229{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008230 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008231
Przemek Stekiel51eac532022-12-07 11:04:51 +01008232 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008233 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008234 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008235 }
8236
Przemek Stekiel09104b82023-03-06 14:11:51 +01008237 switch (operation->alg) {
8238#if defined(PSA_WANT_ALG_JPAKE)
8239 case PSA_ALG_JPAKE:
8240 if (role == PSA_PAKE_ROLE_NONE) {
8241 return PSA_SUCCESS;
8242 }
8243 status = PSA_ERROR_INVALID_ARGUMENT;
8244 break;
8245#endif
8246 default:
8247 (void) role;
8248 status = PSA_ERROR_NOT_SUPPORTED;
8249 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008250 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008251exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008252 psa_pake_abort(operation);
8253 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008254}
8255
David Horstmanne7f21e62023-05-12 18:17:21 +01008256/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008257#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008258static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008259 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008260{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008261 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008262 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008263 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008264
David Horstmann024e5c52023-06-14 15:48:21 +01008265 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008266 is_x1 = (stage->outputs < 1);
8267 } else {
8268 is_x1 = (stage->inputs < 1);
8269 }
8270
David Horstmann74a3d8c2023-06-14 18:28:19 +01008271 key_share_step = is_x1 ?
8272 PSA_JPAKE_X1_STEP_KEY_SHARE :
8273 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008274 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008275 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8276 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8277 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8278 } else {
8279 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008280 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008281 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008282}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008283#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008284
Przemek Stekiel2797d372022-12-22 11:19:22 +01008285static psa_status_t psa_pake_complete_inputs(
8286 psa_pake_operation_t *operation)
8287{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008288 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008289 /* Create copy of the inputs on stack as inputs share memory
8290 with the driver context which will be setup by the driver. */
8291 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008292
Przemek Stekielfde11282023-03-13 16:06:09 +01008293 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008294 return PSA_ERROR_BAD_STATE;
8295 }
8296
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008297 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008298 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8299 return PSA_ERROR_BAD_STATE;
8300 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008301 }
8302
Przemek Stekiel18620a32023-01-17 16:34:52 +01008303 /* Clear driver context */
8304 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8305
8306 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008307
8308 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008309 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008310
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008311 /* User and peer are translated to role. */
8312 mbedtls_free(inputs.user);
8313 mbedtls_free(inputs.peer);
8314
Przemek Stekiel2797d372022-12-22 11:19:22 +01008315 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008316#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008317 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008318 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008319 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008320#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008321 {
8322 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008323 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008324 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008325 return status;
8326}
8327
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008328#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008329static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008330 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008331 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008332 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008333{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008334 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8335 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8336 step != PSA_PAKE_STEP_ZK_PROOF) {
8337 return PSA_ERROR_INVALID_ARGUMENT;
8338 }
8339
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008340 psa_jpake_computation_stage_t *computation_stage =
8341 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008342
David Horstmann5da95602023-06-08 15:37:12 +01008343 if (computation_stage->round != PSA_JPAKE_FIRST &&
8344 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008345 return PSA_ERROR_BAD_STATE;
8346 }
8347
David Horstmanne7f21e62023-05-12 18:17:21 +01008348 /* Check that the step we are given is the one we were expecting */
8349 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008350 return PSA_ERROR_BAD_STATE;
8351 }
8352
David Horstmanne7f21e62023-05-12 18:17:21 +01008353 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8354 computation_stage->inputs == 0 &&
8355 computation_stage->outputs == 0) {
8356 /* Start of the round, so function decides whether we are inputting
8357 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008358 computation_stage->io_mode = io_mode;
8359 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008360 /* Middle of the round so the mode we are in must match the function
8361 * called by the user */
8362 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008363 }
8364
8365 return PSA_SUCCESS;
8366}
8367
David Horstmanne7f21e62023-05-12 18:17:21 +01008368static psa_status_t psa_jpake_epilogue(
8369 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008370 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008371{
David Horstmanne7f21e62023-05-12 18:17:21 +01008372 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008373 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008374
David Horstmanne7f21e62023-05-12 18:17:21 +01008375 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8376 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008377 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008378 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008379 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008380 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008381 }
8382 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008383 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008384 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008385 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008386 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008387 }
8388 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008389 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8390 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008391 /* End of a round, move to the next round */
8392 stage->inputs = 0;
8393 stage->outputs = 0;
8394 stage->round++;
8395 }
8396 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008397 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008398 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008399 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008400 return PSA_SUCCESS;
8401}
David Horstmanne7f21e62023-05-12 18:17:21 +01008402
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008403#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008404
Neil Armstronga7d08c32022-06-01 18:21:20 +02008405psa_status_t psa_pake_output(
8406 psa_pake_operation_t *operation,
8407 psa_pake_step_t step,
8408 uint8_t *output,
8409 size_t output_size,
8410 size_t *output_length)
8411{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008412 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008413 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008414 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008415
8416 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008417 status = psa_pake_complete_inputs(operation);
8418 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008419 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008420 }
8421 }
8422
8423 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008424 status = PSA_ERROR_BAD_STATE;
8425 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008426 }
8427
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008428 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008429 status = PSA_ERROR_INVALID_ARGUMENT;
8430 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008431 }
8432
Przemek Stekiele12ed362022-12-21 12:54:46 +01008433 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008434#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008435 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008436 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008437 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008438 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008439 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008440 driver_step = convert_jpake_computation_stage_to_driver_step(
8441 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008442 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008443#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008444 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008445 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008446 status = PSA_ERROR_NOT_SUPPORTED;
8447 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008448 }
8449
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008450 status = psa_driver_wrapper_pake_output(operation, driver_step,
8451 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008452
8453 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008454 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008455 }
8456
8457 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008458#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008459 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008460 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008461 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008462 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008463 }
8464 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008465#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008466 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008467 status = PSA_ERROR_NOT_SUPPORTED;
8468 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008469 }
8470
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008471 return PSA_SUCCESS;
8472exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008473 psa_pake_abort(operation);
8474 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008475}
8476
8477psa_status_t psa_pake_input(
8478 psa_pake_operation_t *operation,
8479 psa_pake_step_t step,
8480 const uint8_t *input,
8481 size_t input_length)
8482{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008483 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008484 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008485 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8486 operation->primitive,
8487 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008488
8489 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008490 status = psa_pake_complete_inputs(operation);
8491 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008492 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008493 }
8494 }
8495
8496 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008497 status = PSA_ERROR_BAD_STATE;
8498 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008499 }
8500
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008501 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008502 status = PSA_ERROR_INVALID_ARGUMENT;
8503 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008504 }
8505
Przemek Stekiele12ed362022-12-21 12:54:46 +01008506 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008507#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008508 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008509 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008510 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008511 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008512 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008513 driver_step = convert_jpake_computation_stage_to_driver_step(
8514 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008515 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008516#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008517 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008518 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008519 status = PSA_ERROR_NOT_SUPPORTED;
8520 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008521 }
8522
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008523 status = psa_driver_wrapper_pake_input(operation, driver_step,
8524 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008525
8526 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008527 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008528 }
8529
8530 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008531#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008532 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008533 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008534 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008535 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008536 }
8537 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008538#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008539 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008540 status = PSA_ERROR_NOT_SUPPORTED;
8541 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008542 }
8543
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008544 return PSA_SUCCESS;
8545exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008546 psa_pake_abort(operation);
8547 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008548}
8549
8550psa_status_t psa_pake_get_implicit_key(
8551 psa_pake_operation_t *operation,
8552 psa_key_derivation_operation_t *output)
8553{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008554 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008555 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008556 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008557 size_t shared_key_len = 0;
8558
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008559 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008560 status = PSA_ERROR_BAD_STATE;
8561 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008562 }
8563
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008564#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008565 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008566 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008567 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008568 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008569 status = PSA_ERROR_BAD_STATE;
8570 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008571 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008572 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008573#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008574 {
8575 status = PSA_ERROR_NOT_SUPPORTED;
8576 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008577 }
8578
Przemek Stekiel0c781802022-11-29 14:53:13 +01008579 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8580 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008581 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008582 &shared_key_len);
8583
8584 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008585 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008586 }
8587
8588 status = psa_key_derivation_input_bytes(output,
8589 PSA_KEY_DERIVATION_INPUT_SECRET,
8590 shared_key,
8591 shared_key_len);
8592
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008593 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008594exit:
8595 abort_status = psa_pake_abort(operation);
8596 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008597}
8598
8599psa_status_t psa_pake_abort(
8600 psa_pake_operation_t *operation)
8601{
Przemek Stekield69dca92023-01-31 19:59:20 +01008602 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008603
Przemek Stekield69dca92023-01-31 19:59:20 +01008604 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008605 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008606 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008607
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008608 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8609 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008610 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008611 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008612 }
8613 if (operation->data.inputs.user != NULL) {
8614 mbedtls_free(operation->data.inputs.user);
8615 }
8616 if (operation->data.inputs.peer != NULL) {
8617 mbedtls_free(operation->data.inputs.peer);
8618 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008619 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008620 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008621
Przemek Stekield69dca92023-01-31 19:59:20 +01008622 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008623}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008624#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008625
David Horstmann00d7a042023-12-07 18:39:17 +00008626/* Memory copying test hooks. These are called before input copy, after input
8627 * copy, before output copy and after output copy, respectively.
8628 * They are used by memory-poisoning tests to temporarily unpoison buffers
8629 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008630#if defined(MBEDTLS_TEST_HOOKS)
8631void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8632void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8633void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8634void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8635#endif
David Horstmannfde97392023-10-30 20:29:43 +00008636
David Horstmann1b7279a2023-11-15 15:18:30 +00008637/** Copy from an input buffer to a local copy.
8638 *
8639 * \param[in] input Pointer to input buffer.
8640 * \param[in] input_len Length of the input buffer.
8641 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8642 * \param[out] input_copy_len Length of the local copy buffer.
8643 * \return #PSA_SUCCESS, if the buffer was successfully
8644 * copied.
8645 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8646 * copy is too small to hold contents of the
8647 * input buffer.
8648 */
8649MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008650psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8651 uint8_t *input_copy, size_t input_copy_len)
8652{
8653 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008654 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008655 }
8656
David Horstmann372b8bb2023-11-24 16:21:04 +00008657#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008658 if (psa_input_pre_copy_hook != NULL) {
8659 psa_input_pre_copy_hook(input, input_len);
8660 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008661#endif
8662
David Horstmann777e7412023-11-15 17:33:47 +00008663 if (input_len > 0) {
8664 memcpy(input_copy, input, input_len);
8665 }
David Horstmannfde97392023-10-30 20:29:43 +00008666
David Horstmann372b8bb2023-11-24 16:21:04 +00008667#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008668 if (psa_input_post_copy_hook != NULL) {
8669 psa_input_post_copy_hook(input, input_len);
8670 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008671#endif
8672
David Horstmannfde97392023-10-30 20:29:43 +00008673 return PSA_SUCCESS;
8674}
8675
David Horstmann1b7279a2023-11-15 15:18:30 +00008676/** Copy from a local output buffer into a user-supplied one.
8677 *
8678 * \param[in] output_copy Pointer to a local buffer containing the output.
8679 * \param[in] output_copy_len Length of the local buffer.
8680 * \param[out] output Pointer to user-supplied output buffer.
8681 * \param[out] output_len Length of the user-supplied output buffer.
8682 * \return #PSA_SUCCESS, if the buffer was successfully
8683 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008684 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008685 * user-supplied output buffer is too small to
8686 * hold the contents of the local buffer.
8687 */
8688MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008689psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8690 uint8_t *output, size_t output_len)
8691{
8692 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008693 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008694 }
David Horstmann777e7412023-11-15 17:33:47 +00008695
David Horstmann372b8bb2023-11-24 16:21:04 +00008696#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008697 if (psa_output_pre_copy_hook != NULL) {
8698 psa_output_pre_copy_hook(output, output_len);
8699 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008700#endif
8701
David Horstmann777e7412023-11-15 17:33:47 +00008702 if (output_copy_len > 0) {
8703 memcpy(output, output_copy, output_copy_len);
8704 }
8705
David Horstmann372b8bb2023-11-24 16:21:04 +00008706#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008707 if (psa_output_post_copy_hook != NULL) {
8708 psa_output_post_copy_hook(output, output_len);
8709 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008710#endif
8711
David Horstmann8978f5c2023-10-30 20:37:12 +00008712 return PSA_SUCCESS;
8713}
8714
David Horstmannf1734052023-11-20 17:15:32 +00008715psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8716 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008717{
8718 psa_status_t status;
8719
David Horstmann9db14482023-11-23 15:50:37 +00008720 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008721
David Horstmannc5cc1c32023-11-15 18:11:26 +00008722 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008723 return PSA_SUCCESS;
8724 }
8725
David Horstmannf1734052023-11-20 17:15:32 +00008726 local_input->buffer = mbedtls_calloc(input_len, 1);
8727 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008728 /* Since we dealt with the zero-length case above, we know that
8729 * a NULL return value means a failure of allocation. */
8730 return PSA_ERROR_INSUFFICIENT_MEMORY;
8731 }
David Horstmannf1734052023-11-20 17:15:32 +00008732 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008733
David Horstmannf1734052023-11-20 17:15:32 +00008734 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008735
8736 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008737 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008738 if (status != PSA_SUCCESS) {
8739 goto error;
8740 }
8741
8742 return PSA_SUCCESS;
8743
8744error:
David Horstmannf1734052023-11-20 17:15:32 +00008745 mbedtls_free(local_input->buffer);
8746 local_input->buffer = NULL;
8747 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008748 return status;
8749}
8750
David Horstmannf1734052023-11-20 17:15:32 +00008751void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008752{
David Horstmannf1734052023-11-20 17:15:32 +00008753 mbedtls_free(local_input->buffer);
8754 local_input->buffer = NULL;
8755 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008756}
8757
David Horstmann89875a42023-11-20 12:54:09 +00008758psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8759 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008760{
David Horstmann9db14482023-11-23 15:50:37 +00008761 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008762
David Horstmannc5cc1c32023-11-15 18:11:26 +00008763 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008764 return PSA_SUCCESS;
8765 }
David Horstmann89875a42023-11-20 12:54:09 +00008766 local_output->buffer = mbedtls_calloc(output_len, 1);
8767 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008768 /* Since we dealt with the zero-length case above, we know that
8769 * a NULL return value means a failure of allocation. */
8770 return PSA_ERROR_INSUFFICIENT_MEMORY;
8771 }
David Horstmann89875a42023-11-20 12:54:09 +00008772 local_output->length = output_len;
8773 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008774
8775 return PSA_SUCCESS;
8776}
8777
Gabor Mezei1882c512024-01-24 13:07:17 +01008778psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8779 psa_crypto_local_output_t *local_output)
8780{
8781 psa_status_t status;
8782 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8783
8784 if (output_len == 0) {
8785 return PSA_SUCCESS;
8786 }
8787 local_output->buffer = mbedtls_calloc(output_len, 1);
8788 if (local_output->buffer == NULL) {
8789 /* Since we dealt with the zero-length case above, we know that
8790 * a NULL return value means a failure of allocation. */
8791 return PSA_ERROR_INSUFFICIENT_MEMORY;
8792 }
8793 local_output->length = output_len;
8794 local_output->original = output;
8795
8796 status = psa_crypto_copy_input(output, output_len,
8797 local_output->buffer, local_output->length);
8798 if (status != PSA_SUCCESS) {
8799 goto error;
8800 }
8801
8802 return PSA_SUCCESS;
8803
8804error:
8805 mbedtls_free(local_output->buffer);
8806 local_output->buffer = NULL;
8807 local_output->length = 0;
8808 return status;
8809}
8810
David Horstmann89875a42023-11-20 12:54:09 +00008811psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008812{
David Horstmannc335a4e2023-11-15 15:57:32 +00008813 psa_status_t status;
8814
David Horstmann89875a42023-11-20 12:54:09 +00008815 if (local_output->buffer == NULL) {
8816 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008817 return PSA_SUCCESS;
8818 }
David Horstmann89875a42023-11-20 12:54:09 +00008819 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008820 /* We have an internal copy but nothing to copy back to. */
8821 return PSA_ERROR_CORRUPTION_DETECTED;
8822 }
8823
David Horstmann89875a42023-11-20 12:54:09 +00008824 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8825 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008826 if (status != PSA_SUCCESS) {
8827 return status;
8828 }
David Horstmann9467ea32023-11-08 17:44:18 +00008829
David Horstmann89875a42023-11-20 12:54:09 +00008830 mbedtls_free(local_output->buffer);
8831 local_output->buffer = NULL;
8832 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008833
8834 return PSA_SUCCESS;
8835}
8836
Gilles Peskinee59236f2018-01-27 23:32:46 +01008837#endif /* MBEDTLS_PSA_CRYPTO_C */