blob: 7830f40f46664e025f210ec4e81a0ca12632ed92 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskinee59236f2018-01-27 23:32:46 +01007 */
8
Gilles Peskinedb09ef62020-06-03 01:43:33 +02009#include "common.h"
Ronald Cronafbc7ed2023-01-24 16:02:04 +010010#include "psa_crypto_core_common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010011
12#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030013
John Durkop07cc04a2020-11-16 22:08:34 -080014#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
15#include "check_crypto_config.h"
16#endif
17
Gilles Peskinee59236f2018-01-27 23:32:46 +010018#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010019#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010020
Ronald Crond6d28882020-12-14 14:56:02 +010021#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010022#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010023#include "psa_crypto_invasive.h"
Xiaokang Qiane9c39c42023-08-09 08:50:19 +000024#include "psa_crypto_driver_wrappers.h"
Xiaokang Qianfe9666b2023-09-11 10:36:20 +000025#include "psa_crypto_driver_wrappers_no_static.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010026#include "psa_crypto_ecp.h"
Przemek Stekiel359f4622022-12-05 14:11:55 +010027#include "psa_crypto_ffdh.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010028#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010029#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010030#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010031#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020033#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020034#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010035#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010036/* Include internal declarations that are useful for implementing persistently
37 * stored keys. */
38#include "psa_crypto_storage.h"
39
Gilles Peskineb2b64d32020-12-14 16:43:58 +010040#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010041
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include <stdlib.h>
43#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010045
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010046#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020047#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000048#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020049#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010050#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020051#include "mbedtls/chacha20.h"
52#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010053#include "mbedtls/cipher.h"
54#include "mbedtls/ccm.h"
55#include "mbedtls/cmac.h"
Dave Rodgman78701152023-08-29 14:20:18 +010056#include "mbedtls/constant_time.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020058#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010059#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010060#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/error.h"
62#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/md5.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010064#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000065#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010066#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000067#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010069#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/sha1.h"
71#include "mbedtls/sha256.h"
72#include "mbedtls/sha512.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020073#include "md_psa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020075#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
76 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
77 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020078#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020079#endif
80
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010081/****************************************************************/
82/* Global data, support functions and library management */
83/****************************************************************/
84
Gilles Peskine449bd832023-01-11 14:50:10 +010085static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020088}
89
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010090/* Values for psa_global_data_t::rng_state */
91#define RNG_NOT_INITIALIZED 0
92#define RNG_INITIALIZED 1
93#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010094
Gilles Peskine449bd832023-01-11 14:50:10 +010095typedef struct {
Dave Rodgman864f5942023-08-16 18:04:44 +010096 uint8_t initialized;
97 uint8_t rng_state;
98 uint8_t drivers_initialized;
Gilles Peskine2d8a1822021-11-08 22:20:03 +010099 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100100} psa_global_data_t;
101
102static psa_global_data_t global_data;
103
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100104#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
105mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
106 &global_data.rng.drbg;
107#endif
108
itayzafrir0adf0fc2018-09-06 16:24:41 +0300109#define GUARD_MODULE_INITIALIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (global_data.initialized == 0) \
111 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300112
David Horstmann513101b2023-11-29 17:24:08 +0000113#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
David Horstmann36df4b22023-12-13 15:55:25 +0000114
David Horstmann62a56d92023-12-14 18:12:47 +0000115/* Declare a local copy of an input buffer and a variable that will be used
116 * to store a pointer to the start of the buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000117 *
118 * Note: This macro must be called before any operations which may jump to
119 * the exit label, so that the local input copy object is safe to be freed.
120 *
121 * Assumptions:
122 * - input is the name of a pointer to the buffer to be copied
123 * - The name LOCAL_INPUT_COPY_OF_input is unused in the current scope
David Horstmann62a56d92023-12-14 18:12:47 +0000124 * - input_copy_name is a name that is unused in the current scope
David Horstmann36df4b22023-12-13 15:55:25 +0000125 */
David Horstmann62a56d92023-12-14 18:12:47 +0000126#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
127 psa_crypto_local_input_t LOCAL_INPUT_COPY_OF_##input = PSA_CRYPTO_LOCAL_INPUT_INIT; \
128 const uint8_t *input_copy_name = NULL;
David Horstmann36df4b22023-12-13 15:55:25 +0000129
David Horstmann62a56d92023-12-14 18:12:47 +0000130/* Allocate a copy of the buffer input and set the pointer input_copy to
131 * point to the start of the copy.
David Horstmann36df4b22023-12-13 15:55:25 +0000132 *
David Horstmanne9a88ab2023-11-29 17:07:13 +0000133 * Assumptions:
134 * - psa_status_t status exists
135 * - An exit label is declared
David Horstmann36df4b22023-12-13 15:55:25 +0000136 * - input is the name of a pointer to the buffer to be copied
David Horstmann62a56d92023-12-14 18:12:47 +0000137 * - LOCAL_INPUT_DECLARE(input, input_copy) has previously been called
David Horstmanne9a88ab2023-11-29 17:07:13 +0000138 */
David Horstmann62a56d92023-12-14 18:12:47 +0000139#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
David Horstmann36df4b22023-12-13 15:55:25 +0000140 status = psa_crypto_local_input_alloc(input, length, \
141 &LOCAL_INPUT_COPY_OF_##input); \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000142 if (status != PSA_SUCCESS) { \
143 goto exit; \
144 } \
David Horstmann62a56d92023-12-14 18:12:47 +0000145 input_copy = LOCAL_INPUT_COPY_OF_##input.buffer;
David Horstmanne9a88ab2023-11-29 17:07:13 +0000146
David Horstmann36df4b22023-12-13 15:55:25 +0000147/* Free the local input copy allocated previously by LOCAL_INPUT_ALLOC()
148 *
David Horstmann3e72db42023-12-08 14:08:18 +0000149 * Assumptions:
David Horstmann62a56d92023-12-14 18:12:47 +0000150 * - input_copy is the name of the input copy pointer set by LOCAL_INPUT_ALLOC()
David Horstmann36df4b22023-12-13 15:55:25 +0000151 * - input is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000152 */
David Horstmann62a56d92023-12-14 18:12:47 +0000153#define LOCAL_INPUT_FREE(input, input_copy) \
154 input_copy = NULL; \
David Horstmann36df4b22023-12-13 15:55:25 +0000155 psa_crypto_local_input_free(&LOCAL_INPUT_COPY_OF_##input);
David Horstmanne9a88ab2023-11-29 17:07:13 +0000156
David Horstmann62a56d92023-12-14 18:12:47 +0000157/* Declare a local copy of an output buffer and a variable that will be used
158 * to store a pointer to the start of the buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000159 *
160 * Note: This macro must be called before any operations which may jump to
161 * the exit label, so that the local output copy object is safe to be freed.
162 *
163 * Assumptions:
164 * - output is the name of a pointer to the buffer to be copied
165 * - The name LOCAL_OUTPUT_COPY_OF_output is unused in the current scope
David Horstmann62a56d92023-12-14 18:12:47 +0000166 * - output_copy_name is a name that is unused in the current scope
David Horstmann36df4b22023-12-13 15:55:25 +0000167 */
David Horstmann62a56d92023-12-14 18:12:47 +0000168#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
169 psa_crypto_local_output_t LOCAL_OUTPUT_COPY_OF_##output = PSA_CRYPTO_LOCAL_OUTPUT_INIT; \
170 uint8_t *output_copy_name = NULL;
David Horstmann36df4b22023-12-13 15:55:25 +0000171
David Horstmann62a56d92023-12-14 18:12:47 +0000172/* Allocate a copy of the buffer output and set the pointer output_copy to
173 * point to the start of the copy.
David Horstmann36df4b22023-12-13 15:55:25 +0000174 *
David Horstmanne9a88ab2023-11-29 17:07:13 +0000175 * Assumptions:
176 * - psa_status_t status exists
177 * - An exit label is declared
David Horstmann36df4b22023-12-13 15:55:25 +0000178 * - output is the name of a pointer to the buffer to be copied
David Horstmann62a56d92023-12-14 18:12:47 +0000179 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
David Horstmanne9a88ab2023-11-29 17:07:13 +0000180 */
David Horstmann62a56d92023-12-14 18:12:47 +0000181#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
David Horstmann36df4b22023-12-13 15:55:25 +0000182 status = psa_crypto_local_output_alloc(output, length, \
183 &LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000184 if (status != PSA_SUCCESS) { \
185 goto exit; \
186 } \
David Horstmann62a56d92023-12-14 18:12:47 +0000187 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
David Horstmanne9a88ab2023-11-29 17:07:13 +0000188
Gabor Mezei1882c512024-01-24 13:07:17 +0100189/* Allocate a copy of the buffer output and set the pointer output_copy to
190 * point to the start of the copy.
191 *
192 * Assumptions:
193 * - psa_status_t status exists
194 * - An exit label is declared
195 * - output is the name of a pointer to the buffer to be copied
196 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
197 */
198#define LOCAL_OUTPUT_ALLOC_WITH_COPY(output, length, output_copy) \
199 status = psa_crypto_local_output_alloc_with_copy(output, length, \
200 &LOCAL_OUTPUT_COPY_OF_##output); \
201 if (status != PSA_SUCCESS) { \
202 goto exit; \
203 } \
204 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
205
David Horstmann62a56d92023-12-14 18:12:47 +0000206/* Free the local output copy allocated previously by LOCAL_OUTPUT_ALLOC()
David Horstmann3e72db42023-12-08 14:08:18 +0000207 * after first copying back its contents to the original buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000208 *
David Horstmann3e72db42023-12-08 14:08:18 +0000209 * Assumptions:
David Horstmann3e72db42023-12-08 14:08:18 +0000210 * - psa_status_t status exists
David Horstmann62a56d92023-12-14 18:12:47 +0000211 * - output_copy is the name of the output copy pointer set by LOCAL_OUTPUT_ALLOC()
212 * - output is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000213 */
David Horstmann62a56d92023-12-14 18:12:47 +0000214#define LOCAL_OUTPUT_FREE(output, output_copy) \
215 output_copy = NULL; \
David Horstmann5a945f52023-12-13 14:09:08 +0000216 do { \
217 psa_status_t local_output_status; \
David Horstmann36df4b22023-12-13 15:55:25 +0000218 local_output_status = psa_crypto_local_output_free(&LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmann5a945f52023-12-13 14:09:08 +0000219 if (local_output_status != PSA_SUCCESS) { \
220 /* Since this error case is an internal error, it's more serious than \
221 * any existing error code and so it's fine to overwrite the existing \
222 * status. */ \
223 status = local_output_status; \
224 } \
225 } while (0)
David Horstmann513101b2023-11-29 17:24:08 +0000226#else /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmann62a56d92023-12-14 18:12:47 +0000227#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
228 const uint8_t *input_copy_name = NULL;
229#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
230 input_copy = input;
231#define LOCAL_INPUT_FREE(input, input_copy) \
232 input_copy = NULL;
233#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
234 uint8_t *output_copy_name = NULL;
235#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
236 output_copy = output;
237#define LOCAL_OUTPUT_FREE(output, output_copy) \
238 output_copy = NULL;
David Horstmann513101b2023-11-29 17:24:08 +0000239#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000240
241
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100242int psa_can_do_hash(psa_algorithm_t hash_alg)
243{
244 (void) hash_alg;
245 return global_data.drivers_initialized;
246}
Valerio Settia55f0422023-07-10 15:34:41 +0200247#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200248 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200249 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200250static int psa_is_dh_key_size_valid(size_t bits)
251{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200252 if (bits != 2048 && bits != 3072 && bits != 4096 &&
253 bits != 6144 && bits != 8192) {
254 return 0;
255 }
256
257 return 1;
258}
Valerio Settia55f0422023-07-10 15:34:41 +0200259#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200260 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200261 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100262
Gilles Peskine449bd832023-01-11 14:50:10 +0100263psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100264{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100265 /* Mbed TLS error codes can combine a high-level error code and a
266 * low-level error code. The low-level error usually reflects the
267 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 int low_level_ret = -(-ret & 0x007f);
269 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100270 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100272
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100273#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100274 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
275 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100276 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100277 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
278 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100279#endif
280
281#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200282 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
283 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
284 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
285 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
286 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200288 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200290 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100292#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200293
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100294#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000295 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100296 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100297 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100298#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100299
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100300#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100301 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100303 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100305#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100306
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100307#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200308 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100309 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100310#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200311
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100312#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200313 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200315 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100317#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200318
Dave Rodgman509b5672023-08-16 19:26:23 +0100319#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100320 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100322 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100326 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100328 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100329 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100330 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100332 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100334#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100335
Gilles Peskine449bd832023-01-11 14:50:10 +0100336#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
337 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100338 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
339 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100340 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100342 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
343 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100345 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100347#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100348
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100349#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100350 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100352#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100353
Gilles Peskinee59236f2018-01-27 23:32:46 +0100354 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
355 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
356 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100358
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100359#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100360 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200362 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100364 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100366#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100367
Gilles Peskine82e57d12020-11-13 21:31:17 +0100368#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100370 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
371 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100372 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100373 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100374 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
375 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100377 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100379#endif
380
Dave Rodgmandea266f2023-08-31 11:52:43 +0100381#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100382 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100384 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100386 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100388#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100389 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100390 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100391#endif
392#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100393
Dave Rodgman509b5672023-08-16 19:26:23 +0100394#if defined(MBEDTLS_BIGNUM_C)
395#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100396 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100397 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100398#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100399 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100401 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100403 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100405 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100407 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100408 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100409 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100411 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100412 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100413#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100414
Dave Rodgman509b5672023-08-16 19:26:23 +0100415#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100416 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100418 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
419 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100421#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
422 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100423 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100425#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100426 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
427 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100429 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100431 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
432 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100434 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100436 case MBEDTLS_ERR_PK_INVALID_ALG:
437 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
438 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100440 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200442 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100443 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100444#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100445
Gilles Peskineff2d2002019-05-06 15:26:23 +0200446 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200448 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200450
Dave Rodgman509b5672023-08-16 19:26:23 +0100451#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100452 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100454 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100455 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100456 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100458 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100459 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100460 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
461 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100463 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100465 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100466 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100467 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100469#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200470
Dave Rodgman1dab4452023-09-01 09:59:51 +0100471#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300472 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300473 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300475 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300477 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100478 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300479 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
480 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300482 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100484 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100486
Dave Rodgman509b5672023-08-16 19:26:23 +0100487#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000488 case MBEDTLS_ERR_ECP_IN_PROGRESS:
489 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100490#endif
491#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000492
Janos Follatha13b9052019-11-22 12:48:59 +0000493 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300495
Gilles Peskinee59236f2018-01-27 23:32:46 +0100496 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100498 }
499}
500
Paul Elliottdc42ca82023-02-24 18:11:59 +0000501/**
502 * \brief For output buffers which contain "tags"
503 * (outputs that may be checked for validity like
504 * hashes, MACs and signatures), fill the unused
505 * part of the output buffer (the whole buffer on
506 * error, the trailing part on success) with
507 * something that isn't a valid tag (barring an
508 * attack on the tag and deliberately-crafted
509 * input), in case the caller doesn't check the
510 * return status properly.
511 *
512 * \param output_buffer Pointer to buffer to wipe. May not be NULL
513 * unless \p output_buffer_size is zero.
514 * \param status Status of function called to generate
515 * output_buffer originally
516 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
517 * could be NULL.
518 * \param output_buffer_length Length of data written to output_buffer, must be
519 * less than \p output_buffer_size
520 */
521static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000522 size_t output_buffer_size, size_t output_buffer_length)
523{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000524 size_t offset = 0;
525
526 if (output_buffer_size == 0) {
527 /* If output_buffer_size is 0 then we have nothing to do. We must not
528 call memset because output_buffer may be NULL in this case */
529 return;
530 }
531
532 if (status == PSA_SUCCESS) {
533 offset = output_buffer_length;
534 }
535
536 memset(output_buffer + offset, '!', output_buffer_size - offset);
537}
538
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200539
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200540
541
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100542/****************************************************************/
543/* Key management */
544/****************************************************************/
545
Valerio Settia9aab1a2023-06-19 13:39:54 +0200546#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200547psa_ecc_family_t mbedtls_ecc_group_to_psa(mbedtls_ecp_group_id grpid,
548 size_t *bits)
549{
550 switch (grpid) {
Valerio Settic437fae2023-09-08 14:58:03 +0200551#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200552 case MBEDTLS_ECP_DP_SECP192R1:
553 *bits = 192;
554 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100555#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200556#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200557 case MBEDTLS_ECP_DP_SECP224R1:
558 *bits = 224;
559 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100560#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200561#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200562 case MBEDTLS_ECP_DP_SECP256R1:
563 *bits = 256;
564 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100565#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200566#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200567 case MBEDTLS_ECP_DP_SECP384R1:
568 *bits = 384;
569 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100570#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200571#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200572 case MBEDTLS_ECP_DP_SECP521R1:
573 *bits = 521;
574 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100575#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200576#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200577 case MBEDTLS_ECP_DP_BP256R1:
578 *bits = 256;
579 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100580#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200581#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200582 case MBEDTLS_ECP_DP_BP384R1:
583 *bits = 384;
584 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100585#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200586#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200587 case MBEDTLS_ECP_DP_BP512R1:
588 *bits = 512;
589 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100590#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200591#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200592 case MBEDTLS_ECP_DP_CURVE25519:
593 *bits = 255;
594 return PSA_ECC_FAMILY_MONTGOMERY;
Dave Rodgman6f682032023-08-16 18:44:32 +0100595#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200596#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200597 case MBEDTLS_ECP_DP_SECP192K1:
598 *bits = 192;
599 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100600#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200601#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200602 case MBEDTLS_ECP_DP_SECP224K1:
603 *bits = 224;
604 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100605#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200606#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200607 case MBEDTLS_ECP_DP_SECP256K1:
608 *bits = 256;
609 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100610#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200611#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200612 case MBEDTLS_ECP_DP_CURVE448:
613 *bits = 448;
614 return PSA_ECC_FAMILY_MONTGOMERY;
Dave Rodgman6f682032023-08-16 18:44:32 +0100615#endif
Valerio Settibc2b1d32023-06-19 12:15:13 +0200616 default:
617 *bits = 0;
618 return 0;
619 }
620}
621
Gilles Peskine449bd832023-01-11 14:50:10 +0100622mbedtls_ecp_group_id mbedtls_ecc_group_of_psa(psa_ecc_family_t curve,
623 size_t bits,
624 int bits_is_sloppy)
Gilles Peskine12313cd2018-06-20 00:20:32 +0200625{
Gilles Peskine449bd832023-01-11 14:50:10 +0100626 switch (curve) {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100627 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100628 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100629#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100630 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100631 return MBEDTLS_ECP_DP_SECP192R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100632#endif
633#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100634 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100635 return MBEDTLS_ECP_DP_SECP224R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100636#endif
637#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100638 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100639 return MBEDTLS_ECP_DP_SECP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100640#endif
641#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100642 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100643 return MBEDTLS_ECP_DP_SECP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100644#endif
645#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100646 case 521:
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 return MBEDTLS_ECP_DP_SECP521R1;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100648 case 528:
Gilles Peskine449bd832023-01-11 14:50:10 +0100649 if (bits_is_sloppy) {
650 return MBEDTLS_ECP_DP_SECP521R1;
651 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100652 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100653#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100654 }
655 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100656
Paul Elliott8ff510a2020-06-02 17:19:28 +0100657 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100658 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100659#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100660 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100661 return MBEDTLS_ECP_DP_BP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100662#endif
663#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100664 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 return MBEDTLS_ECP_DP_BP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100666#endif
667#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100668 case 512:
Gilles Peskine449bd832023-01-11 14:50:10 +0100669 return MBEDTLS_ECP_DP_BP512R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100670#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100671 }
672 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100673
Paul Elliott8ff510a2020-06-02 17:19:28 +0100674 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100676#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100677 case 255:
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return MBEDTLS_ECP_DP_CURVE25519;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100679 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 if (bits_is_sloppy) {
681 return MBEDTLS_ECP_DP_CURVE25519;
682 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100683 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100684#endif
685#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100686 case 448:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return MBEDTLS_ECP_DP_CURVE448;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100688#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100689 }
690 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100691
Paul Elliott8ff510a2020-06-02 17:19:28 +0100692 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100694#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100695 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return MBEDTLS_ECP_DP_SECP192K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100697#endif
698#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100699 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 return MBEDTLS_ECP_DP_SECP224K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100701#endif
702#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100703 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 return MBEDTLS_ECP_DP_SECP256K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100705#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100706 }
707 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200708 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100709
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100710 (void) bits_is_sloppy;
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 return MBEDTLS_ECP_DP_NONE;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200712}
Valerio Settia9aab1a2023-06-19 13:39:54 +0200713#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200714
Gilles Peskine449bd832023-01-11 14:50:10 +0100715psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
716 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200717{
718 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100719 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200720 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200721 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200722 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200723 case PSA_KEY_TYPE_PASSWORD:
724 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200725 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100726#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200727 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 if (bits != 128 && bits != 192 && bits != 256) {
729 return PSA_ERROR_INVALID_ARGUMENT;
730 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200731 break;
732#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200733#if defined(PSA_WANT_KEY_TYPE_ARIA)
734 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100735 if (bits != 128 && bits != 192 && bits != 256) {
736 return PSA_ERROR_INVALID_ARGUMENT;
737 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200738 break;
739#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100740#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200741 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 if (bits != 128 && bits != 192 && bits != 256) {
743 return PSA_ERROR_INVALID_ARGUMENT;
744 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200745 break;
746#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100747#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200748 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 if (bits != 64 && bits != 128 && bits != 192) {
750 return PSA_ERROR_INVALID_ARGUMENT;
751 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200752 break;
753#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100754#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200755 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100756 if (bits != 256) {
757 return PSA_ERROR_INVALID_ARGUMENT;
758 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200759 break;
760#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200761 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100762 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200763 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100764 if (bits % 8 != 0) {
765 return PSA_ERROR_INVALID_ARGUMENT;
766 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200767
Gilles Peskine449bd832023-01-11 14:50:10 +0100768 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200769}
770
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100771/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100772 *
Steven Cooremancd640932021-03-08 12:00:27 +0100773 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
774 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100775 *
776 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100777 * \param[in] key_type The key type of the key to be used with the
778 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100779 *
780 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100781 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100782 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100783 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100784 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100785MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100786 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100788{
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 if (PSA_ALG_IS_HMAC(algorithm)) {
790 if (key_type == PSA_KEY_TYPE_HMAC) {
791 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100792 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100793 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100794
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
796 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
797 * key. */
798 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
799 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
800 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
801 * the block length (larger than 1) for block ciphers. */
802 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
803 return PSA_SUCCESS;
804 }
805 }
806 }
807
808 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100809}
810
Gilles Peskine449bd832023-01-11 14:50:10 +0100811psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
812 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200813{
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 if (slot->key.data != NULL) {
815 return PSA_ERROR_ALREADY_EXISTS;
816 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200817
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 slot->key.data = mbedtls_calloc(1, buffer_length);
819 if (slot->key.data == NULL) {
820 return PSA_ERROR_INSUFFICIENT_MEMORY;
821 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200822
Ronald Cronea0f8a62020-11-25 17:52:23 +0100823 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100824 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200825}
826
Gilles Peskine449bd832023-01-11 14:50:10 +0100827psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
828 const uint8_t *data,
829 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200830{
Gilles Peskine449bd832023-01-11 14:50:10 +0100831 psa_status_t status = psa_allocate_buffer_to_slot(slot,
832 data_length);
833 if (status != PSA_SUCCESS) {
834 return status;
835 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200836
Gilles Peskine449bd832023-01-11 14:50:10 +0100837 memcpy(slot->key.data, data, data_length);
838 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200839}
840
Ronald Crona0fe59f2020-11-29 11:14:53 +0100841psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100842 const psa_key_attributes_t *attributes,
843 const uint8_t *data, size_t data_length,
844 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100846{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100847 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
848 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100849
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200850 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100851 if (data_length == 0) {
852 return PSA_ERROR_NOT_SUPPORTED;
853 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200854
Gilles Peskine449bd832023-01-11 14:50:10 +0100855 if (key_type_is_raw_bytes(type)) {
856 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200857
Gilles Peskine449bd832023-01-11 14:50:10 +0100858 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
859 *bits);
860 if (status != PSA_SUCCESS) {
861 return status;
862 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200863
Ronald Crondd04d422020-11-28 15:14:42 +0100864 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100865 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100866 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100867 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200868
Gilles Peskine449bd832023-01-11 14:50:10 +0100869 return PSA_SUCCESS;
870 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200871#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200872 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100873 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200874 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100875 return PSA_ERROR_INVALID_ARGUMENT;
876 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200877 return mbedtls_psa_ffdh_import_key(attributes,
878 data, data_length,
879 key_buffer, key_buffer_size,
880 key_buffer_length,
881 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100882 }
Valerio Settia55f0422023-07-10 15:34:41 +0200883#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200884 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200885#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100886 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
887 if (PSA_KEY_TYPE_IS_ECC(type)) {
888 return mbedtls_psa_ecp_import_key(attributes,
889 data, data_length,
890 key_buffer, key_buffer_size,
891 key_buffer_length,
892 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100893 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200894#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800895 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200896#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
897 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
899 if (PSA_KEY_TYPE_IS_RSA(type)) {
900 return mbedtls_psa_rsa_import_key(attributes,
901 data, data_length,
902 key_buffer, key_buffer_size,
903 key_buffer_length,
904 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200905 }
Valerio Settife478902023-07-25 12:27:19 +0200906#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
907 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800908 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100909 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100910
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100912}
913
Gilles Peskinef603c712019-01-19 13:40:11 +0100914/** Calculate the intersection of two algorithm usage policies.
915 *
916 * Return 0 (which allows no operation) on incompatibility.
917 */
918static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100919 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100920 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100921 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100922{
Gilles Peskine549ea862019-05-22 11:45:59 +0200923 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 if (alg1 == alg2) {
925 return alg1;
926 }
Steven Cooreman03488022021-02-18 12:07:20 +0100927 /* If the policies are from the same hash-and-sign family, check
928 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
930 PSA_ALG_IS_SIGN_HASH(alg2) &&
931 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
932 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
933 return alg2;
934 }
935 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
936 return alg1;
937 }
Steven Cooreman03488022021-02-18 12:07:20 +0100938 }
939 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100940 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100941 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
943 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
944 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
945 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
946 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100947 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100948
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100949 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100950 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
951 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
952 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
953 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100954 }
955 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
957 (alg1_len <= alg2_len)) {
958 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100959 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
961 (alg2_len <= alg1_len)) {
962 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100963 }
964 }
965 /* If the policies are from the same MAC family, check whether one
966 * of them is a minimum-MAC-length policy. Calculate the most
967 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
969 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
970 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100971 /* Validate the combination of key type and algorithm. Since the base
972 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100973 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
974 return 0;
975 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100976
Steven Cooreman31a876d2021-03-03 20:47:40 +0100977 /* Get the (exact or at-least) output lengths for both sides of the
978 * requested intersection. None of the currently supported algorithms
979 * have an output length dependent on the actual key size, so setting it
980 * to a bogus value of 0 is currently OK.
981 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100982 * Note that for at-least-this-length wildcard algorithms, the output
983 * length is set to the shortest allowed length, which allows us to
984 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
986 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100987 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100988
Steven Cooremana1d83222021-02-25 10:20:29 +0100989 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
991 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
992 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100993 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100994
995 /* If only one is an at-least-this-length policy, the intersection would
996 * be the other (fixed-length) policy as long as said fixed length is
997 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
999 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +01001000 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
1002 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001003 }
Steven Cooreman31a876d2021-03-03 20:47:40 +01001004
Steven Cooremancd640932021-03-08 12:00:27 +01001005 /* If none of them are wildcards, check whether they define the same tag
1006 * length. This is still possible here when one is default-length and
1007 * the other specific-length. Ensure to always return the
1008 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 if (alg1_len == alg2_len) {
1010 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
1011 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001012 }
1013 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01001015}
1016
Gilles Peskine449bd832023-01-11 14:50:10 +01001017static int psa_key_algorithm_permits(psa_key_type_t key_type,
1018 psa_algorithm_t policy_alg,
1019 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +02001020{
Gilles Peskine549ea862019-05-22 11:45:59 +02001021 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 if (requested_alg == policy_alg) {
1023 return 1;
1024 }
Steven Cooreman03488022021-02-18 12:07:20 +01001025 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
1026 * and requested_alg is the same hash-and-sign family with any hash,
1027 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
1029 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
1030 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
1031 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +01001032 }
1033 /* If policy_alg is a wildcard AEAD algorithm of the same base as
1034 * the requested algorithm, check the requested tag length to be
1035 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 if (PSA_ALG_IS_AEAD(policy_alg) &&
1037 PSA_ALG_IS_AEAD(requested_alg) &&
1038 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
1039 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
1040 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
1041 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
1042 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +01001043 }
Steven Cooremancd640932021-03-08 12:00:27 +01001044 /* If policy_alg is a MAC algorithm of the same base as the requested
1045 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001046 if (PSA_ALG_IS_MAC(policy_alg) &&
1047 PSA_ALG_IS_MAC(requested_alg) &&
1048 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
1049 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001050 /* Validate the combination of key type and algorithm. Since the policy
1051 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001052 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
1053 return 0;
1054 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001055
Steven Cooreman31a876d2021-03-03 20:47:40 +01001056 /* Get both the requested output length for the algorithm which is to be
1057 * verified, and the default output length for the base algorithm.
1058 * Note that none of the currently supported algorithms have an output
1059 * length dependent on actual key size, so setting it to a bogus value
1060 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001061 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001063 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 key_type, 0,
1065 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001066
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001067 /* If the policy is default-length, only allow an algorithm with
1068 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
1070 return requested_output_length == default_output_length;
1071 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001072
1073 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +01001074 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
1076 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
1077 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001078 }
1079
Steven Cooremancd640932021-03-08 12:00:27 +01001080 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
1081 * check for the requested MAC length to be equal to or longer than the
1082 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
1084 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
1085 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001086 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001087 }
Steven Cooremance48e852020-10-05 16:02:45 +02001088 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001089 * a key derivation with that key agreement should also be allowed. This
1090 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
1092 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
1093 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
1094 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +02001095 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001096 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001098}
1099
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001100/** Test whether a policy permits an algorithm.
1101 *
1102 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +01001103 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001104 * \note This function requires providing the key type for which the policy is
1105 * being validated, since some algorithm policy definitions (e.g. MAC)
1106 * have different properties depending on what kind of cipher it is
1107 * combined with.
1108 *
Steven Cooreman7e39f052021-02-23 14:18:32 +01001109 * \retval PSA_SUCCESS When \p alg is a specific algorithm
1110 * allowed by the \p policy.
1111 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
1112 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
1113 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001114 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001115static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
1116 psa_key_type_t key_type,
1117 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001118{
Steven Cooremand788fab2021-02-25 11:29:17 +01001119 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 if (alg == 0) {
1121 return PSA_ERROR_INVALID_ARGUMENT;
1122 }
Steven Cooremand788fab2021-02-25 11:29:17 +01001123
Steven Cooreman7e39f052021-02-23 14:18:32 +01001124 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 if (PSA_ALG_IS_WILDCARD(alg)) {
1126 return PSA_ERROR_INVALID_ARGUMENT;
1127 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001128
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
1130 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
1131 return PSA_SUCCESS;
1132 } else {
1133 return PSA_ERROR_NOT_PERMITTED;
1134 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001135}
1136
Gilles Peskinef603c712019-01-19 13:40:11 +01001137/** Restrict a key policy based on a constraint.
1138 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001139 * \note This function requires providing the key type for which the policy is
1140 * being restricted, since some algorithm policy definitions (e.g. MAC)
1141 * have different properties depending on what kind of cipher it is
1142 * combined with.
1143 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001144 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +01001145 * \param[in,out] policy The policy to restrict.
1146 * \param[in] constraint The policy constraint to apply.
1147 *
1148 * \retval #PSA_SUCCESS
1149 * \c *policy contains the intersection of the original value of
1150 * \c *policy and \c *constraint.
1151 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001152 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +01001153 * \c *policy is unchanged.
1154 */
1155static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001156 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +01001157 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +01001159{
1160 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 psa_key_policy_algorithm_intersection(key_type, policy->alg,
1162 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +02001163 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
1165 constraint->alg2);
1166 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1167 return PSA_ERROR_INVALID_ARGUMENT;
1168 }
1169 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1170 return PSA_ERROR_INVALID_ARGUMENT;
1171 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001172 policy->usage &= constraint->usage;
1173 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001174 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001176}
1177
Przemek Stekiel061f6942022-11-30 10:51:35 +01001178/** Get the description of a key given its identifier and policy constraints
1179 * and lock it.
1180 *
1181 * The key must have allow all the usage flags set in \p usage. If \p alg is
1182 * nonzero, the key must allow operations with this algorithm. If \p alg is
1183 * zero, the algorithm is not checked.
1184 *
1185 * In case of a persistent key, the function loads the description of the key
1186 * into a key slot if not already done.
1187 *
1188 * On success, the returned key slot is locked. It is the responsibility of
1189 * the caller to unlock the key slot when it does not access it anymore.
1190 */
1191static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001192 mbedtls_svc_key_id_t key,
1193 psa_key_slot_t **p_slot,
1194 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001196{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001197 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001198 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001199
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 status = psa_get_and_lock_key_slot(key, p_slot);
1201 if (status != PSA_SUCCESS) {
1202 return status;
1203 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001204 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001205
1206 /* Enforce that usage policy for the key slot contains all the flags
1207 * required by the usage parameter. There is one exception: public
1208 * keys can always be exported, so we treat public key objects as
1209 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001211 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001215 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001216 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001217 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001218
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001219 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 if (alg != 0) {
1221 status = psa_key_policy_permits(&slot->attr.policy,
1222 slot->attr.type,
1223 alg);
1224 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001225 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001227 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001228
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001230
1231error:
1232 *p_slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001234
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001236}
Darryl Green940d72c2018-07-13 13:18:51 +01001237
Ronald Cron5c522922020-11-14 16:35:34 +01001238/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001239 *
1240 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001241 * available, as opposed to a key in a secure element and/or to be used
1242 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001243 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001244 * This is a temporary function that may be used instead of
1245 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1246 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001247 *
Ronald Cron5c522922020-11-14 16:35:34 +01001248 * On success, the returned key slot is locked. It is the responsibility of the
1249 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001250 */
Ronald Cron5c522922020-11-14 16:35:34 +01001251static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1252 mbedtls_svc_key_id_t key,
1253 psa_key_slot_t **p_slot,
1254 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001255 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001256{
Gilles Peskine449bd832023-01-11 14:50:10 +01001257 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1258 usage, alg);
1259 if (status != PSA_SUCCESS) {
1260 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001261 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001262
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
1264 psa_unlock_key_slot(*p_slot);
1265 *p_slot = NULL;
1266 return PSA_ERROR_NOT_SUPPORTED;
1267 }
1268
1269 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001270}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001271
Gilles Peskine449bd832023-01-11 14:50:10 +01001272psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001273{
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001275 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001277
Ronald Cronea0f8a62020-11-25 17:52:23 +01001278 slot->key.data = NULL;
1279 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001280
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001282}
1283
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001284/** Completely wipe a slot in memory, including its policy.
1285 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001286psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001287{
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001289
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 /*
1291 * As the return error code may not be handled in case of multiple errors,
1292 * do our best to report an unexpected lock counter. Assert with
1293 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
1294 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1295 * function is called as part of the execution of a test suite, the
1296 * execution of the test suite is stopped in error if the assertion fails.
1297 */
1298 if (slot->lock_count != 1) {
1299 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->lock_count == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001300 status = PSA_ERROR_CORRUPTION_DETECTED;
1301 }
1302
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001303 /* Multipart operations may still be using the key. This is safe
1304 * because all multipart operation objects are independent from
1305 * the key slot: if they need to access the key after the setup
1306 * phase, they have a copy of the key. Note that this means that
1307 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001308 /* At this point, key material and other type-specific content has
1309 * been wiped. Clear remaining metadata. We can call memset and not
1310 * zeroize because the metadata is not particularly sensitive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 memset(slot, 0, sizeof(*slot));
1312 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001313}
1314
Gilles Peskine449bd832023-01-11 14:50:10 +01001315psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001316{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001317 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001318 psa_status_t status; /* status of the last operation */
1319 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001320#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1321 psa_se_drv_table_entry_t *driver;
1322#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001323
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 if (mbedtls_svc_key_id_is_null(key)) {
1325 return PSA_SUCCESS;
1326 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001327
Ronald Cronf2911112020-10-29 17:51:10 +01001328 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001329 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001330 * key, this will load the key description from persistent memory if not
1331 * done yet. We cannot avoid this loading as without it we don't know if
1332 * the key is operated by an SE or not and this information is needed by
1333 * the current implementation.
1334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 status = psa_get_and_lock_key_slot(key, &slot);
1336 if (status != PSA_SUCCESS) {
1337 return status;
1338 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001339
Ronald Cronf2911112020-10-29 17:51:10 +01001340 /*
1341 * If the key slot containing the key description is under access by the
1342 * library (apart from the present access), the key cannot be destroyed
1343 * yet. For the time being, just return in error. Eventually (to be
1344 * implemented), the key should be destroyed when all accesses have
1345 * stopped.
1346 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 if (slot->lock_count > 1) {
1348 psa_unlock_key_slot(slot);
1349 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001350 }
1351
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001353 /* Refuse the destruction of a read-only key (which may or may not work
1354 * if we attempt it, depending on whether the key is merely read-only
1355 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001356 * Just do the best we can, which is to wipe the copy in memory
1357 * (done in this function's cleanup code). */
1358 overall_status = PSA_ERROR_NOT_PERMITTED;
1359 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001360 }
1361
Gilles Peskine354f7672019-07-12 23:46:38 +02001362#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1364 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001365 /* For a key in a secure element, we need to do three things:
1366 * remove the key file in internal storage, destroy the
1367 * key inside the secure element, and update the driver's
1368 * persistent data. Start a transaction that will encompass these
1369 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001371 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001373 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 status = psa_crypto_save_transaction();
1375 if (status != PSA_SUCCESS) {
1376 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001377 /* We should still try to destroy the key in the secure
1378 * element and the key metadata in storage. This is especially
1379 * important if the error is that the storage is full.
1380 * But how to do it exactly without risking an inconsistent
1381 * state after a reset?
1382 * https://github.com/ARMmbed/mbed-crypto/issues/215
1383 */
1384 overall_status = status;
1385 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001386 }
1387
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 status = psa_destroy_se_key(driver,
1389 psa_key_slot_get_slot_number(slot));
1390 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001391 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001392 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001393 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001394#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1395
Darryl Greend49a4992018-06-18 17:27:26 +01001396#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1398 status = psa_destroy_persistent_key(slot->attr.id);
1399 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001400 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001402
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001403 /* TODO: other slots may have a copy of the same key. We should
1404 * invalidate them.
1405 * https://github.com/ARMmbed/mbed-crypto/issues/214
1406 */
Darryl Greend49a4992018-06-18 17:27:26 +01001407 }
1408#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001409
Gilles Peskinefc762652019-07-22 19:30:34 +02001410#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 if (driver != NULL) {
1412 status = psa_save_se_persistent_data(driver);
1413 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001414 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 }
1416 status = psa_crypto_stop_transaction();
1417 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001418 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001420 }
1421#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1422
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001423exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001425 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001427 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 }
1429 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001430}
1431
Valerio Settib2bcedb2023-07-10 11:24:00 +02001432#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001433 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001434static psa_status_t psa_get_rsa_public_exponent(
1435 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001437{
1438 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001439 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001440 uint8_t *buffer = NULL;
1441 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001443
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1445 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001446 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 }
1448 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001449 /* It's the default value, which is reported as an empty string,
1450 * so there's nothing to do. */
1451 goto exit;
1452 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001453
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 buflen = mbedtls_mpi_size(&mpi);
1455 buffer = mbedtls_calloc(1, buflen);
1456 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001457 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1458 goto exit;
1459 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1461 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001462 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001464 attributes->domain_parameters = buffer;
1465 attributes->domain_parameters_size = buflen;
1466
1467exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001468 mbedtls_mpi_free(&mpi);
1469 if (ret != 0) {
1470 mbedtls_free(buffer);
1471 }
1472 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001473}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001474#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001475 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001476
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001477/** Retrieve all the publicly-accessible attributes of a key.
1478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001479psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1480 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001481{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001482 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001483 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001484 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001485
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001487
Gilles Peskine449bd832023-01-11 14:50:10 +01001488 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1489 if (status != PSA_SUCCESS) {
1490 return status;
1491 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001492
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001493 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1495 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001496
1497#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1499 psa_set_key_slot_number(attributes,
1500 psa_key_slot_get_slot_number(slot));
1501 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001502#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001503
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001505#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1506 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001507 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001508 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001509 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001510 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001511 * is not yet implemented.
1512 * https://github.com/ARMmbed/mbed-crypto/issues/216
1513 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001515 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001516
Ronald Cron90857082020-11-25 14:58:33 +01001517 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 slot->attr.type,
1519 slot->key.data,
1520 slot->key.bytes,
1521 &rsa);
1522 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001523 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 status = psa_get_rsa_public_exponent(rsa,
1527 attributes);
1528 mbedtls_rsa_free(rsa);
1529 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001530 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001531 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001532#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1533 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001534 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001535 default:
1536 /* Nothing else to do. */
1537 break;
1538 }
1539
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 if (status != PSA_SUCCESS) {
1541 psa_reset_key_attributes(attributes);
1542 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001543
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001545
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001547}
1548
Gilles Peskinec8000c02019-08-02 20:15:51 +02001549#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1550psa_status_t psa_get_key_slot_number(
1551 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001553{
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001555 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 return PSA_SUCCESS;
1557 } else {
1558 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001559 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001560}
1561#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1562
Gilles Peskine449bd832023-01-11 14:50:10 +01001563static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1564 size_t key_buffer_size,
1565 uint8_t *data,
1566 size_t data_size,
1567 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001568{
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 if (key_buffer_size > data_size) {
1570 return PSA_ERROR_BUFFER_TOO_SMALL;
1571 }
1572 memcpy(data, key_buffer, key_buffer_size);
1573 memset(data + key_buffer_size, 0,
1574 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001575 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001577}
1578
Ronald Cron7285cda2020-11-26 14:46:37 +01001579psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001580 const psa_key_attributes_t *attributes,
1581 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001583{
Ronald Crond18b5f82020-11-25 16:46:05 +01001584 psa_key_type_t type = attributes->core.type;
1585
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 if (key_type_is_raw_bytes(type) ||
1587 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001588 PSA_KEY_TYPE_IS_ECC(type) ||
1589 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 return psa_export_key_buffer_internal(
1591 key_buffer, key_buffer_size,
1592 data, data_size, data_length);
1593 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001594 /* This shouldn't happen in the reference implementation, but
1595 it is valid for a special-purpose implementation to omit
1596 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001598 }
1599}
1600
Gilles Peskine449bd832023-01-11 14:50:10 +01001601psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
Ryan Everett45ac5262024-01-08 17:15:19 +00001602 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 size_t data_size,
1604 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001605{
1606 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1607 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1608 psa_key_slot_t *slot;
Ryan Everett45ac5262024-01-08 17:15:19 +00001609 LOCAL_OUTPUT_DECLARE(data_external, data);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001610
Ronald Crone907e552021-01-18 13:22:38 +01001611 /* Reject a zero-length output buffer now, since this can never be a
1612 * valid key representation. This way we know that data must be a valid
1613 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 if (data_size == 0) {
1615 return PSA_ERROR_BUFFER_TOO_SMALL;
1616 }
Ronald Crone907e552021-01-18 13:22:38 +01001617
Ronald Cron9486f9d2020-11-26 13:36:23 +01001618 /* Set the key to empty now, so that even when there are errors, we always
1619 * set data_length to a value between 0 and data_size. On error, setting
1620 * the key to empty is a good choice because an empty key representation is
1621 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001622 *data_length = 0;
1623
Ronald Cron9486f9d2020-11-26 13:36:23 +01001624 /* Export requires the EXPORT flag. There is an exception for public keys,
1625 * which don't require any flag, but
1626 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1627 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001628 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1629 PSA_KEY_USAGE_EXPORT, 0);
1630 if (status != PSA_SUCCESS) {
1631 return status;
1632 }
mohammad160306e79202018-03-28 13:17:44 +03001633
Ryan Everett45ac5262024-01-08 17:15:19 +00001634 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1635
Ronald Crond18b5f82020-11-25 16:46:05 +01001636 psa_key_attributes_t attributes = {
1637 .core = slot->attr
1638 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001639 status = psa_driver_wrapper_export_key(&attributes,
1640 slot->key.data, slot->key.bytes,
1641 data, data_size, data_length);
Ryan Everett45ac5262024-01-08 17:15:19 +00001642exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001644
Ryan Everett45ac5262024-01-08 17:15:19 +00001645 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001647}
1648
Ronald Cron7285cda2020-11-26 14:46:37 +01001649psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001650 const psa_key_attributes_t *attributes,
1651 const uint8_t *key_buffer,
1652 size_t key_buffer_size,
1653 uint8_t *data,
1654 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001656{
Ronald Crond18b5f82020-11-25 16:46:05 +01001657 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001658
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001659 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001660 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1661 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001662 /* Exporting public -> public */
1663 return psa_export_key_buffer_internal(
1664 key_buffer, key_buffer_size,
1665 data, data_size, data_length);
1666 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001667#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001668 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1669 return mbedtls_psa_rsa_export_public_key(attributes,
1670 key_buffer,
1671 key_buffer_size,
1672 data,
1673 data_size,
1674 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001675#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001676 /* We don't know how to convert a private RSA key to public. */
1677 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001678#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001679 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001680 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001681#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001682 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1683 return mbedtls_psa_ecp_export_public_key(attributes,
1684 key_buffer,
1685 key_buffer_size,
1686 data,
1687 data_size,
1688 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001689#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001690 /* We don't know how to convert a private ECC key to public */
1691 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001692#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001693 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001694 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001695#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001696 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001697 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001698 key_buffer,
1699 key_buffer_size,
1700 data, data_size,
1701 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001702#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001703 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001704#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001705 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001707 (void) key_buffer;
1708 (void) key_buffer_size;
1709 (void) data;
1710 (void) data_size;
1711 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001713 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001714}
Ronald Crond18b5f82020-11-25 16:46:05 +01001715
Gilles Peskine449bd832023-01-11 14:50:10 +01001716psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1717 uint8_t *data,
1718 size_t data_size,
1719 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001720{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001721 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001722 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001723 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001724 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001725
Ronald Crone907e552021-01-18 13:22:38 +01001726 /* Reject a zero-length output buffer now, since this can never be a
1727 * valid key representation. This way we know that data must be a valid
1728 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 if (data_size == 0) {
1730 return PSA_ERROR_BUFFER_TOO_SMALL;
1731 }
Ronald Crone907e552021-01-18 13:22:38 +01001732
Darryl Greendd8fb772018-11-07 16:00:44 +00001733 /* Set the key to empty now, so that even when there are errors, we always
1734 * set data_length to a value between 0 and data_size. On error, setting
1735 * the key to empty is a good choice because an empty key representation is
1736 * unlikely to be accepted anywhere. */
1737 *data_length = 0;
1738
1739 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1741 if (status != PSA_SUCCESS) {
1742 return status;
1743 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001744
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1746 status = PSA_ERROR_INVALID_ARGUMENT;
1747 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001748 }
1749
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001750 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001751 .core = slot->attr
1752 };
Ronald Cron67227982020-11-26 15:16:05 +01001753 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001754 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001756
1757exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001761}
1762
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001763MBEDTLS_STATIC_ASSERT(
1764 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1765 "One or more key attribute flag is listed as both external-only and dual-use")
1766MBEDTLS_STATIC_ASSERT(
1767 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1768 "One or more key attribute flag is listed as both internal-only and dual-use")
1769MBEDTLS_STATIC_ASSERT(
1770 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1771 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001772
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001773/** Validate that a key policy is internally well-formed.
1774 *
1775 * This function only rejects invalid policies. It does not validate the
1776 * consistency of the policy with respect to other attributes of the key
1777 * such as the key type.
1778 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001779static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001780{
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1782 PSA_KEY_USAGE_COPY |
1783 PSA_KEY_USAGE_ENCRYPT |
1784 PSA_KEY_USAGE_DECRYPT |
1785 PSA_KEY_USAGE_SIGN_MESSAGE |
1786 PSA_KEY_USAGE_VERIFY_MESSAGE |
1787 PSA_KEY_USAGE_SIGN_HASH |
1788 PSA_KEY_USAGE_VERIFY_HASH |
1789 PSA_KEY_USAGE_VERIFY_DERIVATION |
1790 PSA_KEY_USAGE_DERIVE)) != 0) {
1791 return PSA_ERROR_INVALID_ARGUMENT;
1792 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001793
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001795}
1796
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001797/** Validate the internal consistency of key attributes.
1798 *
1799 * This function only rejects invalid attribute values. If does not
1800 * validate the consistency of the attributes with any key data that may
1801 * be involved in the creation of the key.
1802 *
1803 * Call this function early in the key creation process.
1804 *
1805 * \param[in] attributes Key attributes for the new key.
1806 * \param[out] p_drv On any return, the driver for the key, if any.
1807 * NULL for a transparent key.
1808 *
1809 */
1810static psa_status_t psa_validate_key_attributes(
1811 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001813{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001814 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1816 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001817
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 status = psa_validate_key_location(lifetime, p_drv);
1819 if (status != PSA_SUCCESS) {
1820 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001821 }
1822
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 status = psa_validate_key_persistence(lifetime);
1824 if (status != PSA_SUCCESS) {
1825 return status;
1826 }
1827
1828 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1829 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1830 return PSA_ERROR_INVALID_ARGUMENT;
1831 }
1832 } else {
1833 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1834 return PSA_ERROR_INVALID_ARGUMENT;
1835 }
1836 }
1837
1838 status = psa_validate_key_policy(&attributes->core.policy);
1839 if (status != PSA_SUCCESS) {
1840 return status;
1841 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001842
1843 /* Refuse to create overly large keys.
1844 * Note that this doesn't trigger on import if the attributes don't
1845 * explicitly specify a size (so psa_get_key_bits returns 0), so
1846 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1848 return PSA_ERROR_NOT_SUPPORTED;
1849 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001850
Gilles Peskine91e8c332019-08-02 19:19:39 +02001851 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1853 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1854 return PSA_ERROR_INVALID_ARGUMENT;
1855 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001858}
1859
Gilles Peskine4747d192019-04-17 15:05:45 +02001860/** Prepare a key slot to receive key material.
1861 *
1862 * This function allocates a key slot and sets its metadata.
1863 *
1864 * If this function fails, call psa_fail_key_creation().
1865 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001866 * This function is intended to be used as follows:
1867 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001868 * it with the specified attributes, and in case of a volatile key assign it
1869 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001870 * -# Populate the slot with the key material.
1871 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1872 * In case of failure at any step, stop the sequence and call
1873 * psa_fail_key_creation().
1874 *
Ronald Cron5c522922020-11-14 16:35:34 +01001875 * On success, the key slot is locked. It is the responsibility of the caller
1876 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001877 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001878 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001879 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001880 * \param[out] p_slot On success, a pointer to the prepared slot.
1881 * \param[out] p_drv On any return, the driver for the key, if any.
1882 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001883 *
1884 * \retval #PSA_SUCCESS
1885 * The key slot is ready to receive key material.
1886 * \return If this function fails, the key slot is an invalid state.
1887 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001888 */
1889static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001890 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001891 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001892 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001893 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001894{
1895 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001896 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001897 psa_key_slot_t *slot;
1898
Gilles Peskinedf179142019-07-15 22:02:14 +02001899 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001900 *p_drv = NULL;
1901
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 status = psa_validate_key_attributes(attributes, p_drv);
1903 if (status != PSA_SUCCESS) {
1904 return status;
1905 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001906
Gilles Peskine449bd832023-01-11 14:50:10 +01001907 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1908 if (status != PSA_SUCCESS) {
1909 return status;
1910 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001911 slot = *p_slot;
1912
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001913 /* We're storing the declared bit-size of the key. It's up to each
1914 * creation mechanism to verify that this information is correct.
1915 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001916 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001917 * is optional (import, copy). In case of a volatile key, assign it the
1918 * volatile key identifier associated to the slot returned to contain its
1919 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001920
1921 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001923#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1924 slot->attr.id = volatile_key_id;
1925#else
1926 slot->attr.id.key_id = volatile_key_id;
1927#endif
1928 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001929
Gilles Peskine91e8c332019-08-02 19:19:39 +02001930 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001931 * external-only flags, query `attributes`. Thanks to the check
1932 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001933 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001934 * may have set. */
1935 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001936
Gilles Peskinecbaff462019-07-12 23:46:04 +02001937#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001938 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001939 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001940 * create the key file in internal storage, create the
1941 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001942 * persistent data. This is done by starting a transaction that will
1943 * encompass these three actions.
1944 * For registering a volatile key, we just need to find an appropriate
1945 * slot number inside the SE. Since the key is designated volatile, creating
1946 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001947 /* The first thing to do is to find a slot number for the new key.
1948 * We save the slot number in persistent storage as part of the
1949 * transaction data. It will be needed to recover if the power
1950 * fails during the key creation process, to clean up on the secure
1951 * element side after restarting. Obtaining a slot number from the
1952 * secure element driver updates its persistent state, but we do not yet
1953 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001954 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001956 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1958 &slot_number);
1959 if (status != PSA_SUCCESS) {
1960 return status;
1961 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001962
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1964 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001965 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001966 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001967 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 status = psa_crypto_save_transaction();
1969 if (status != PSA_SUCCESS) {
1970 (void) psa_crypto_stop_transaction();
1971 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001972 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001973 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001974
1975 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001977 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001978
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001980 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001982 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001983#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1984
Ryan Everett975d4112023-11-16 13:37:51 +00001985 slot->status = PSA_SLOT_OCCUPIED;
1986
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001988}
Gilles Peskine4747d192019-04-17 15:05:45 +02001989
1990/** Finalize the creation of a key once its key material has been set.
1991 *
1992 * This entails writing the key to persistent storage.
1993 *
1994 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001995 * See the documentation of psa_start_key_creation() for the intended use
1996 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001997 *
Ronald Cron5c522922020-11-14 16:35:34 +01001998 * If the finalization succeeds, the function unlocks the key slot (it was
1999 * locked by psa_start_key_creation()) and the key slot cannot be accessed
2000 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01002001 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002002 * \param[in,out] slot Pointer to the slot with key material.
2003 * \param[in] driver The secure element driver for the key,
2004 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01002005 * \param[out] key On success, identifier of the key. Note that the
2006 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002007 *
2008 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02002009 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01002010 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
2011 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
2012 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
2013 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
2014 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
2015 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01002016 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002017 * \return If this function fails, the key slot is an invalid state.
2018 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02002019 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002020static psa_status_t psa_finish_key_creation(
2021 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01002022 psa_se_drv_table_entry_t *driver,
2023 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002024{
2025 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02002026 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02002027 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02002028
2029#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02002031#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002032 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002033 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01002034 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01002036
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00002037 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
2038 sizeof(data.slot_number),
2039 "Slot number size does not match psa_se_key_data_storage_t");
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
2042 status = psa_save_persistent_key(&slot->attr,
2043 (uint8_t *) &data,
2044 sizeof(data));
2045 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02002046#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2047 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002048 /* Key material is saved in export representation in the slot, so
2049 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 status = psa_save_persistent_key(&slot->attr,
2051 slot->key.data,
2052 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02002053 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002054 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002055#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2056
Gilles Peskinecbaff462019-07-12 23:46:04 +02002057#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002058 /* Finish the transaction for a key creation. This does not
2059 * happen when registering an existing key. Detect this case
2060 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002061 * creation of a persistent key in a secure element requires a transaction,
2062 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 if (driver != NULL &&
2064 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
2065 status = psa_save_se_persistent_data(driver);
2066 if (status != PSA_SUCCESS) {
2067 psa_destroy_persistent_key(slot->attr.id);
2068 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02002069 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02002071 }
2072#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2073
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002075 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 status = psa_unlock_key_slot(slot);
2077 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002078 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002080 }
Ronald Cron50972942020-11-14 11:28:25 +01002081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002083}
2084
2085/** Abort the creation of a key.
2086 *
2087 * You may call this function after calling psa_start_key_creation(),
2088 * or after psa_finish_key_creation() fails. In other circumstances, this
2089 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002090 * See the documentation of psa_start_key_creation() for the intended use
2091 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002092 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002093 * \param[in,out] slot Pointer to the slot with key material.
2094 * \param[in] driver The secure element driver for the key,
2095 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002096 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002097static void psa_fail_key_creation(psa_key_slot_t *slot,
2098 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02002099{
Gilles Peskine011e4282019-06-26 18:34:38 +02002100 (void) driver;
2101
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02002103 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 }
Gilles Peskine011e4282019-06-26 18:34:38 +02002105
2106#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002107 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002108 * element, and the failure happened later (when saving metadata
2109 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002110 * element.
2111 * https://github.com/ARMmbed/mbed-crypto/issues/217
2112 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002113
Gilles Peskined7729582019-08-05 15:55:54 +02002114 /* Abort the ongoing transaction if any (there may not be one if
2115 * the creation process failed before starting one, or if the
2116 * key creation is a registration of a key in a secure element).
2117 * Earlier functions must already have done what it takes to undo any
2118 * partial creation. All that's left is to update the transaction data
2119 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002121#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2122
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02002124}
2125
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002126/** Validate optional attributes during key creation.
2127 *
2128 * Some key attributes are optional during key creation. If they are
2129 * specified in the attributes structure, check that they are consistent
2130 * with the data in the slot.
2131 *
2132 * This function should be called near the end of key creation, after
2133 * the slot in memory is fully populated but before saving persistent data.
2134 */
2135static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002136 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002138{
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 if (attributes->core.type != 0) {
2140 if (attributes->core.type != slot->attr.type) {
2141 return PSA_ERROR_INVALID_ARGUMENT;
2142 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002143 }
2144
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002146#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2147 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2149 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002150 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002151 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002152 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002153
Ronald Cron90857082020-11-25 14:58:33 +01002154 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 slot->attr.type,
2156 slot->key.data,
2157 slot->key.bytes,
2158 &rsa);
2159 if (status != PSA_SUCCESS) {
2160 return status;
2161 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002162
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 mbedtls_mpi_init(&actual);
2164 mbedtls_mpi_init(&required);
2165 ret = mbedtls_rsa_export(rsa,
2166 NULL, NULL, NULL, NULL, &actual);
2167 mbedtls_rsa_free(rsa);
2168 mbedtls_free(rsa);
2169 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002170 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002171 }
2172 ret = mbedtls_mpi_read_binary(&required,
2173 attributes->domain_parameters,
2174 attributes->domain_parameters_size);
2175 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002176 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 }
2178 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002179 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 }
2181rsa_exit:
2182 mbedtls_mpi_free(&actual);
2183 mbedtls_mpi_free(&required);
2184 if (ret != 0) {
2185 return mbedtls_to_psa_error(ret);
2186 }
2187 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002188#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2189 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002190 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002191 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002193 }
2194 }
2195
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 if (attributes->core.bits != 0) {
2197 if (attributes->core.bits != slot->attr.bits) {
2198 return PSA_ERROR_INVALID_ARGUMENT;
2199 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002200 }
2201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002203}
2204
Gilles Peskine449bd832023-01-11 14:50:10 +01002205psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everettf028fe12024-01-08 17:14:44 +00002206 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 size_t data_length,
2208 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002209{
2210 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002211 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002212 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002213 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002214 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302215 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002216
Ronald Cron81709fc2020-11-14 12:10:32 +01002217 *key = MBEDTLS_SVC_KEY_ID_INIT;
2218
Gilles Peskine0f84d622019-09-12 19:03:13 +02002219 /* Reject zero-length symmetric keys (including raw data key objects).
2220 * This also rejects any key which might be encoded as an empty string,
2221 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 if (data_length == 0) {
2223 return PSA_ERROR_INVALID_ARGUMENT;
2224 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002225
Archana449608b2021-09-08 15:36:05 +05302226 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 if (data_length > SIZE_MAX / 8) {
2228 return PSA_ERROR_NOT_SUPPORTED;
2229 }
Archana6ed4bda2021-08-04 10:47:15 +05302230
Ryan Everettf028fe12024-01-08 17:14:44 +00002231 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2232
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2234 &slot, &driver);
2235 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002236 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002238
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002239 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302240 * storage ( thus not in the case of importing a key in a secure element
2241 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2242 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 if (slot->key.data == NULL) {
2244 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302245 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 attributes, data, data_length, &storage_size);
2247 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302248 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 }
Archanad8a83dc2021-06-14 10:04:16 +05302250 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 status = psa_allocate_buffer_to_slot(slot, storage_size);
2252 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002253 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002255 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002256
2257 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 status = psa_driver_wrapper_import_key(attributes,
2259 data, data_length,
2260 slot->key.data,
2261 slot->key.bytes,
2262 &slot->key.bytes, &bits);
2263 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002264 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002268 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002270 status = PSA_ERROR_INVALID_ARGUMENT;
2271 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002272 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002273
Archana6ed4bda2021-08-04 10:47:15 +05302274 /* Enforce a size limit, and in particular ensure that the bit
2275 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302277 status = PSA_ERROR_NOT_SUPPORTED;
2278 goto exit;
2279 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 status = psa_validate_optional_attributes(slot, attributes);
2281 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002282 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002284
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002286exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002287 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 if (status != PSA_SUCCESS) {
2289 psa_fail_key_creation(slot, driver);
2290 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002291
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002293}
2294
Gilles Peskined7729582019-08-05 15:55:54 +02002295#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2296psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002298{
2299 psa_status_t status;
2300 psa_key_slot_t *slot = NULL;
2301 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002302 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002303
2304 /* Leaving attributes unspecified is not currently supported.
2305 * It could make sense to query the key type and size from the
2306 * secure element, but not all secure elements support this
2307 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2309 return PSA_ERROR_NOT_SUPPORTED;
2310 }
2311 if (psa_get_key_bits(attributes) == 0) {
2312 return PSA_ERROR_NOT_SUPPORTED;
2313 }
Gilles Peskined7729582019-08-05 15:55:54 +02002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2316 &slot, &driver);
2317 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002318 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 }
Gilles Peskined7729582019-08-05 15:55:54 +02002320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002322
2323exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 if (status != PSA_SUCCESS) {
2325 psa_fail_key_creation(slot, driver);
2326 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002327
Gilles Peskined7729582019-08-05 15:55:54 +02002328 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 psa_close_key(key);
2330 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002331}
2332#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2333
Gilles Peskine449bd832023-01-11 14:50:10 +01002334psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2335 const psa_key_attributes_t *specified_attributes,
2336 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002337{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002338 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002339 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002340 psa_key_slot_t *source_slot = NULL;
2341 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002342 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002343 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302344 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002345
Ronald Cron81709fc2020-11-14 12:10:32 +01002346 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2347
Archana8a180362021-07-05 02:18:48 +05302348 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2350 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002351 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002353
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 status = psa_validate_optional_attributes(source_slot,
2355 specified_attributes);
2356 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002357 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002359
Archana9d17bf42021-09-10 06:22:44 +05302360 /* The target key type and number of bits have been validated by
2361 * psa_validate_optional_attributes() to be either equal to zero or
2362 * equal to the ones of the source key. So it is safe to inherit
2363 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302364 * */
Archana9d17bf42021-09-10 06:22:44 +05302365 actual_attributes.core.bits = source_slot->attr.bits;
2366 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302367
2368
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 status = psa_restrict_key_policy(source_slot->attr.type,
2370 &actual_attributes.core.policy,
2371 &source_slot->attr.policy);
2372 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002373 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2377 &target_slot, &driver);
2378 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002379 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 }
2381 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2382 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302383 /*
Archana9d17bf42021-09-10 06:22:44 +05302384 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302385 * the source key would need to be exported as plaintext and re-imported
2386 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302387 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302388 * appropriate API invocations from the application, if needed.
2389 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002390 status = PSA_ERROR_NOT_SUPPORTED;
2391 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002392 }
Archana8a180362021-07-05 02:18:48 +05302393 /*
2394 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302395 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302396 * - For opaque keys this translates to an invocation of the drivers'
2397 * copy_key entry point through the dispatch layer.
2398 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2400 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2401 &storage_size);
2402 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302403 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 }
Archana374fe5b2021-09-08 15:50:28 +05302405
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2407 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302408 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 }
Archana374fe5b2021-09-08 15:50:28 +05302410
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 status = psa_driver_wrapper_copy_key(&actual_attributes,
2412 source_slot->key.data,
2413 source_slot->key.bytes,
2414 target_slot->key.data,
2415 target_slot->key.bytes,
2416 &target_slot->key.bytes);
2417 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302418 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 }
2420 } else {
2421 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302422 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 source_slot->key.bytes);
2424 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302425 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 }
Archana8a180362021-07-05 02:18:48 +05302427 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002429exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 if (status != PSA_SUCCESS) {
2431 psa_fail_key_creation(target_slot, driver);
2432 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002433
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002435
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002437}
2438
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002439
2440
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002441/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002442/* Message digests */
2443/****************************************************************/
2444
Gilles Peskine449bd832023-01-11 14:50:10 +01002445psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002446{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002447 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 if (operation->id == 0) {
2449 return PSA_SUCCESS;
2450 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002453 operation->id = 0;
2454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002456}
2457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2459 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002460{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002461 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002462
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002463 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002465 status = PSA_ERROR_BAD_STATE;
2466 goto exit;
2467 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002468
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002470 status = PSA_ERROR_INVALID_ARGUMENT;
2471 goto exit;
2472 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002473
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002474 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2475 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002477
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002479
2480exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002481 if (status != PSA_SUCCESS) {
2482 psa_hash_abort(operation);
2483 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002484
2485 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002486}
2487
Gilles Peskine449bd832023-01-11 14:50:10 +01002488psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2489 const uint8_t *input,
2490 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002491{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002492 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2493
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002495 status = PSA_ERROR_BAD_STATE;
2496 goto exit;
2497 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002498
Steven Cooremanc8288352021-03-04 14:02:19 +01002499 /* Don't require hash implementations to behave correctly on a
2500 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 if (input_length == 0) {
2502 return PSA_SUCCESS;
2503 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002504
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002506
2507exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 if (status != PSA_SUCCESS) {
2509 psa_hash_abort(operation);
2510 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002511
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002513}
2514
Gilles Peskine449bd832023-01-11 14:50:10 +01002515psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2516 uint8_t *hash,
2517 size_t hash_size,
2518 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002519{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002520 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 if (operation->id == 0) {
2522 return PSA_ERROR_BAD_STATE;
2523 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002524
Steven Cooreman1e582352021-02-18 17:24:37 +01002525 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 operation, hash, hash_size, hash_length);
2527 psa_hash_abort(operation);
2528 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002529}
2530
Gilles Peskine449bd832023-01-11 14:50:10 +01002531psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2532 const uint8_t *hash,
2533 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002534{
Ronald Cron69a63422021-10-18 09:47:58 +02002535 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002536 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002537 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 operation,
2539 actual_hash, sizeof(actual_hash),
2540 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002541
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002543 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002545
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002547 status = PSA_ERROR_INVALID_SIGNATURE;
2548 goto exit;
2549 }
2550
Dave Rodgman78701152023-08-29 14:20:18 +01002551 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002552 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002554
2555exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2557 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002558 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002562}
2563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564psa_status_t psa_hash_compute(psa_algorithm_t alg,
2565 const uint8_t *input, size_t input_length,
2566 uint8_t *hash, size_t hash_size,
2567 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002568{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002569 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 if (!PSA_ALG_IS_HASH(alg)) {
2571 return PSA_ERROR_INVALID_ARGUMENT;
2572 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002573
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2575 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002576}
2577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578psa_status_t psa_hash_compare(psa_algorithm_t alg,
2579 const uint8_t *input, size_t input_length,
2580 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002581{
Ronald Cron69a63422021-10-18 09:47:58 +02002582 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002583 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002584
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 if (!PSA_ALG_IS_HASH(alg)) {
2586 return PSA_ERROR_INVALID_ARGUMENT;
2587 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002588
Steven Cooreman1e582352021-02-18 17:24:37 +01002589 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 alg, input, input_length,
2591 actual_hash, sizeof(actual_hash),
2592 &actual_hash_length);
2593 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002594 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 }
2596 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002597 status = PSA_ERROR_INVALID_SIGNATURE;
2598 goto exit;
2599 }
Dave Rodgman78701152023-08-29 14:20:18 +01002600 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002601 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002603
2604exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2606 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002607}
2608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2610 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002611{
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 if (source_operation->id == 0 ||
2613 target_operation->id != 0) {
2614 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002615 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002616
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2618 target_operation);
2619 if (status != PSA_SUCCESS) {
2620 psa_hash_abort(target_operation);
2621 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002622
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002624}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002625
2626
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002627/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002628/* MAC */
2629/****************************************************************/
2630
Gilles Peskine449bd832023-01-11 14:50:10 +01002631psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002632{
Steven Cooremane6804192021-03-19 18:28:56 +01002633 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 if (operation->id == 0) {
2635 return PSA_SUCCESS;
2636 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002637
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002639 operation->mac_size = 0;
2640 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002641 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002642
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002644}
2645
Ronald Cron2dff3b22021-06-17 16:33:22 +02002646static psa_status_t psa_mac_finalize_alg_and_key_validation(
2647 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002648 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002650{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002651 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 psa_key_type_t key_type = psa_get_key_type(attributes);
2653 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002654
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 if (!PSA_ALG_IS_MAC(alg)) {
2656 return PSA_ERROR_INVALID_ARGUMENT;
2657 }
Steven Cooremane6804192021-03-19 18:28:56 +01002658
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002659 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 status = psa_mac_key_can_do(alg, key_type);
2661 if (status != PSA_SUCCESS) {
2662 return status;
2663 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002664
Steven Cooremand1a68f12021-05-10 11:13:41 +02002665 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002669 /* A very short MAC is too short for security since it can be
2670 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2671 * so we make this our minimum, even though 32 bits is still
2672 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002674 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2677 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002678 /* It's impossible to "truncate" to a larger length than the full length
2679 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002681 }
2682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002684 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2685 * that is disabled in the compile-time configuration. The result can
2686 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2687 * configuration into account. In this case, force a return of
2688 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2689 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2690 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2691 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2692 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002693 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002694 }
2695
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002697}
2698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2700 mbedtls_svc_key_id_t key,
2701 psa_algorithm_t alg,
2702 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002703{
2704 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2705 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002706 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002707 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002708
2709 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002711 status = PSA_ERROR_BAD_STATE;
2712 goto exit;
2713 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002714
2715 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 key,
2717 &slot,
2718 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2719 alg);
2720 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002721 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002723
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002724 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002725 .core = slot->attr
2726 };
2727
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2729 &operation->mac_size);
2730 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002731 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002733
2734 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002735 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 if (is_sign) {
2737 status = psa_driver_wrapper_mac_sign_setup(operation,
2738 &attributes,
2739 slot->key.data,
2740 slot->key.bytes,
2741 alg);
2742 } else {
2743 status = psa_driver_wrapper_mac_verify_setup(operation,
2744 &attributes,
2745 slot->key.data,
2746 slot->key.bytes,
2747 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002748 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002749
Gilles Peskinefbfac682018-07-08 20:51:54 +02002750exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 if (status != PSA_SUCCESS) {
2752 psa_mac_abort(operation);
2753 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002754
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002756
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002758}
2759
Gilles Peskine449bd832023-01-11 14:50:10 +01002760psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2761 mbedtls_svc_key_id_t key,
2762 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002763{
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002765}
2766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2768 mbedtls_svc_key_id_t key,
2769 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002770{
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002772}
2773
Gilles Peskine449bd832023-01-11 14:50:10 +01002774psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2775 const uint8_t *input,
2776 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002777{
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 if (operation->id == 0) {
2779 return PSA_ERROR_BAD_STATE;
2780 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002781
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002782 /* Don't require hash implementations to behave correctly on a
2783 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 if (input_length == 0) {
2785 return PSA_SUCCESS;
2786 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2789 input, input_length);
2790 if (status != PSA_SUCCESS) {
2791 psa_mac_abort(operation);
2792 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002795}
2796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2798 uint8_t *mac,
2799 size_t mac_size,
2800 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002801{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002802 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2803 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002804
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002806 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002807 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002808 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002809
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002811 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002812 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002813 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002814
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002815 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2816 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002818 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002819 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002820 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002821
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002823 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002824 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002825 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 status = psa_driver_wrapper_mac_sign_finish(operation,
2828 mac, operation->mac_size,
2829 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002830
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002831exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002832 /* In case of success, set the potential excess room in the output buffer
2833 * to an invalid value, to avoid potentially leaking a longer MAC.
2834 * In case of error, set the output length and content to a safe default,
2835 * such that in case the caller misses an error check, the output would be
2836 * an unachievable MAC.
2837 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002839 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002840 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002841 }
mohammad16036df908f2018-04-02 08:34:15 -07002842
Paul Elliottdc42ca82023-02-24 18:11:59 +00002843 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002844
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002848}
2849
Gilles Peskine449bd832023-01-11 14:50:10 +01002850psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2851 const uint8_t *mac,
2852 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002853{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002854 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2855 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002856
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002858 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002859 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002860 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002863 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002864 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002865 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002868 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002869 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002870 }
2871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 status = psa_driver_wrapper_mac_verify_finish(operation,
2873 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002874
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002875exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002877
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002879}
2880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2882 psa_algorithm_t alg,
2883 const uint8_t *input,
2884 size_t input_length,
2885 uint8_t *mac,
2886 size_t mac_size,
2887 size_t *mac_length,
2888 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002889{
2890 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002891 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2892 psa_key_slot_t *slot;
2893 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002894 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002895
Ronald Cron51131b52021-06-17 17:17:20 +02002896 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 key,
2898 &slot,
2899 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2900 alg);
2901 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002902 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002904
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002905 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002906 .core = slot->attr
2907 };
2908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2910 &operation_mac_size);
2911 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002912 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002916 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002917 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002918 }
2919
2920 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 &attributes,
2922 slot->key.data, slot->key.bytes,
2923 alg,
2924 input, input_length,
2925 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002926
2927exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002928 /* In case of success, set the potential excess room in the output buffer
2929 * to an invalid value, to avoid potentially leaking a longer MAC.
2930 * In case of error, set the output length and content to a safe default,
2931 * such that in case the caller misses an error check, the output would be
2932 * an unachievable MAC.
2933 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002935 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002936 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002937 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002938
2939 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002940
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002944}
2945
Gilles Peskine449bd832023-01-11 14:50:10 +01002946psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002947 psa_algorithm_t alg,
2948 const uint8_t *input,
2949 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 uint8_t *mac,
2951 size_t mac_size,
2952 size_t *mac_length)
2953{
2954 return psa_mac_compute_internal(key, alg,
2955 input, input_length,
2956 mac, mac_size, mac_length, 1);
2957}
2958
2959psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2960 psa_algorithm_t alg,
2961 const uint8_t *input,
2962 size_t input_length,
2963 const uint8_t *mac,
2964 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002965{
2966 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002967 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2968 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002969
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 status = psa_mac_compute_internal(key, alg,
2971 input, input_length,
2972 actual_mac, sizeof(actual_mac),
2973 &actual_mac_length, 0);
2974 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002975 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002977
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 if (mac_length != actual_mac_length) {
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 }
Dave Rodgman78701152023-08-29 14:20:18 +01002982 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002983 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002984 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002985 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002986
2987exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002989
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002991}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002992
Gilles Peskinee59236f2018-01-27 23:32:46 +01002993/****************************************************************/
2994/* Asymmetric cryptography */
2995/****************************************************************/
2996
Gilles Peskine449bd832023-01-11 14:50:10 +01002997static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2998 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002999{
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 if (input_is_message) {
3001 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
3002 return PSA_ERROR_INVALID_ARGUMENT;
3003 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 if (PSA_ALG_IS_SIGN_HASH(alg)) {
3006 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
3007 return PSA_ERROR_INVALID_ARGUMENT;
3008 }
3009 }
3010 } else {
3011 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
3012 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003013 }
3014 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003015
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003017}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
3020 int input_is_message,
3021 psa_algorithm_t alg,
3022 const uint8_t *input,
3023 size_t input_length,
3024 uint8_t *signature,
3025 size_t signature_size,
3026 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003027{
3028 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3029 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3030 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003031 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003032
3033 *signature_length = 0;
3034
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 status = psa_sign_verify_check_alg(input_is_message, alg);
3036 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003037 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003039
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003040 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02003041 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003042 * buffer can in principle be empty since it doesn't actually have
3043 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 if (signature_size == 0) {
3045 return PSA_ERROR_BUFFER_TOO_SMALL;
3046 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003047
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003048 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 key, &slot,
3050 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
3051 PSA_KEY_USAGE_SIGN_HASH,
3052 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003055 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003057
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003059 status = PSA_ERROR_INVALID_ARGUMENT;
3060 goto exit;
3061 }
3062
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003063 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003065 };
3066
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003068 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003069 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003070 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003071 signature, signature_size, signature_length);
3072 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003073
3074 status = psa_driver_wrapper_sign_hash(
3075 &attributes, slot->key.data, slot->key.bytes,
3076 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003078 }
3079
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003080
3081exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003082 psa_wipe_tag_output_buffer(signature, status, signature_size,
3083 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003086
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003088}
3089
Gilles Peskine449bd832023-01-11 14:50:10 +01003090static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3091 int input_is_message,
3092 psa_algorithm_t alg,
3093 const uint8_t *input,
3094 size_t input_length,
3095 const uint8_t *signature,
3096 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003097{
3098 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3099 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3100 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003101
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 status = psa_sign_verify_check_alg(input_is_message, alg);
3103 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003104 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003106
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003107 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 key, &slot,
3109 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3110 PSA_KEY_USAGE_VERIFY_HASH,
3111 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003112
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 if (status != PSA_SUCCESS) {
3114 return status;
3115 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003116
3117 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003119 };
3120
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003122 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003123 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003124 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 signature, signature_length);
3126 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003127 status = psa_driver_wrapper_verify_hash(
3128 &attributes, slot->key.data, slot->key.bytes,
3129 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003130 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003131 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003132
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003134
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003136
3137}
3138
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003139psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003140 const psa_key_attributes_t *attributes,
3141 const uint8_t *key_buffer,
3142 size_t key_buffer_size,
3143 psa_algorithm_t alg,
3144 const uint8_t *input,
3145 size_t input_length,
3146 uint8_t *signature,
3147 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003149{
3150 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003151
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003153 size_t hash_length;
3154 uint8_t hash[PSA_HASH_MAX_SIZE];
3155
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003156 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003157 PSA_ALG_SIGN_GET_HASH(alg),
3158 input, input_length,
3159 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003160
Gilles Peskine449bd832023-01-11 14:50:10 +01003161 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003162 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003163 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003164
3165 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003166 attributes, key_buffer, key_buffer_size,
3167 alg, hash, hash_length,
3168 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003169 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003170
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003172}
3173
Gilles Peskine449bd832023-01-11 14:50:10 +01003174psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3175 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003176 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003178 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 size_t signature_size,
3180 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003181{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3183 LOCAL_INPUT_DECLARE(input_external, input);
3184 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3185
3186 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3187 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3188 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3189 signature_size, signature_length);
3190
Thomas Daubney3e65f522024-01-30 12:37:25 +00003191#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003192exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003193#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003194 LOCAL_INPUT_FREE(input_external, input);
3195 LOCAL_OUTPUT_FREE(signature_external, signature);
3196 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003197}
3198
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003199psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003200 const psa_key_attributes_t *attributes,
3201 const uint8_t *key_buffer,
3202 size_t key_buffer_size,
3203 psa_algorithm_t alg,
3204 const uint8_t *input,
3205 size_t input_length,
3206 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003208{
3209 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003210
Gilles Peskine449bd832023-01-11 14:50:10 +01003211 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003212 size_t hash_length;
3213 uint8_t hash[PSA_HASH_MAX_SIZE];
3214
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003215 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 PSA_ALG_SIGN_GET_HASH(alg),
3217 input, input_length,
3218 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003221 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003223
3224 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003225 attributes, key_buffer, key_buffer_size,
3226 alg, hash, hash_length,
3227 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003228 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003229
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003231}
3232
Gilles Peskine449bd832023-01-11 14:50:10 +01003233psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3234 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003235 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003237 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003239{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003240 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3241 LOCAL_INPUT_DECLARE(input_external, input);
3242 LOCAL_INPUT_DECLARE(signature_external, signature);
3243
3244 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3245 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3246 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3247 signature_length);
3248
Thomas Daubney3e65f522024-01-30 12:37:25 +00003249#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003250exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003251#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003252 LOCAL_INPUT_FREE(input_external, input);
3253 LOCAL_INPUT_FREE(signature_external, signature);
3254
3255 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003256}
3257
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003258psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003259 const psa_key_attributes_t *attributes,
3260 const uint8_t *key_buffer, size_t key_buffer_size,
3261 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003262 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003263{
Gilles Peskine449bd832023-01-11 14:50:10 +01003264 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3265 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3266 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003267#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3269 return mbedtls_psa_rsa_sign_hash(
3270 attributes,
3271 key_buffer, key_buffer_size,
3272 alg, hash, hash_length,
3273 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003274#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3275 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 } else {
3277 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003278 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003279 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3280 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003281#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3283 return mbedtls_psa_ecdsa_sign_hash(
3284 attributes,
3285 key_buffer, key_buffer_size,
3286 alg, hash, hash_length,
3287 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003288#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3289 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003290 } else {
3291 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003292 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003293 }
Ronald Cron4501c982021-03-19 20:09:32 +01003294
Gilles Peskine449bd832023-01-11 14:50:10 +01003295 (void) key_buffer;
3296 (void) key_buffer_size;
3297 (void) hash;
3298 (void) hash_length;
3299 (void) signature;
3300 (void) signature_size;
3301 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003302
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003304}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003305
Gilles Peskine449bd832023-01-11 14:50:10 +01003306psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3307 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003308 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003310 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003311 size_t signature_size,
3312 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003313{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003314 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3315 LOCAL_INPUT_DECLARE(hash_external, hash);
3316 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3317
3318 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3319 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3320 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3321 signature_size, signature_length);
3322
Thomas Daubney3e65f522024-01-30 12:37:25 +00003323#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003324exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003325#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003326 LOCAL_INPUT_FREE(hash_external, hash);
3327 LOCAL_OUTPUT_FREE(signature_external, signature);
3328
3329 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003330}
3331
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003332psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003333 const psa_key_attributes_t *attributes,
3334 const uint8_t *key_buffer, size_t key_buffer_size,
3335 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003337{
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3339 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3340 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003341#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3343 return mbedtls_psa_rsa_verify_hash(
3344 attributes,
3345 key_buffer, key_buffer_size,
3346 alg, hash, hash_length,
3347 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003348#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3349 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003350 } else {
3351 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003352 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003353 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3354 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003355#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3357 return mbedtls_psa_ecdsa_verify_hash(
3358 attributes,
3359 key_buffer, key_buffer_size,
3360 alg, hash, hash_length,
3361 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003362#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3363 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 } else {
3365 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003366 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003367 }
Ronald Cron4501c982021-03-19 20:09:32 +01003368
Gilles Peskine449bd832023-01-11 14:50:10 +01003369 (void) key_buffer;
3370 (void) key_buffer_size;
3371 (void) hash;
3372 (void) hash_length;
3373 (void) signature;
3374 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003375
Gilles Peskine449bd832023-01-11 14:50:10 +01003376 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003377}
3378
Gilles Peskine449bd832023-01-11 14:50:10 +01003379psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3380 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003381 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003383 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003385{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003386 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3387 LOCAL_INPUT_DECLARE(hash_external, hash);
3388 LOCAL_INPUT_DECLARE(signature_external, signature);
3389
3390 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3391 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3392 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3393 signature_length);
3394
Thomas Daubney3e65f522024-01-30 12:37:25 +00003395#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003396exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003397#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003398 LOCAL_INPUT_FREE(hash_external, hash);
3399 LOCAL_INPUT_FREE(signature_external, signature);
3400
3401 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003402}
3403
Gilles Peskine449bd832023-01-11 14:50:10 +01003404psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3405 psa_algorithm_t alg,
3406 const uint8_t *input,
3407 size_t input_length,
3408 const uint8_t *salt,
3409 size_t salt_length,
3410 uint8_t *output,
3411 size_t output_size,
3412 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003413{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003414 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003415 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003416 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003417 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003418
Darryl Green5cc689a2018-07-24 15:34:10 +01003419 (void) input;
3420 (void) input_length;
3421 (void) salt;
3422 (void) output;
3423 (void) output_size;
3424
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003425 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003426
Gilles Peskine449bd832023-01-11 14:50:10 +01003427 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3428 return PSA_ERROR_INVALID_ARGUMENT;
3429 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003430
Ronald Cron5c522922020-11-14 16:35:34 +01003431 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003432 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3433 if (status != PSA_SUCCESS) {
3434 return status;
3435 }
3436 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3437 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003438 status = PSA_ERROR_INVALID_ARGUMENT;
3439 goto exit;
3440 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003441
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003442 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003443 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003444 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003445
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003446 status = psa_driver_wrapper_asymmetric_encrypt(
3447 &attributes, slot->key.data, slot->key.bytes,
3448 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003449 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003450exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003451 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003452
Gilles Peskine449bd832023-01-11 14:50:10 +01003453 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003454}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003455
Gilles Peskine449bd832023-01-11 14:50:10 +01003456psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3457 psa_algorithm_t alg,
3458 const uint8_t *input,
3459 size_t input_length,
3460 const uint8_t *salt,
3461 size_t salt_length,
3462 uint8_t *output,
3463 size_t output_size,
3464 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003465{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003466 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003467 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003468 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003469 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003470
Darryl Green5cc689a2018-07-24 15:34:10 +01003471 (void) input;
3472 (void) input_length;
3473 (void) salt;
3474 (void) output;
3475 (void) output_size;
3476
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003477 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003478
Gilles Peskine449bd832023-01-11 14:50:10 +01003479 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3480 return PSA_ERROR_INVALID_ARGUMENT;
3481 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003482
Ronald Cron5c522922020-11-14 16:35:34 +01003483 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003484 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3485 if (status != PSA_SUCCESS) {
3486 return status;
3487 }
3488 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003489 status = PSA_ERROR_INVALID_ARGUMENT;
3490 goto exit;
3491 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003492
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003493 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003494 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003495 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003496
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003497 status = psa_driver_wrapper_asymmetric_decrypt(
3498 &attributes, slot->key.data, slot->key.bytes,
3499 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003500 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003501
3502exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003503 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003504
Gilles Peskine449bd832023-01-11 14:50:10 +01003505 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003506}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003507
Paul Elliott9fe12f62022-11-30 19:16:02 +00003508/****************************************************************/
3509/* Asymmetric interruptible cryptography */
3510/****************************************************************/
3511
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003512static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3513
Paul Elliott9fe12f62022-11-30 19:16:02 +00003514void psa_interruptible_set_max_ops(uint32_t max_ops)
3515{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003516 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003517}
3518
3519uint32_t psa_interruptible_get_max_ops(void)
3520{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003521 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003522}
3523
Paul Elliott9fe12f62022-11-30 19:16:02 +00003524uint32_t psa_sign_hash_get_num_ops(
3525 const psa_sign_hash_interruptible_operation_t *operation)
3526{
Paul Elliott296ede92022-12-15 17:00:30 +00003527 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003528}
3529
3530uint32_t psa_verify_hash_get_num_ops(
3531 const psa_verify_hash_interruptible_operation_t *operation)
3532{
Paul Elliott296ede92022-12-15 17:00:30 +00003533 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003534}
3535
Paul Elliott59ad9452022-12-18 15:09:02 +00003536static psa_status_t psa_sign_hash_abort_internal(
3537 psa_sign_hash_interruptible_operation_t *operation)
3538{
3539 if (operation->id == 0) {
3540 /* The object has (apparently) been initialized but it is not (yet)
3541 * in use. It's ok to call abort on such an object, and there's
3542 * nothing to do. */
3543 return PSA_SUCCESS;
3544 }
3545
3546 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3547
3548 status = psa_driver_wrapper_sign_hash_abort(operation);
3549
3550 operation->id = 0;
3551
Paul Elliotte6145dc2023-02-07 12:51:21 +00003552 /* Do not clear either the error_occurred or num_ops elements here as they
3553 * only want to be cleared by the application calling abort, not by abort
3554 * being called at completion of an operation. */
3555
Paul Elliott59ad9452022-12-18 15:09:02 +00003556 return status;
3557}
3558
Paul Elliott9fe12f62022-11-30 19:16:02 +00003559psa_status_t psa_sign_hash_start(
3560 psa_sign_hash_interruptible_operation_t *operation,
3561 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3562 const uint8_t *hash, size_t hash_length)
3563{
3564 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3565 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3566 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003567 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003568
Paul Elliottc9774412023-02-06 15:14:07 +00003569 /* Check that start has not been previously called, or operation has not
3570 * previously errored. */
3571 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003572 return PSA_ERROR_BAD_STATE;
3573 }
3574
Paul Elliott9fe12f62022-11-30 19:16:02 +00003575 status = psa_sign_verify_check_alg(0, alg);
3576 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003577 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003578 return status;
3579 }
3580
3581 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3582 PSA_KEY_USAGE_SIGN_HASH,
3583 alg);
3584
3585 if (status != PSA_SUCCESS) {
3586 goto exit;
3587 }
3588
3589 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3590 status = PSA_ERROR_INVALID_ARGUMENT;
3591 goto exit;
3592 }
3593
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003594 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003595 .core = slot->attr
3596 };
3597
Paul Elliott296ede92022-12-15 17:00:30 +00003598 /* Ensure ops count gets reset, in case of operation re-use. */
3599 operation->num_ops = 0;
3600
Paul Elliott9fe12f62022-11-30 19:16:02 +00003601 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3602 slot->key.data,
3603 slot->key.bytes, alg,
3604 hash, hash_length);
3605exit:
3606
3607 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003608 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003609 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003610 }
3611
3612 unlock_status = psa_unlock_key_slot(slot);
3613
Paul Elliottc9774412023-02-06 15:14:07 +00003614 if (unlock_status != PSA_SUCCESS) {
3615 operation->error_occurred = 1;
3616 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003617
Paul Elliottc9774412023-02-06 15:14:07 +00003618 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003619}
3620
3621
3622psa_status_t psa_sign_hash_complete(
3623 psa_sign_hash_interruptible_operation_t *operation,
3624 uint8_t *signature, size_t signature_size,
3625 size_t *signature_length)
3626{
3627 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3628
3629 *signature_length = 0;
3630
Paul Elliottc9774412023-02-06 15:14:07 +00003631 /* Check that start has been called first, and that operation has not
3632 * previously errored. */
3633 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003634 status = PSA_ERROR_BAD_STATE;
3635 goto exit;
3636 }
3637
Paul Elliott096abc42023-02-03 18:33:23 +00003638 /* Immediately reject a zero-length signature buffer. This guarantees that
3639 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003640 if (signature_size == 0) {
3641 status = PSA_ERROR_BUFFER_TOO_SMALL;
3642 goto exit;
3643 }
3644
3645 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3646 signature_size,
3647 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003648
Paul Elliott296ede92022-12-15 17:00:30 +00003649 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003650 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003651
Paul Elliottebe225c2023-02-10 14:32:53 +00003652exit:
3653
Paul Elliott59200a22023-02-21 15:07:40 +00003654 psa_wipe_tag_output_buffer(signature, status, signature_size,
3655 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003656
Paul Elliott53bb3122023-02-10 14:22:22 +00003657 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003658 if (status != PSA_SUCCESS) {
3659 operation->error_occurred = 1;
3660 }
3661
Paul Elliott59ad9452022-12-18 15:09:02 +00003662 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003663 }
3664
3665 return status;
3666}
3667
3668psa_status_t psa_sign_hash_abort(
3669 psa_sign_hash_interruptible_operation_t *operation)
3670{
Paul Elliott59ad9452022-12-18 15:09:02 +00003671 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3672
3673 status = psa_sign_hash_abort_internal(operation);
3674
3675 /* We clear the number of ops done here, so that it is not cleared when
3676 * the operation fails or succeeds, only on manual abort. */
3677 operation->num_ops = 0;
3678
Paul Elliottc9774412023-02-06 15:14:07 +00003679 /* Likewise, failure state. */
3680 operation->error_occurred = 0;
3681
Paul Elliott59ad9452022-12-18 15:09:02 +00003682 return status;
3683}
3684
3685static psa_status_t psa_verify_hash_abort_internal(
3686 psa_verify_hash_interruptible_operation_t *operation)
3687{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003688 if (operation->id == 0) {
3689 /* The object has (apparently) been initialized but it is not (yet)
3690 * in use. It's ok to call abort on such an object, and there's
3691 * nothing to do. */
3692 return PSA_SUCCESS;
3693 }
3694
Paul Elliott59ad9452022-12-18 15:09:02 +00003695 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3696
3697 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003698
3699 operation->id = 0;
3700
Paul Elliotte6145dc2023-02-07 12:51:21 +00003701 /* Do not clear either the error_occurred or num_ops elements here as they
3702 * only want to be cleared by the application calling abort, not by abort
3703 * being called at completion of an operation. */
3704
Paul Elliott59ad9452022-12-18 15:09:02 +00003705 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003706}
3707
3708psa_status_t psa_verify_hash_start(
3709 psa_verify_hash_interruptible_operation_t *operation,
3710 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3711 const uint8_t *hash, size_t hash_length,
3712 const uint8_t *signature, size_t signature_length)
3713{
3714 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3715 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3716 psa_key_slot_t *slot;
3717
Paul Elliottc9774412023-02-06 15:14:07 +00003718 /* Check that start has not been previously called, or operation has not
3719 * previously errored. */
3720 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003721 return PSA_ERROR_BAD_STATE;
3722 }
3723
3724 status = psa_sign_verify_check_alg(0, alg);
3725 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003726 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003727 return status;
3728 }
3729
3730 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3731 PSA_KEY_USAGE_VERIFY_HASH,
3732 alg);
3733
3734 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003735 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003736 return status;
3737 }
3738
3739 psa_key_attributes_t attributes = {
3740 .core = slot->attr
3741 };
3742
Paul Elliott296ede92022-12-15 17:00:30 +00003743 /* Ensure ops count gets reset, in case of operation re-use. */
3744 operation->num_ops = 0;
3745
Paul Elliott9fe12f62022-11-30 19:16:02 +00003746 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3747 slot->key.data,
3748 slot->key.bytes,
3749 alg, hash, hash_length,
3750 signature, signature_length);
3751
3752 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003753 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003754 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003755 }
3756
3757 unlock_status = psa_unlock_key_slot(slot);
3758
Paul Elliottc9774412023-02-06 15:14:07 +00003759 if (unlock_status != PSA_SUCCESS) {
3760 operation->error_occurred = 1;
3761 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003762
Paul Elliottc9774412023-02-06 15:14:07 +00003763 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003764}
3765
3766psa_status_t psa_verify_hash_complete(
3767 psa_verify_hash_interruptible_operation_t *operation)
3768{
3769 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3770
Paul Elliottc9774412023-02-06 15:14:07 +00003771 /* Check that start has been called first, and that operation has not
3772 * previously errored. */
3773 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003774 status = PSA_ERROR_BAD_STATE;
3775 goto exit;
3776 }
3777
3778 status = psa_driver_wrapper_verify_hash_complete(operation);
3779
Paul Elliott296ede92022-12-15 17:00:30 +00003780 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003781 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003782 operation);
3783
Paul Elliottebe225c2023-02-10 14:32:53 +00003784exit:
3785
Paul Elliott9fe12f62022-11-30 19:16:02 +00003786 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003787 if (status != PSA_SUCCESS) {
3788 operation->error_occurred = 1;
3789 }
3790
Paul Elliott59ad9452022-12-18 15:09:02 +00003791 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003792 }
3793
3794 return status;
3795}
3796
3797psa_status_t psa_verify_hash_abort(
3798 psa_verify_hash_interruptible_operation_t *operation)
3799{
Paul Elliott59ad9452022-12-18 15:09:02 +00003800 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003801
Paul Elliott59ad9452022-12-18 15:09:02 +00003802 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003803
Paul Elliott59ad9452022-12-18 15:09:02 +00003804 /* We clear the number of ops done here, so that it is not cleared when
3805 * the operation fails or succeeds, only on manual abort. */
3806 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003807
Paul Elliottc9774412023-02-06 15:14:07 +00003808 /* Likewise, failure state. */
3809 operation->error_occurred = 0;
3810
Paul Elliott59ad9452022-12-18 15:09:02 +00003811 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003812}
3813
Paul Elliott588f8ed2022-12-02 18:10:26 +00003814/****************************************************************/
3815/* Asymmetric interruptible cryptography internal */
3816/* implementations */
3817/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003818
Paul Elliott588f8ed2022-12-02 18:10:26 +00003819void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3820{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003821
Paul Elliott588f8ed2022-12-02 18:10:26 +00003822#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3823 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3824 defined(MBEDTLS_ECP_RESTARTABLE)
3825
3826 /* Internal implementation uses zero to indicate infinite number max ops,
3827 * therefore avoid this value, and set to minimum possible. */
3828 if (max_ops == 0) {
3829 max_ops = 1;
3830 }
3831
Paul Elliott588f8ed2022-12-02 18:10:26 +00003832 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003833#else
3834 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003835#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3836 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3837 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3838}
3839
Paul Elliott588f8ed2022-12-02 18:10:26 +00003840uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003841 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003842{
3843#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3844 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3845 defined(MBEDTLS_ECP_RESTARTABLE)
3846
Paul Elliott93d9ca82023-02-15 18:14:21 +00003847 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003848#else
3849 (void) operation;
3850 return 0;
3851#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3852 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3853 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3854}
3855
3856uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003857 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003858{
3859 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3860 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3861 defined(MBEDTLS_ECP_RESTARTABLE)
3862
Paul Elliott93d9ca82023-02-15 18:14:21 +00003863 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003864#else
3865 (void) operation;
3866 return 0;
3867#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3868 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3869 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3870}
3871
3872psa_status_t mbedtls_psa_sign_hash_start(
3873 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3874 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3875 size_t key_buffer_size, psa_algorithm_t alg,
3876 const uint8_t *hash, size_t hash_length)
3877{
3878 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003879 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003880
Paul Elliott068fe072023-01-16 13:59:15 +00003881 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3882 return PSA_ERROR_NOT_SUPPORTED;
3883 }
3884
3885 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003886 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003887 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003888
3889#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003890 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3891 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003892
Paul Elliotta1c94092023-02-15 16:38:04 +00003893 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3894
Paul Elliott93d9ca82023-02-15 18:14:21 +00003895 /* Ensure num_ops is zero'ed in case of context re-use. */
3896 operation->num_ops = 0;
3897
Paul Elliott068fe072023-01-16 13:59:15 +00003898 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3899 attributes->core.bits,
3900 key_buffer,
3901 key_buffer_size,
3902 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003903
Paul Elliott068fe072023-01-16 13:59:15 +00003904 if (status != PSA_SUCCESS) {
3905 return status;
3906 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003907
Paul Elliott1bc59df2023-02-05 13:41:57 +00003908 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003909 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003910
Paul Elliott068fe072023-01-16 13:59:15 +00003911 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003912 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003913 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003914
Paul Elliott0290a762023-02-09 14:30:24 +00003915 /* We only need to store the same length of hash as the private key size
3916 * here, it would be truncated by the internal implementation anyway. */
3917 required_hash_length = (hash_length < operation->coordinate_bytes ?
3918 hash_length : operation->coordinate_bytes);
3919
Paul Elliottba70ad42023-02-15 18:23:53 +00003920 if (required_hash_length > sizeof(operation->hash)) {
3921 /* Shouldn't happen, but better safe than sorry. */
3922 return PSA_ERROR_CORRUPTION_DETECTED;
3923 }
3924
Paul Elliott0290a762023-02-09 14:30:24 +00003925 memcpy(operation->hash, hash, required_hash_length);
3926 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003927
3928 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003929
3930#else
Paul Elliott068fe072023-01-16 13:59:15 +00003931 (void) operation;
3932 (void) key_buffer;
3933 (void) key_buffer_size;
3934 (void) alg;
3935 (void) hash;
3936 (void) hash_length;
3937 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003938 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003939
Paul Elliott068fe072023-01-16 13:59:15 +00003940 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003941#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3942 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3943 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003944}
3945
3946psa_status_t mbedtls_psa_sign_hash_complete(
3947 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3948 uint8_t *signature, size_t signature_size,
3949 size_t *signature_length)
3950{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003951#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3952 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3953 defined(MBEDTLS_ECP_RESTARTABLE)
3954
Paul Elliotta1c94092023-02-15 16:38:04 +00003955 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003956 mbedtls_mpi r;
3957 mbedtls_mpi s;
3958
Paul Elliott46845252023-02-03 14:59:11 +00003959 mbedtls_mpi_init(&r);
3960 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003961
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003962 /* Ensure max_ops is set to the current value (or default). */
3963 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3964
Paul Elliotta1c94092023-02-15 16:38:04 +00003965 if (signature_size < 2 * operation->coordinate_bytes) {
3966 status = PSA_ERROR_BUFFER_TOO_SMALL;
3967 goto exit;
3968 }
3969
Paul Elliott588f8ed2022-12-02 18:10:26 +00003970 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003971
Paul Elliott588f8ed2022-12-02 18:10:26 +00003972#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3973 status = mbedtls_to_psa_error(
3974 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003975 &r,
3976 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003977 &operation->ctx->d,
3978 operation->hash,
3979 operation->hash_length,
3980 operation->md_alg,
3981 mbedtls_psa_get_random,
3982 MBEDTLS_PSA_RANDOM_STATE,
3983 &operation->restart_ctx));
3984#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003985 status = PSA_ERROR_NOT_SUPPORTED;
3986 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003987#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3988 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003989 status = mbedtls_to_psa_error(
3990 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003991 &r,
3992 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003993 &operation->ctx->d,
3994 operation->hash,
3995 operation->hash_length,
3996 mbedtls_psa_get_random,
3997 MBEDTLS_PSA_RANDOM_STATE,
3998 mbedtls_psa_get_random,
3999 MBEDTLS_PSA_RANDOM_STATE,
4000 &operation->restart_ctx));
4001 }
4002
Paul Elliottf8e5b562023-02-19 18:43:45 +00004003 /* Hide the fact that the restart context only holds a delta of number of
4004 * ops done during the last operation, not an absolute value. */
4005 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4006
Paul Elliott724bd252023-02-08 12:35:08 +00004007 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00004008 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004009 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004010 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004011 operation->coordinate_bytes)
4012 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004013
4014 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004015 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004016 }
4017
4018 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004019 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004020 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004021 operation->coordinate_bytes,
4022 operation->coordinate_bytes)
4023 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004024
4025 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004026 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004027 }
4028
Paul Elliott1bc59df2023-02-05 13:41:57 +00004029 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004030
Paul Elliott724bd252023-02-08 12:35:08 +00004031 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004032 }
Paul Elliott724bd252023-02-08 12:35:08 +00004033
4034exit:
4035
4036 mbedtls_mpi_free(&r);
4037 mbedtls_mpi_free(&s);
4038 return status;
4039
Paul Elliott588f8ed2022-12-02 18:10:26 +00004040 #else
4041
4042 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004043 (void) signature;
4044 (void) signature_size;
4045 (void) signature_length;
4046
4047 return PSA_ERROR_NOT_SUPPORTED;
4048
4049#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4050 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4051 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4052}
4053
4054psa_status_t mbedtls_psa_sign_hash_abort(
4055 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4056{
4057
4058#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4059 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4060 defined(MBEDTLS_ECP_RESTARTABLE)
4061
4062 if (operation->ctx) {
4063 mbedtls_ecdsa_free(operation->ctx);
4064 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004065 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004066 }
4067
4068 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4069
Paul Elliott93d9ca82023-02-15 18:14:21 +00004070 operation->num_ops = 0;
4071
Paul Elliott588f8ed2022-12-02 18:10:26 +00004072 return PSA_SUCCESS;
4073
4074#else
4075
4076 (void) operation;
4077
4078 return PSA_ERROR_NOT_SUPPORTED;
4079
4080#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4081 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4082 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4083}
4084
4085psa_status_t mbedtls_psa_verify_hash_start(
4086 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4087 const psa_key_attributes_t *attributes,
4088 const uint8_t *key_buffer, size_t key_buffer_size,
4089 psa_algorithm_t alg,
4090 const uint8_t *hash, size_t hash_length,
4091 const uint8_t *signature, size_t signature_length)
4092{
4093 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004094 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004095 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004096
Paul Elliott068fe072023-01-16 13:59:15 +00004097 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4098 return PSA_ERROR_NOT_SUPPORTED;
4099 }
4100
4101 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004102 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004103 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004104
4105#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004106 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4107 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004108
Paul Elliotta1c94092023-02-15 16:38:04 +00004109 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4110 mbedtls_mpi_init(&operation->r);
4111 mbedtls_mpi_init(&operation->s);
4112
Paul Elliott93d9ca82023-02-15 18:14:21 +00004113 /* Ensure num_ops is zero'ed in case of context re-use. */
4114 operation->num_ops = 0;
4115
Paul Elliott068fe072023-01-16 13:59:15 +00004116 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4117 attributes->core.bits,
4118 key_buffer,
4119 key_buffer_size,
4120 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004121
Paul Elliott068fe072023-01-16 13:59:15 +00004122 if (status != PSA_SUCCESS) {
4123 return status;
4124 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004125
Paul Elliottc569fc22023-02-10 13:02:54 +00004126 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004127
Paul Elliott1bc59df2023-02-05 13:41:57 +00004128 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004129 return PSA_ERROR_INVALID_SIGNATURE;
4130 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004131
Paul Elliott068fe072023-01-16 13:59:15 +00004132 status = mbedtls_to_psa_error(
4133 mbedtls_mpi_read_binary(&operation->r,
4134 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004135 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004136
Paul Elliott068fe072023-01-16 13:59:15 +00004137 if (status != PSA_SUCCESS) {
4138 return status;
4139 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004140
Paul Elliott068fe072023-01-16 13:59:15 +00004141 status = mbedtls_to_psa_error(
4142 mbedtls_mpi_read_binary(&operation->s,
4143 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004144 coordinate_bytes,
4145 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004146
Paul Elliott068fe072023-01-16 13:59:15 +00004147 if (status != PSA_SUCCESS) {
4148 return status;
4149 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004150
Paul Elliott2c9843f2023-02-15 17:32:42 +00004151 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004152
Paul Elliott2c9843f2023-02-15 17:32:42 +00004153 if (status != PSA_SUCCESS) {
4154 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004155 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004156
Paul Elliott0290a762023-02-09 14:30:24 +00004157 /* We only need to store the same length of hash as the private key size
4158 * here, it would be truncated by the internal implementation anyway. */
4159 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4160 coordinate_bytes);
4161
Paul Elliottba70ad42023-02-15 18:23:53 +00004162 if (required_hash_length > sizeof(operation->hash)) {
4163 /* Shouldn't happen, but better safe than sorry. */
4164 return PSA_ERROR_CORRUPTION_DETECTED;
4165 }
4166
Paul Elliott0290a762023-02-09 14:30:24 +00004167 memcpy(operation->hash, hash, required_hash_length);
4168 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004169
4170 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004171#else
Paul Elliott068fe072023-01-16 13:59:15 +00004172 (void) operation;
4173 (void) key_buffer;
4174 (void) key_buffer_size;
4175 (void) alg;
4176 (void) hash;
4177 (void) hash_length;
4178 (void) signature;
4179 (void) signature_length;
4180 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004181 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004182 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004183
Paul Elliott068fe072023-01-16 13:59:15 +00004184 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004185#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4186 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4187 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004188}
4189
4190psa_status_t mbedtls_psa_verify_hash_complete(
4191 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4192{
4193
4194#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4195 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4196 defined(MBEDTLS_ECP_RESTARTABLE)
4197
Paul Elliottf8e5b562023-02-19 18:43:45 +00004198 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4199
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004200 /* Ensure max_ops is set to the current value (or default). */
4201 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4202
Paul Elliottf8e5b562023-02-19 18:43:45 +00004203 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004204 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4205 operation->hash,
4206 operation->hash_length,
4207 &operation->ctx->Q,
4208 &operation->r,
4209 &operation->s,
4210 &operation->restart_ctx));
4211
Paul Elliottf8e5b562023-02-19 18:43:45 +00004212 /* Hide the fact that the restart context only holds a delta of number of
4213 * ops done during the last operation, not an absolute value. */
4214 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4215
4216 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004217#else
4218 (void) operation;
4219
4220 return PSA_ERROR_NOT_SUPPORTED;
4221
4222#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4223 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4224 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4225}
4226
4227psa_status_t mbedtls_psa_verify_hash_abort(
4228 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4229{
4230
4231#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4232 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4233 defined(MBEDTLS_ECP_RESTARTABLE)
4234
4235 if (operation->ctx) {
4236 mbedtls_ecdsa_free(operation->ctx);
4237 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004238 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004239 }
4240
4241 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4242
Paul Elliott93d9ca82023-02-15 18:14:21 +00004243 operation->num_ops = 0;
4244
Paul Elliott588f8ed2022-12-02 18:10:26 +00004245 mbedtls_mpi_free(&operation->r);
4246 mbedtls_mpi_free(&operation->s);
4247
4248 return PSA_SUCCESS;
4249
4250#else
4251 (void) operation;
4252
4253 return PSA_ERROR_NOT_SUPPORTED;
4254
4255#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4256 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4257 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4258}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004259
mohammad1603503973b2018-03-12 15:59:30 +02004260/****************************************************************/
4261/* Symmetric cryptography */
4262/****************************************************************/
4263
Gilles Peskine449bd832023-01-11 14:50:10 +01004264static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4265 mbedtls_svc_key_id_t key,
4266 psa_algorithm_t alg,
4267 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004268{
4269 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4270 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004271 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4273 PSA_KEY_USAGE_ENCRYPT :
4274 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004275 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004276
4277 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004279 status = PSA_ERROR_BAD_STATE;
4280 goto exit;
4281 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004282
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004284 status = PSA_ERROR_INVALID_ARGUMENT;
4285 goto exit;
4286 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004287
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4289 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004290 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004292
Ronald Cron49fafa92021-03-10 08:34:23 +01004293 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004294 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004295 * so we only set it (in the driver wrapper) after resources have been
4296 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004297 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004299 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004301 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 }
4303 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004304
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004305 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004307 };
4308
Ronald Cronab99ac22020-10-01 16:38:28 +02004309 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 if (cipher_operation == MBEDTLS_ENCRYPT) {
4311 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4312 &attributes,
4313 slot->key.data,
4314 slot->key.bytes,
4315 alg);
4316 } else {
4317 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4318 &attributes,
4319 slot->key.data,
4320 slot->key.bytes,
4321 alg);
4322 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004323
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004324exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 if (status != PSA_SUCCESS) {
4326 psa_cipher_abort(operation);
4327 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004328
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004330
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004332}
4333
Gilles Peskine449bd832023-01-11 14:50:10 +01004334psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4335 mbedtls_svc_key_id_t key,
4336 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004337{
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004339}
4340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4342 mbedtls_svc_key_id_t key,
4343 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004344{
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004346}
4347
Gilles Peskine449bd832023-01-11 14:50:10 +01004348psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4349 uint8_t *iv,
4350 size_t iv_size,
4351 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004352{
Ronald Cron6d051732020-10-01 14:10:20 +02004353 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004354 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004355 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004356
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004358 status = PSA_ERROR_BAD_STATE;
4359 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004360 }
4361
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004363 status = PSA_ERROR_BAD_STATE;
4364 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004365 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004366
Ronald Cron2fb90522021-07-05 12:31:44 +02004367 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004369 status = PSA_ERROR_BUFFER_TOO_SMALL;
4370 goto exit;
4371 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004372
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004374 status = PSA_ERROR_GENERIC_ERROR;
4375 goto exit;
4376 }
4377
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 status = psa_generate_random(local_iv, default_iv_length);
4379 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004380 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 }
Ronald Cron5618a392021-03-26 09:52:26 +01004382
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 status = psa_driver_wrapper_cipher_set_iv(operation,
4384 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004385
4386exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 if (status == PSA_SUCCESS) {
4388 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004389 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004390 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004392 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004394 }
Ronald Cron6d051732020-10-01 14:10:20 +02004395
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004397}
4398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4400 const uint8_t *iv,
4401 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004402{
Ronald Cron6d051732020-10-01 14:10:20 +02004403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004404
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004406 status = PSA_ERROR_BAD_STATE;
4407 goto exit;
4408 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004409
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004411 status = PSA_ERROR_BAD_STATE;
4412 goto exit;
4413 }
Ronald Crona0d68172021-03-26 10:15:08 +01004414
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004416 status = PSA_ERROR_INVALID_ARGUMENT;
4417 goto exit;
4418 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004419
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 status = psa_driver_wrapper_cipher_set_iv(operation,
4421 iv,
4422 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004423
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004424exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004426 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 } else {
4428 psa_cipher_abort(operation);
4429 }
4430 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004431}
4432
Gilles Peskine449bd832023-01-11 14:50:10 +01004433psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4434 const uint8_t *input,
4435 size_t input_length,
4436 uint8_t *output,
4437 size_t output_size,
4438 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004439{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004440 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004443 status = PSA_ERROR_BAD_STATE;
4444 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004445 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004448 status = PSA_ERROR_BAD_STATE;
4449 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004450 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004451
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 status = psa_driver_wrapper_cipher_update(operation,
4453 input,
4454 input_length,
4455 output,
4456 output_size,
4457 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004458
4459exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 if (status != PSA_SUCCESS) {
4461 psa_cipher_abort(operation);
4462 }
Ronald Cron6d051732020-10-01 14:10:20 +02004463
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004465}
4466
Gilles Peskine449bd832023-01-11 14:50:10 +01004467psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4468 uint8_t *output,
4469 size_t output_size,
4470 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004471{
David Saadab4ecc272019-02-14 13:48:10 +02004472 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004473
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004475 status = PSA_ERROR_BAD_STATE;
4476 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004477 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004478
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004480 status = PSA_ERROR_BAD_STATE;
4481 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004482 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 status = psa_driver_wrapper_cipher_finish(operation,
4485 output,
4486 output_size,
4487 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004488
4489exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 if (status == PSA_SUCCESS) {
4491 return psa_cipher_abort(operation);
4492 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004493 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004495
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004497 }
mohammad1603503973b2018-03-12 15:59:30 +02004498}
4499
Gilles Peskine449bd832023-01-11 14:50:10 +01004500psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004501{
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004503 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004504 * in use. It's ok to call abort on such an object, and there's
4505 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004507 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004508
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004510
Ronald Cron49fafa92021-03-10 08:34:23 +01004511 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004512 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004513 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004516}
4517
Gilles Peskine449bd832023-01-11 14:50:10 +01004518psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4519 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004520 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004522 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 size_t output_size,
4524 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004525{
4526 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004527 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004528 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004529 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4530 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004531 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004532
David Horstmann62a56d92023-12-14 18:12:47 +00004533 LOCAL_INPUT_DECLARE(input_external, input);
4534 LOCAL_OUTPUT_DECLARE(output_external, output);
4535
David Horstmann36df4b22023-12-13 15:55:25 +00004536 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004537 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004538
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004540 status = PSA_ERROR_INVALID_ARGUMENT;
4541 goto exit;
4542 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004543
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4545 PSA_KEY_USAGE_ENCRYPT,
4546 alg);
4547 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004548 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004550
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004551 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004553 };
4554
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4556 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004557 status = PSA_ERROR_GENERIC_ERROR;
4558 goto exit;
4559 }
4560
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 if (default_iv_length > 0) {
4562 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004563 status = PSA_ERROR_BUFFER_TOO_SMALL;
4564 goto exit;
4565 }
4566
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 status = psa_generate_random(local_iv, default_iv_length);
4568 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004569 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004571 }
4572
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004573 status = psa_driver_wrapper_cipher_encrypt(
4574 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004575 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004576 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004578
4579exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 unlock_status = psa_unlock_key_slot(slot);
4581 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004582 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004583 }
Ronald Cron23919522021-07-08 19:00:07 +02004584
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 if (status == PSA_SUCCESS) {
4586 if (default_iv_length > 0) {
4587 memcpy(output, local_iv, default_iv_length);
4588 }
4589 *output_length += default_iv_length;
4590 } else {
4591 *output_length = 0;
4592 }
4593
David Horstmann62a56d92023-12-14 18:12:47 +00004594 LOCAL_INPUT_FREE(input_external, input);
4595 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004596
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004598}
4599
Gilles Peskine449bd832023-01-11 14:50:10 +01004600psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4601 psa_algorithm_t alg,
4602 const uint8_t *input,
4603 size_t input_length,
4604 uint8_t *output,
4605 size_t output_size,
4606 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004607{
4608 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004609 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004610 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004611 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004612
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004614 status = PSA_ERROR_INVALID_ARGUMENT;
4615 goto exit;
4616 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004617
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4619 PSA_KEY_USAGE_DECRYPT,
4620 alg);
4621 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004622 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004624
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004625 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004627 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4630 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004631 status = PSA_ERROR_INVALID_ARGUMENT;
4632 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004634 status = PSA_ERROR_INVALID_ARGUMENT;
4635 goto exit;
4636 }
4637
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004638 status = psa_driver_wrapper_cipher_decrypt(
4639 &attributes, slot->key.data, slot->key.bytes,
4640 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004642
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004643exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 unlock_status = psa_unlock_key_slot(slot);
4645 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004646 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004650 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 }
Ronald Cron23919522021-07-08 19:00:07 +02004652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004654}
4655
4656
mohammad16035955c982018-04-26 00:53:03 +03004657/****************************************************************/
4658/* AEAD */
4659/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004660
Paul Elliottbaff51c2021-09-28 17:44:45 +01004661/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004662static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004663{
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004665}
4666
4667/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004668static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4669 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004670{
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004672
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004674#if defined(PSA_WANT_ALG_GCM)
4675 case PSA_ALG_GCM:
4676 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 * arbitrarily large nonces. Please note that we do not generally
4678 * recommend the usage of nonces of greater length than
4679 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4680 * size, which can then lead to collisions if you encrypt a very
4681 * large number of messages.*/
4682 if (nonce_length != 0) {
4683 return PSA_SUCCESS;
4684 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004685 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004686#endif /* PSA_WANT_ALG_GCM */
4687#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004688 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 if (nonce_length >= 7 && nonce_length <= 13) {
4690 return PSA_SUCCESS;
4691 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004692 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004693#endif /* PSA_WANT_ALG_CCM */
4694#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004695 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 if (nonce_length == 12) {
4697 return PSA_SUCCESS;
4698 } else if (nonce_length == 8) {
4699 return PSA_ERROR_NOT_SUPPORTED;
4700 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004701 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004702#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004703 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004704 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004706 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004707
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004709}
4710
Gilles Peskine449bd832023-01-11 14:50:10 +01004711static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004712{
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4714 return PSA_ERROR_INVALID_ARGUMENT;
4715 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004716
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004718}
4719
Gilles Peskine449bd832023-01-11 14:50:10 +01004720psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4721 psa_algorithm_t alg,
4722 const uint8_t *nonce,
4723 size_t nonce_length,
4724 const uint8_t *additional_data,
4725 size_t additional_data_length,
4726 const uint8_t *plaintext,
4727 size_t plaintext_length,
4728 uint8_t *ciphertext,
4729 size_t ciphertext_size,
4730 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004731{
Ronald Cron215633c2021-03-16 17:15:37 +01004732 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4733 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004734
mohammad1603f08a5502018-06-03 15:05:47 +03004735 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004736
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 status = psa_aead_check_algorithm(alg);
4738 if (status != PSA_SUCCESS) {
4739 return status;
4740 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004741
Ronald Cron9a986162021-03-26 12:40:07 +01004742 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4744 if (status != PSA_SUCCESS) {
4745 return status;
4746 }
mohammad16035955c982018-04-26 00:53:03 +03004747
Ronald Cron215633c2021-03-16 17:15:37 +01004748 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004750 };
mohammad16035955c982018-04-26 00:53:03 +03004751
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 status = psa_aead_check_nonce_length(alg, nonce_length);
4753 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004754 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004756
Ronald Cronde822812021-03-17 16:08:20 +01004757 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004758 &attributes, slot->key.data, slot->key.bytes,
4759 alg,
4760 nonce, nonce_length,
4761 additional_data, additional_data_length,
4762 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004764
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4766 memset(ciphertext, 0, ciphertext_size);
4767 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004768
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004769exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004771
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004773}
4774
Gilles Peskine449bd832023-01-11 14:50:10 +01004775psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4776 psa_algorithm_t alg,
4777 const uint8_t *nonce,
4778 size_t nonce_length,
4779 const uint8_t *additional_data,
4780 size_t additional_data_length,
4781 const uint8_t *ciphertext,
4782 size_t ciphertext_length,
4783 uint8_t *plaintext,
4784 size_t plaintext_size,
4785 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004786{
Ronald Cron215633c2021-03-16 17:15:37 +01004787 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4788 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004789
Gilles Peskineee652a32018-06-01 19:23:52 +02004790 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004791
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 status = psa_aead_check_algorithm(alg);
4793 if (status != PSA_SUCCESS) {
4794 return status;
4795 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004796
Ronald Cron9a986162021-03-26 12:40:07 +01004797 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4799 if (status != PSA_SUCCESS) {
4800 return status;
4801 }
mohammad16035955c982018-04-26 00:53:03 +03004802
Ronald Cron215633c2021-03-16 17:15:37 +01004803 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004805 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004806
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 status = psa_aead_check_nonce_length(alg, nonce_length);
4808 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004809 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004811
Ronald Cronde822812021-03-17 16:08:20 +01004812 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004813 &attributes, slot->key.data, slot->key.bytes,
4814 alg,
4815 nonce, nonce_length,
4816 additional_data, additional_data_length,
4817 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004819
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 if (status != PSA_SUCCESS && plaintext_size != 0) {
4821 memset(plaintext, 0, plaintext_size);
4822 }
mohammad160360a64d02018-06-03 17:20:42 +03004823
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004824exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004826
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 return status;
mohammad16035955c982018-04-26 00:53:03 +03004828}
4829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4831{
4832 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004833
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004835#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004837 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4839 return PSA_ERROR_INVALID_ARGUMENT;
4840 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004841 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004842#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004843
Przemek Stekiel86679c72022-10-06 17:06:56 +02004844#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004846 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4848 return PSA_ERROR_INVALID_ARGUMENT;
4849 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004850 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004851#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004852
Przemek Stekiel86679c72022-10-06 17:06:56 +02004853#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004855 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 if (tag_len != 16) {
4857 return PSA_ERROR_INVALID_ARGUMENT;
4858 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004859 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004860#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004861
4862 default:
4863 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004865 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004867}
4868
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004869/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004870static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4871 int is_encrypt,
4872 mbedtls_svc_key_id_t key,
4873 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004874{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004875 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4876 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4877 psa_key_slot_t *slot = NULL;
4878 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004879 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004880
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 status = psa_aead_check_algorithm(alg);
4882 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004883 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004885
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004887 status = PSA_ERROR_BAD_STATE;
4888 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004889 }
4890
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 if (operation->nonce_set || operation->lengths_set ||
4892 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004893 status = PSA_ERROR_BAD_STATE;
4894 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004895 }
4896
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004898 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004900 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004902
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4904 alg);
4905 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004906 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004908
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004909 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004910 .core = slot->attr
4911 };
4912
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004914 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004916
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 if (is_encrypt) {
4918 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4919 &attributes,
4920 slot->key.data,
4921 slot->key.bytes,
4922 alg);
4923 } else {
4924 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4925 &attributes,
4926 slot->key.data,
4927 slot->key.bytes,
4928 alg);
4929 }
4930 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004931 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004933
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004935
4936exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004938
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004940 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004942 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 } else {
4944 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004945 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004946
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004948}
4949
Paul Elliott302ff6b2021-04-20 18:10:30 +01004950/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004951psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4952 mbedtls_svc_key_id_t key,
4953 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004954{
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004956}
4957
4958/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004959psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4960 mbedtls_svc_key_id_t key,
4961 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004962{
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004964}
4965
4966/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004967psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4968 uint8_t *nonce,
4969 size_t nonce_size,
4970 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004971{
4972 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004973 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004974 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004975
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004976 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004977
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004979 status = PSA_ERROR_BAD_STATE;
4980 goto exit;
4981 }
4982
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004984 status = PSA_ERROR_BAD_STATE;
4985 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004986 }
4987
Paul Elliotte193ea82021-10-01 13:00:16 +01004988 /* For CCM, this size may not be correct according to the PSA
4989 * specification. The PSA Crypto 1.0.1 specification states:
4990 *
4991 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4992 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4993 *
4994 * However this restriction that L has to be the smallest integer is not
4995 * applied in practice, and it is not implementable here since the
4996 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4998 operation->alg);
4999 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005000 status = PSA_ERROR_BUFFER_TOO_SMALL;
5001 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005002 }
5003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 status = psa_generate_random(local_nonce, required_nonce_size);
5005 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005006 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005007 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005008
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005010
Paul Elliott39dc6b82021-05-11 19:16:09 +01005011exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005012 if (status == PSA_SUCCESS) {
5013 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005014 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 } else {
5016 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005017 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005018
Gilles Peskine449bd832023-01-11 14:50:10 +01005019 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005020}
5021
5022/* Set the nonce for a multipart authenticated encryption or decryption
5023 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005024psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
5025 const uint8_t *nonce,
5026 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005027{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005028 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5029
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005031 status = PSA_ERROR_BAD_STATE;
5032 goto exit;
5033 }
5034
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005036 status = PSA_ERROR_BAD_STATE;
5037 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005038 }
5039
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5041 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01005042 status = PSA_ERROR_INVALID_ARGUMENT;
5043 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01005044 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01005045
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5047 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005048
Paul Elliott39dc6b82021-05-11 19:16:09 +01005049exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005051 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 } else {
5053 psa_aead_abort(operation);
5054 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005055
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005057}
5058
5059/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005060psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5061 size_t ad_length,
5062 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005063{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005064 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5065
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005067 status = PSA_ERROR_BAD_STATE;
5068 goto exit;
5069 }
5070
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 if (operation->lengths_set || operation->ad_started ||
5072 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005073 status = PSA_ERROR_BAD_STATE;
5074 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005075 }
5076
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005078#if defined(PSA_WANT_ALG_GCM)
5079 case PSA_ALG_GCM:
5080 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 * bits. Without the guard this code will generate warnings on 32bit
5082 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005083#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 if (((uint64_t) ad_length) >> 61 != 0 ||
5085 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005086 status = PSA_ERROR_INVALID_ARGUMENT;
5087 goto exit;
5088 }
Paul Elliott325d3742021-09-27 17:56:28 +01005089#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005090 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005091#endif /* PSA_WANT_ALG_GCM */
5092#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005093 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005095 status = PSA_ERROR_INVALID_ARGUMENT;
5096 goto exit;
5097 }
5098 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005099#endif /* PSA_WANT_ALG_CCM */
5100#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005101 case PSA_ALG_CHACHA20_POLY1305:
5102 /* No length restrictions for ChaChaPoly. */
5103 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005104#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005105 default:
5106 break;
5107 }
Paul Elliott325d3742021-09-27 17:56:28 +01005108
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5110 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005111
Paul Elliott39dc6b82021-05-11 19:16:09 +01005112exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005114 operation->ad_remaining = ad_length;
5115 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005116 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 } else {
5118 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005119 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005120
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005122}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005123
5124/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005125psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5126 const uint8_t *input,
5127 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005128{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5130
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005132 status = PSA_ERROR_BAD_STATE;
5133 goto exit;
5134 }
5135
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005137 status = PSA_ERROR_BAD_STATE;
5138 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005139 }
5140
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 if (operation->lengths_set) {
5142 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005143 status = PSA_ERROR_INVALID_ARGUMENT;
5144 goto exit;
5145 }
5146
5147 operation->ad_remaining -= input_length;
5148 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005149#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005150 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005151 status = PSA_ERROR_BAD_STATE;
5152 goto exit;
5153 }
5154#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005155
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 status = psa_driver_wrapper_aead_update_ad(operation, input,
5157 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005158
Paul Elliott39dc6b82021-05-11 19:16:09 +01005159exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005161 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 } else {
5163 psa_aead_abort(operation);
5164 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005165
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005167}
5168
5169/* Encrypt or decrypt a message fragment in an active multipart AEAD
5170 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005171psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5172 const uint8_t *input,
5173 size_t input_length,
5174 uint8_t *output,
5175 size_t output_size,
5176 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005177{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005178 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005179
5180 *output_length = 0;
5181
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005183 status = PSA_ERROR_BAD_STATE;
5184 goto exit;
5185 }
5186
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005188 status = PSA_ERROR_BAD_STATE;
5189 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005190 }
5191
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005193 /* Additional data length was supplied, but not all the additional
5194 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005196 status = PSA_ERROR_INVALID_ARGUMENT;
5197 goto exit;
5198 }
5199
5200 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005202 status = PSA_ERROR_INVALID_ARGUMENT;
5203 goto exit;
5204 }
5205
5206 operation->body_remaining -= input_length;
5207 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005208#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005209 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005210 status = PSA_ERROR_BAD_STATE;
5211 goto exit;
5212 }
5213#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005214
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5216 output, output_size,
5217 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005218
Paul Elliott39dc6b82021-05-11 19:16:09 +01005219exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005221 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 } else {
5223 psa_aead_abort(operation);
5224 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005225
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005227}
5228
Gilles Peskine449bd832023-01-11 14:50:10 +01005229static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005230{
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 if (operation->id == 0 || !operation->nonce_set) {
5232 return PSA_ERROR_BAD_STATE;
5233 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005234
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5236 operation->body_remaining != 0)) {
5237 return PSA_ERROR_INVALID_ARGUMENT;
5238 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005239
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005241}
5242
Paul Elliott302ff6b2021-04-20 18:10:30 +01005243/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005244psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5245 uint8_t *ciphertext,
5246 size_t ciphertext_size,
5247 size_t *ciphertext_length,
5248 uint8_t *tag,
5249 size_t tag_size,
5250 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005251{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005252 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5253
Paul Elliott302ff6b2021-04-20 18:10:30 +01005254 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005255 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005256
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 status = psa_aead_final_checks(operation);
5258 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005259 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005261
Gilles Peskine449bd832023-01-11 14:50:10 +01005262 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005263 status = PSA_ERROR_BAD_STATE;
5264 goto exit;
5265 }
5266
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5268 ciphertext_size,
5269 ciphertext_length,
5270 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005271
Paul Elliott39dc6b82021-05-11 19:16:09 +01005272exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005273
5274
Paul Elliottf47b0952021-05-21 18:02:33 +01005275 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005276 * the zero tag size, make sure the tag is set to something implausible.
5277 * Even if the operation succeeds, make sure we clear the rest of the
5278 * buffer to prevent potential leakage of anything previously placed in
5279 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005280 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005281
Gilles Peskine449bd832023-01-11 14:50:10 +01005282 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005283
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005285}
5286
5287/* Finish authenticating and decrypting a message in a multipart AEAD
5288 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005289psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5290 uint8_t *plaintext,
5291 size_t plaintext_size,
5292 size_t *plaintext_length,
5293 const uint8_t *tag,
5294 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005295{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005296 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5297
Paul Elliott302ff6b2021-04-20 18:10:30 +01005298 *plaintext_length = 0;
5299
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 status = psa_aead_final_checks(operation);
5301 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005302 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005304
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005306 status = PSA_ERROR_BAD_STATE;
5307 goto exit;
5308 }
5309
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5311 plaintext_size,
5312 plaintext_length,
5313 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005314
5315exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005317
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005319}
5320
5321/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005322psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005323{
5324 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5325
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005327 /* The object has (apparently) been initialized but it is not (yet)
5328 * in use. It's ok to call abort on such an object, and there's
5329 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005331 }
5332
Gilles Peskine449bd832023-01-11 14:50:10 +01005333 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005334
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005336
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005338}
5339
Gilles Peskinee59236f2018-01-27 23:32:46 +01005340/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005341/* Generators */
5342/****************************************************************/
5343
Przemek Stekiel69c46792022-06-10 12:59:51 +02005344#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005345 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005346 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305347 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305348 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005349#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005350#endif /* At least one builtin KDF */
5351
Przemek Stekiel69c46792022-06-10 12:59:51 +02005352#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005353 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5354 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5355static psa_status_t psa_key_derivation_start_hmac(
5356 psa_mac_operation_t *operation,
5357 psa_algorithm_t hash_alg,
5358 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005360{
5361 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5362 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5364 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5365 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005366
Steven Cooreman72f736a2021-05-07 14:14:37 +02005367 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005369
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 status = psa_driver_wrapper_mac_sign_setup(operation,
5371 &attributes,
5372 hmac_key, hmac_key_length,
5373 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005374
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 psa_reset_key_attributes(&attributes);
5376 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005377}
5378#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005379
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005380#define HKDF_STATE_INIT 0 /* no input yet */
5381#define HKDF_STATE_STARTED 1 /* got salt */
5382#define HKDF_STATE_KEYED 2 /* got key */
5383#define HKDF_STATE_OUTPUT 3 /* output started */
5384
Gilles Peskinecbe66502019-05-16 16:59:18 +02005385static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005387{
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5389 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5390 } else {
5391 return operation->alg;
5392 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005393}
5394
Gilles Peskine449bd832023-01-11 14:50:10 +01005395psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005396{
5397 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5399 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005400 /* The object has (apparently) been initialized but it is not
5401 * in use. It's ok to call abort on such an object, and there's
5402 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005404#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5406 mbedtls_free(operation->ctx.hkdf.info);
5407 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5408 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005409#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005410#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5411 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5413 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5414 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5415 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005416 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005418 }
5419
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005421 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005423 }
5424
Gilles Peskine449bd832023-01-11 14:50:10 +01005425 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005426 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005428 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005429#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005431 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005433 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005434#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005435 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005436
5437 /* We leave the fields Ai and output_block to be erased safely by the
5438 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005440#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5441 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005442#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5444 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5445 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5446 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005447#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305448#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305449 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305450 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005451 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305452 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305453 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305454
5455 status = PSA_SUCCESS;
5456 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305457#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005458 {
5459 status = PSA_ERROR_BAD_STATE;
5460 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 mbedtls_platform_zeroize(operation, sizeof(*operation));
5462 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005463}
5464
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005465psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005467{
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005469 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005471 }
5472
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005473 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005475}
5476
Gilles Peskine449bd832023-01-11 14:50:10 +01005477psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5478 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005479{
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 if (operation->alg == 0) {
5481 return PSA_ERROR_BAD_STATE;
5482 }
5483 if (capacity > operation->capacity) {
5484 return PSA_ERROR_INVALID_ARGUMENT;
5485 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005486 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005488}
5489
Przemek Stekiel69c46792022-06-10 12:59:51 +02005490#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005491/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005492static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5493 psa_algorithm_t kdf_alg,
5494 uint8_t *output,
5495 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005496{
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5498 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005499 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005500 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005501#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005503#else
5504 const uint8_t last_block = 0xff;
5505#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005506
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 if (hkdf->state < HKDF_STATE_KEYED ||
5508 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005509#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005510 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005511#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 )) {
5513 return PSA_ERROR_BAD_STATE;
5514 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005515 hkdf->state = HKDF_STATE_OUTPUT;
5516
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005518 /* Copy what remains of the current block */
5519 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005521 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 }
5523 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005524 output += n;
5525 output_length -= n;
5526 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005528 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005530 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005531 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005532 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005533 * object was corrupted or if this function is called directly
5534 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 if (hkdf->block_number == last_block) {
5536 return PSA_ERROR_BAD_STATE;
5537 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005538
5539 /* We need a new block */
5540 ++hkdf->block_number;
5541 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005542
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5544 hash_alg,
5545 hkdf->prk,
5546 hash_length);
5547 if (status != PSA_SUCCESS) {
5548 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005549 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005550
5551 if (hkdf->block_number != 1) {
5552 status = psa_mac_update(&hkdf->hmac,
5553 hkdf->output_block,
5554 hash_length);
5555 if (status != PSA_SUCCESS) {
5556 return status;
5557 }
5558 }
5559 status = psa_mac_update(&hkdf->hmac,
5560 hkdf->info,
5561 hkdf->info_length);
5562 if (status != PSA_SUCCESS) {
5563 return status;
5564 }
5565 status = psa_mac_update(&hkdf->hmac,
5566 &hkdf->block_number, 1);
5567 if (status != PSA_SUCCESS) {
5568 return status;
5569 }
5570 status = psa_mac_sign_finish(&hkdf->hmac,
5571 hkdf->output_block,
5572 sizeof(hkdf->output_block),
5573 &hmac_output_length);
5574 if (status != PSA_SUCCESS) {
5575 return status;
5576 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005577 }
5578
Gilles Peskine449bd832023-01-11 14:50:10 +01005579 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005580}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005581#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005582
John Durkop07cc04a2020-11-16 22:08:34 -08005583#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5584 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005585static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5586 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005588{
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5590 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005591 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5592 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005593 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005594
Janos Follath7742fee2019-06-17 12:58:10 +01005595 /* We can't be wanting more output after block 0xff, otherwise
5596 * the capacity check in psa_key_derivation_output_bytes() would have
5597 * prevented this call. It could happen only if the operation
5598 * object was corrupted or if this function is called directly
5599 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 if (tls12_prf->block_number == 0xff) {
5601 return PSA_ERROR_CORRUPTION_DETECTED;
5602 }
Janos Follath7742fee2019-06-17 12:58:10 +01005603
5604 /* We need a new block */
5605 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005606 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005607
5608 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5609 *
5610 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5611 *
5612 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5613 * HMAC_hash(secret, A(2) + seed) +
5614 * HMAC_hash(secret, A(3) + seed) + ...
5615 *
5616 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005617 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005618 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005619 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005620 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005621 * is currently extracted as `output_block` and where i is
5622 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005623 */
5624
Gilles Peskine449bd832023-01-11 14:50:10 +01005625 status = psa_key_derivation_start_hmac(&hmac,
5626 hash_alg,
5627 tls12_prf->secret,
5628 tls12_prf->secret_length);
5629 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005630 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005632
5633 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005635 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5636 * the variable seed and in this instance means it in the context of the
5637 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 status = psa_mac_update(&hmac,
5639 tls12_prf->label,
5640 tls12_prf->label_length);
5641 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005642 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 }
5644 status = psa_mac_update(&hmac,
5645 tls12_prf->seed,
5646 tls12_prf->seed_length);
5647 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005648 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 }
5650 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005651 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5653 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005654 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005656 }
5657
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 status = psa_mac_sign_finish(&hmac,
5659 tls12_prf->Ai, hash_length,
5660 &hmac_output_length);
5661 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005662 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005663 }
5664 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005665 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005667
5668 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 status = psa_key_derivation_start_hmac(&hmac,
5670 hash_alg,
5671 tls12_prf->secret,
5672 tls12_prf->secret_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->Ai, hash_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->label, tls12_prf->label_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_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5685 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005686 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 }
5688 status = psa_mac_sign_finish(&hmac,
5689 tls12_prf->output_block, hash_length,
5690 &hmac_output_length);
5691 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005692 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005694
Janos Follath7742fee2019-06-17 12:58:10 +01005695
5696cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 cleanup_status = psa_mac_abort(&hmac);
5698 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005699 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005700 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005701
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005703}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005704
Janos Follath844eb0e2019-06-19 12:10:49 +01005705static psa_status_t psa_key_derivation_tls12_prf_read(
5706 psa_tls12_prf_key_derivation_t *tls12_prf,
5707 psa_algorithm_t alg,
5708 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005710{
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5712 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005713 psa_status_t status;
5714 uint8_t offset, length;
5715
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005717 case PSA_TLS12_PRF_STATE_LABEL_SET:
5718 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5719 break;
5720 case PSA_TLS12_PRF_STATE_OUTPUT:
5721 break;
5722 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005724 }
5725
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005727 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 if (tls12_prf->left_in_block == 0) {
5729 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5730 alg);
5731 if (status != PSA_SUCCESS) {
5732 return status;
5733 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005734
5735 continue;
5736 }
5737
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005739 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005741 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005743
5744 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005746 output += length;
5747 output_length -= length;
5748 tls12_prf->left_in_block -= length;
5749 }
5750
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005752}
John Durkop07cc04a2020-11-16 22:08:34 -08005753#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5754 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005755
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005756#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5757static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5758 psa_tls12_ecjpake_to_pms_t *ecjpake,
5759 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005761{
5762 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005763 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005764
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 if (output_length != 32) {
5766 return PSA_ERROR_INVALID_ARGUMENT;
5767 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005768
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5770 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5771 &output_size);
5772 if (status != PSA_SUCCESS) {
5773 return status;
5774 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005775
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 if (output_size != output_length) {
5777 return PSA_ERROR_GENERIC_ERROR;
5778 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005779
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005781}
5782#endif
5783
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305784#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305785static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5786 psa_pbkdf2_key_derivation_t *pbkdf2,
5787 psa_algorithm_t prf_alg,
5788 uint8_t prf_output_length,
5789 psa_key_attributes_t *attributes)
5790{
5791 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305792 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305793 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305794 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305795 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305796 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305797 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305798
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305799 mac_operation.is_sign = 1;
5800 mac_operation.mac_size = prf_output_length;
5801 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305802
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305803 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5804 attributes,
5805 pbkdf2->password,
5806 pbkdf2->password_length,
5807 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305808 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305809 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305810 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305811 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5812 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305813 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305814 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305815 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305816 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305817 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305818 }
5819 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5820 &mac_output_length);
5821 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305822 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305823 }
5824
5825 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305826 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305827 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305828 }
5829
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305830 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305831
5832 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305833 /* We are passing prf_output_length as mac_size because the driver
5834 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305835 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305836 status = psa_driver_wrapper_mac_compute(attributes,
5837 pbkdf2->password,
5838 pbkdf2->password_length,
5839 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305840 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305841 &mac_output_length);
5842 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305843 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305844 }
5845
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305846 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305847 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305848
5849cleanup:
5850 /* Zeroise buffers to clear sensitive data from memory. */
5851 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5852 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305853}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305854
5855static psa_status_t psa_key_derivation_pbkdf2_read(
5856 psa_pbkdf2_key_derivation_t *pbkdf2,
5857 psa_algorithm_t kdf_alg,
5858 uint8_t *output,
5859 size_t output_length)
5860{
5861 psa_status_t status;
5862 psa_algorithm_t prf_alg;
5863 uint8_t prf_output_length;
5864 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5865 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5866 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5867
5868 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5869 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5870 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5871 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305872 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5873 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305874 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305875 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305876 } else {
5877 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305878 }
5879
5880 switch (pbkdf2->state) {
5881 case PSA_PBKDF2_STATE_PASSWORD_SET:
5882 /* Initially we need a new block so bytes_used is equal to block size*/
5883 pbkdf2->bytes_used = prf_output_length;
5884 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5885 break;
5886 case PSA_PBKDF2_STATE_OUTPUT:
5887 break;
5888 default:
5889 return PSA_ERROR_BAD_STATE;
5890 }
5891
5892 while (output_length != 0) {
5893 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5894 if (n > output_length) {
5895 n = (uint8_t) output_length;
5896 }
5897 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5898 output += n;
5899 output_length -= n;
5900 pbkdf2->bytes_used += n;
5901
5902 if (output_length == 0) {
5903 break;
5904 }
5905
5906 /* We need a new block */
5907 pbkdf2->bytes_used = 0;
5908 pbkdf2->block_number++;
5909
5910 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5911 prf_output_length,
5912 &attributes);
5913 if (status != PSA_SUCCESS) {
5914 return status;
5915 }
5916 }
5917
5918 return PSA_SUCCESS;
5919}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305920#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305921
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005922psa_status_t psa_key_derivation_output_bytes(
5923 psa_key_derivation_operation_t *operation,
5924 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005926{
5927 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005928 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005929
Gilles Peskine449bd832023-01-11 14:50:10 +01005930 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005931 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005932 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005933 }
5934
Gilles Peskine449bd832023-01-11 14:50:10 +01005935 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005936 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005937 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005938 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005939 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005940 goto exit;
5941 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005943 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005944 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005945 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5946 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005947 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005948 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005950 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005951 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005952
Przemek Stekiel69c46792022-06-10 12:59:51 +02005953#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5955 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5956 output, output_length);
5957 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005958#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005959#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5960 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005961 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5962 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5963 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5964 kdf_alg, output,
5965 output_length);
5966 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005967#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5968 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005969#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005971 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5973 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005974#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305975#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305976 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305977 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5978 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305979 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305980#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005981
Gilles Peskineeab56e42018-07-12 17:12:33 +02005982 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005983 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005985 }
5986
5987exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005989 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005990 * This allows us to differentiate between exhausted operations and
5991 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5992 * operations. */
5993 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005995 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005997 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005999}
6000
David Brown7807bf72021-02-09 16:28:23 -07006001#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006002static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02006003{
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 if (data_size >= 8) {
6005 mbedtls_des_key_set_parity(data);
6006 }
6007 if (data_size >= 16) {
6008 mbedtls_des_key_set_parity(data + 8);
6009 }
6010 if (data_size >= 24) {
6011 mbedtls_des_key_set_parity(data + 16);
6012 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006013}
David Brown7807bf72021-02-09 16:28:23 -07006014#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006015
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006016/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 * ECC keys on a Weierstrass elliptic curve require the generation
6018 * of a private key which is an integer
6019 * in the range [1, N - 1], where N is the boundary of the private key domain:
6020 * N is the prime p for Diffie-Hellman, or the order of the
6021 * curve’s base point for ECC.
6022 *
6023 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6024 * This function generates the private key using the following process:
6025 *
6026 * 1. Draw a byte string of length ceiling(m/8) bytes.
6027 * 2. If m is not a multiple of 8, set the most significant
6028 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6029 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6030 * 4. If k > N - 2, discard the result and return to step 1.
6031 * 5. Output k + 1 as the private key.
6032 *
6033 * This method allows compliance to NIST standards, specifically the methods titled
6034 * Key-Pair Generation by Testing Candidates in the following publications:
6035 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6036 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6037 * Diffie-Hellman keys.
6038 *
6039 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6040 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6041 *
6042 * Note: Function allocates memory for *data buffer, so given *data should be
6043 * always NULL.
6044 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006045#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6046#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006047static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006048 psa_key_slot_t *slot,
6049 size_t bits,
6050 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006051 uint8_t **data
6052 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006053{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006054 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006055 mbedtls_mpi k;
6056 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006057 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006058 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006059 size_t m;
6060 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006061
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 mbedtls_mpi_init(&k);
6063 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006064
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006065 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006067 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006071 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006072 goto cleanup;
6073 }
6074
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006075 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006077
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006079
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006080 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006081 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006082 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006083
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006084 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006085
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006086 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006088
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006089 /* Note: This function is always called with *data == NULL and it
6090 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 *data = mbedtls_calloc(1, m_bytes);
6092 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006093 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006094 goto cleanup;
6095 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006096
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006098 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006100 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006102
6103 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006105 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006106 * (8 * ceiling(m/8) - m) bits of the first byte in
6107 * the string to zero.
6108 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006110 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006111 }
6112
6113 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 * big-endian byte string.
6115 */
6116 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006117
6118 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 * Result of comparison is returned. When it indicates error
6120 * then this function is called again.
6121 */
6122 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006123 }
6124
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006125 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6127 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006128cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 if (ret != 0) {
6130 status = mbedtls_to_psa_error(ret);
6131 }
6132 if (status != PSA_SUCCESS) {
6133 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006134 *data = NULL;
6135 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 mbedtls_mpi_free(&k);
6137 mbedtls_mpi_free(&diff_N_2);
6138 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006139}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006140
6141/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6142 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6143 *
6144 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6145 * draw a 32-byte string and process it as specified in
6146 * Elliptic Curves for Security [RFC7748] §5.
6147 *
6148 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6149 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6150 *
6151 * Note: Function allocates memory for *data buffer, so given *data should be
6152 * always NULL.
6153 */
6154
6155static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6156 size_t bits,
6157 psa_key_derivation_operation_t *operation,
6158 uint8_t **data
6159 )
6160{
6161 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006162 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006163
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006165 case 255:
6166 output_length = 32;
6167 break;
6168 case 448:
6169 output_length = 56;
6170 break;
6171 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006173 break;
6174 }
6175
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006177
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 if (*data == NULL) {
6179 return PSA_ERROR_INSUFFICIENT_MEMORY;
6180 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006181
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006185 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006187
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006189 case 255:
6190 (*data)[0] &= 248;
6191 (*data)[31] &= 127;
6192 (*data)[31] |= 64;
6193 break;
6194 case 448:
6195 (*data)[0] &= 252;
6196 (*data)[55] |= 128;
6197 break;
6198 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006200 break;
6201 }
6202
6203 return status;
6204}
Valerio Setti86587ab2023-06-27 13:09:30 +02006205#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6206static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6207 psa_key_slot_t *slot, size_t bits,
6208 psa_key_derivation_operation_t *operation, uint8_t **data)
6209{
6210 (void) slot;
6211 (void) bits;
6212 (void) operation;
6213 (void) data;
6214 return PSA_ERROR_NOT_SUPPORTED;
6215}
6216
6217static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6218 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6219{
6220 (void) bits;
6221 (void) operation;
6222 (void) data;
6223 return PSA_ERROR_NOT_SUPPORTED;
6224}
6225#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6226#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006227
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006228static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006229 psa_key_slot_t *slot,
6230 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006232{
6233 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306235 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006236 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006237 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006238
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6240 return PSA_ERROR_INVALID_ARGUMENT;
6241 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006242
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006243#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006244 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006245 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6246 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6247 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006248 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6250 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006251 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006252 }
6253 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006254 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6256 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006257 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006259 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006260 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006261#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006262 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 if (key_type_is_raw_bytes(slot->attr.type)) {
6264 if (bits % 8 != 0) {
6265 return PSA_ERROR_INVALID_ARGUMENT;
6266 }
6267 data = mbedtls_calloc(1, bytes);
6268 if (data == NULL) {
6269 return PSA_ERROR_INSUFFICIENT_MEMORY;
6270 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006271
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 status = psa_key_derivation_output_bytes(operation, data, bytes);
6273 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006274 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 }
David Brown12ca5032021-02-11 11:02:00 -07006276#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6278 psa_des_set_key_parity(data, bytes);
6279 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006280#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 } else {
6282 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006283 }
Ronald Crondd04d422020-11-28 15:14:42 +01006284
Ronald Cronbf33c932020-11-28 18:06:53 +01006285 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006286 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006288 };
6289
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6291 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6292 &storage_size);
6293 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306294 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 }
Archanad8a83dc2021-06-14 10:04:16 +05306296 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 status = psa_allocate_buffer_to_slot(slot, storage_size);
6298 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306299 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 }
Archanad8a83dc2021-06-14 10:04:16 +05306301
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 status = psa_driver_wrapper_import_key(&attributes,
6303 data, bytes,
6304 slot->key.data,
6305 slot->key.bytes,
6306 &slot->key.bytes, &bits);
6307 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006308 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006310
6311exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 mbedtls_free(data);
6313 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006314}
6315
Gilles Peskine449bd832023-01-11 14:50:10 +01006316psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6317 psa_key_derivation_operation_t *operation,
6318 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006319{
6320 psa_status_t status;
6321 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006322 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006323
Ronald Cron81709fc2020-11-14 12:10:32 +01006324 *key = MBEDTLS_SVC_KEY_ID_INIT;
6325
Gilles Peskine0f84d622019-09-12 19:03:13 +02006326 /* Reject any attempt to create a zero-length key so that we don't
6327 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 if (psa_get_key_bits(attributes) == 0) {
6329 return PSA_ERROR_INVALID_ARGUMENT;
6330 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006331
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 if (operation->alg == PSA_ALG_NONE) {
6333 return PSA_ERROR_BAD_STATE;
6334 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006335
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 if (!operation->can_output_key) {
6337 return PSA_ERROR_NOT_PERMITTED;
6338 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006339
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6341 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006342#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006344 /* Deriving a key in a secure element is not implemented yet. */
6345 status = PSA_ERROR_NOT_SUPPORTED;
6346 }
6347#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006348 if (status == PSA_SUCCESS) {
6349 status = psa_generate_derived_key_internal(slot,
6350 attributes->core.bits,
6351 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006352 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006353 if (status == PSA_SUCCESS) {
6354 status = psa_finish_key_creation(slot, driver, key);
6355 }
6356 if (status != PSA_SUCCESS) {
6357 psa_fail_key_creation(slot, driver);
6358 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006359
Gilles Peskine449bd832023-01-11 14:50:10 +01006360 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006361}
6362
Gilles Peskineeab56e42018-07-12 17:12:33 +02006363
6364
6365/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006366/* Key derivation */
6367/****************************************************************/
6368
Steven Cooreman932ffb72021-02-15 12:14:32 +01006369#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006370static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006371{
6372#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6374 return 1;
6375 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006376#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006377#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6379 return 1;
6380 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006381#endif
6382#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6384 return 1;
6385 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006386#endif
6387#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6389 return 1;
6390 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006391#endif
6392#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6394 return 1;
6395 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006396#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006397#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006398 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6399 return 1;
6400 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006401#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306402#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6403 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6404 return 1;
6405 }
6406#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306407#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6408 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6409 return 1;
6410 }
6411#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006413}
6414
Gilles Peskine449bd832023-01-11 14:50:10 +01006415static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006416{
6417 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006418 psa_status_t status = psa_hash_setup(&operation, alg);
6419 psa_hash_abort(&operation);
6420 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006421}
6422
Gilles Peskine969c5d62019-01-16 15:53:06 +01006423static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006424 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006426{
Janos Follath5fe19732019-06-20 15:09:30 +01006427 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6428 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006429 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006430
Gilles Peskine969c5d62019-01-16 15:53:06 +01006431 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006432 if (!is_kdf_alg_supported(kdf_alg)) {
6433 return PSA_ERROR_NOT_SUPPORTED;
6434 }
John Durkop07cc04a2020-11-16 22:08:34 -08006435
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006436 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306437 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6439 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306440 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6441 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6442 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306443 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306444 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006445 if (hash_size == 0) {
6446 return PSA_ERROR_NOT_SUPPORTED;
6447 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006448
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006449 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6450 * we might fail later, which is somewhat unfriendly and potentially
6451 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 psa_status_t status = psa_hash_try_support(hash_alg);
6453 if (status != PSA_SUCCESS) {
6454 return status;
6455 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006456 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006457
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6459 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6460 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6461 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006462 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006463#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006464 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006465 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6466 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006467 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006469#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6470 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 operation->capacity = 255 * hash_size;
6472 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006473}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006474
Gilles Peskine449bd832023-01-11 14:50:10 +01006475static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006476{
6477#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 if (alg == PSA_ALG_ECDH) {
6479 return PSA_SUCCESS;
6480 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006481#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006482#if defined(PSA_WANT_ALG_FFDH)
6483 if (alg == PSA_ALG_FFDH) {
6484 return PSA_SUCCESS;
6485 }
6486#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006487 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006489}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006490
6491static int psa_key_derivation_allows_free_form_secret_input(
6492 psa_algorithm_t kdf_alg)
6493{
6494#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6495 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6496 return 0;
6497 }
6498#endif
6499 (void) kdf_alg;
6500 return 1;
6501}
John Durkop07cc04a2020-11-16 22:08:34 -08006502#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006503
Gilles Peskine449bd832023-01-11 14:50:10 +01006504psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6505 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006506{
6507 psa_status_t status;
6508
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 if (operation->alg != 0) {
6510 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006511 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006512
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6514 return PSA_ERROR_INVALID_ARGUMENT;
6515 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6516#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6517 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6518 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6519 status = psa_key_agreement_try_support(ka_alg);
6520 if (status != PSA_SUCCESS) {
6521 return status;
6522 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006523 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6524 return PSA_ERROR_INVALID_ARGUMENT;
6525 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6527#else
6528 return PSA_ERROR_NOT_SUPPORTED;
6529#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6530 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6531#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6532 status = psa_key_derivation_setup_kdf(operation, alg);
6533#else
6534 return PSA_ERROR_NOT_SUPPORTED;
6535#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6536 } else {
6537 return PSA_ERROR_INVALID_ARGUMENT;
6538 }
6539
6540 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006541 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 }
6543 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006544}
6545
Przemek Stekiel69c46792022-06-10 12:59:51 +02006546#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006547static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6548 psa_algorithm_t kdf_alg,
6549 psa_key_derivation_step_t step,
6550 const uint8_t *data,
6551 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006552{
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006554 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006556 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006557#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6559 return PSA_ERROR_INVALID_ARGUMENT;
6560 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006561#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 if (hkdf->state != HKDF_STATE_INIT) {
6563 return PSA_ERROR_BAD_STATE;
6564 } else {
6565 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6566 hash_alg,
6567 data, data_length);
6568 if (status != PSA_SUCCESS) {
6569 return status;
6570 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006571 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006573 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006574 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006575#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006577 /* We shouldn't be in different state as HKDF_EXPAND only allows
6578 * two inputs: SECRET (this case) and INFO which does not modify
6579 * the state. It could happen only if the hkdf
6580 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006581 if (hkdf->state != HKDF_STATE_INIT) {
6582 return PSA_ERROR_BAD_STATE;
6583 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006584
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006585 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006586 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6587 return PSA_ERROR_INVALID_ARGUMENT;
6588 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006589
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 memcpy(hkdf->prk, data, data_length);
6591 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006592#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006593 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006594 /* HKDF: If no salt was provided, use an empty salt.
6595 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006597#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6599 return PSA_ERROR_BAD_STATE;
6600 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006601#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006602 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6603 hash_alg,
6604 NULL, 0);
6605 if (status != PSA_SUCCESS) {
6606 return status;
6607 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006608 hkdf->state = HKDF_STATE_STARTED;
6609 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 if (hkdf->state != HKDF_STATE_STARTED) {
6611 return PSA_ERROR_BAD_STATE;
6612 }
6613 status = psa_mac_update(&hkdf->hmac,
6614 data, data_length);
6615 if (status != PSA_SUCCESS) {
6616 return status;
6617 }
6618 status = psa_mac_sign_finish(&hkdf->hmac,
6619 hkdf->prk,
6620 sizeof(hkdf->prk),
6621 &data_length);
6622 if (status != PSA_SUCCESS) {
6623 return status;
6624 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006625 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006626
Gilles Peskine2b522db2019-04-12 15:11:49 +02006627 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006628 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006629#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006631 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006633 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006635#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006636 {
6637 /* Block 0 is empty, and the next block will be
6638 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006640 }
6641
Gilles Peskine449bd832023-01-11 14:50:10 +01006642 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006643 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006644#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006645 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6646 return PSA_ERROR_INVALID_ARGUMENT;
6647 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006648#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006649#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006650 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6651 hkdf->state == HKDF_STATE_INIT) {
6652 return PSA_ERROR_BAD_STATE;
6653 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006654#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006655 if (hkdf->state == HKDF_STATE_OUTPUT) {
6656 return PSA_ERROR_BAD_STATE;
6657 }
6658 if (hkdf->info_set) {
6659 return PSA_ERROR_BAD_STATE;
6660 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006661 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 if (data_length != 0) {
6663 hkdf->info = mbedtls_calloc(1, data_length);
6664 if (hkdf->info == NULL) {
6665 return PSA_ERROR_INSUFFICIENT_MEMORY;
6666 }
6667 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006668 }
6669 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006671 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006672 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006673 }
6674}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006675#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006676
John Durkop07cc04a2020-11-16 22:08:34 -08006677#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6678 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006679static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6680 const uint8_t *data,
6681 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006682{
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6684 return PSA_ERROR_BAD_STATE;
6685 }
Janos Follathf08e2652019-06-13 09:05:41 +01006686
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 if (data_length != 0) {
6688 prf->seed = mbedtls_calloc(1, data_length);
6689 if (prf->seed == NULL) {
6690 return PSA_ERROR_INSUFFICIENT_MEMORY;
6691 }
Janos Follathf08e2652019-06-13 09:05:41 +01006692
Gilles Peskine449bd832023-01-11 14:50:10 +01006693 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006694 prf->seed_length = data_length;
6695 }
Janos Follathf08e2652019-06-13 09:05:41 +01006696
Gilles Peskine43f958b2020-12-13 14:55:14 +01006697 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006698
Gilles Peskine449bd832023-01-11 14:50:10 +01006699 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006700}
6701
Gilles Peskine449bd832023-01-11 14:50:10 +01006702static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6703 const uint8_t *data,
6704 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006705{
Gilles Peskine449bd832023-01-11 14:50:10 +01006706 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6707 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6708 return PSA_ERROR_BAD_STATE;
6709 }
Janos Follath81550542019-06-13 14:26:34 +01006710
Gilles Peskine449bd832023-01-11 14:50:10 +01006711 if (data_length != 0) {
6712 prf->secret = mbedtls_calloc(1, data_length);
6713 if (prf->secret == NULL) {
6714 return PSA_ERROR_INSUFFICIENT_MEMORY;
6715 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006716
Gilles Peskine449bd832023-01-11 14:50:10 +01006717 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006718 prf->secret_length = data_length;
6719 }
Janos Follath81550542019-06-13 14:26:34 +01006720
Gilles Peskine43f958b2020-12-13 14:55:14 +01006721 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006722
Gilles Peskine449bd832023-01-11 14:50:10 +01006723 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006724}
6725
Gilles Peskine449bd832023-01-11 14:50:10 +01006726static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6727 const uint8_t *data,
6728 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006729{
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6731 return PSA_ERROR_BAD_STATE;
6732 }
Janos Follath63028dd2019-06-13 09:15:47 +01006733
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 if (data_length != 0) {
6735 prf->label = mbedtls_calloc(1, data_length);
6736 if (prf->label == NULL) {
6737 return PSA_ERROR_INSUFFICIENT_MEMORY;
6738 }
Janos Follath63028dd2019-06-13 09:15:47 +01006739
Gilles Peskine449bd832023-01-11 14:50:10 +01006740 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006741 prf->label_length = data_length;
6742 }
Janos Follath63028dd2019-06-13 09:15:47 +01006743
Gilles Peskine43f958b2020-12-13 14:55:14 +01006744 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006745
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006747}
6748
Gilles Peskine449bd832023-01-11 14:50:10 +01006749static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6750 psa_key_derivation_step_t step,
6751 const uint8_t *data,
6752 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006753{
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006755 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006757 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006758 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006759 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006761 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006763 }
6764}
John Durkop07cc04a2020-11-16 22:08:34 -08006765#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6766 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6767
6768#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6769static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6770 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006771 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006773{
6774 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6776 4 + data_length + prf->other_secret_length :
6777 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006778
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6780 return PSA_ERROR_INVALID_ARGUMENT;
6781 }
John Durkop07cc04a2020-11-16 22:08:34 -08006782
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 uint8_t *pms = mbedtls_calloc(1, pms_len);
6784 if (pms == NULL) {
6785 return PSA_ERROR_INSUFFICIENT_MEMORY;
6786 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006787 uint8_t *cur = pms;
6788
6789 /* pure-PSK:
6790 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006791 *
6792 * The premaster secret is formed as follows: if the PSK is N octets
6793 * long, concatenate a uint16 with the value N, N zero octets, a second
6794 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006795 *
6796 * mixed-PSK:
6797 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6798 * follows: concatenate a uint16 with the length of the other secret,
6799 * the other secret itself, uint16 with the length of PSK, and the
6800 * PSK itself.
6801 * For details please check:
6802 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6803 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6804 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006805 */
6806
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6808 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6809 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6810 if (prf->other_secret_length != 0) {
6811 memcpy(cur, prf->other_secret, prf->other_secret_length);
6812 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006813 cur += prf->other_secret_length;
6814 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 } else {
6816 *cur++ = MBEDTLS_BYTE_1(data_length);
6817 *cur++ = MBEDTLS_BYTE_0(data_length);
6818 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006819 cur += data_length;
6820 }
6821
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 *cur++ = MBEDTLS_BYTE_1(data_length);
6823 *cur++ = MBEDTLS_BYTE_0(data_length);
6824 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006825 cur += data_length;
6826
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006827 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006828
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006829 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006831}
Janos Follath6660f0e2019-06-17 08:44:03 +01006832
Przemek Stekiele47201b2022-04-19 13:53:28 +02006833static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6834 psa_tls12_prf_key_derivation_t *prf,
6835 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006837{
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6839 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006840 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006841
6842 if (data_length != 0) {
6843 prf->other_secret = mbedtls_calloc(1, data_length);
6844 if (prf->other_secret == NULL) {
6845 return PSA_ERROR_INSUFFICIENT_MEMORY;
6846 }
6847
6848 memcpy(prf->other_secret, data, data_length);
6849 prf->other_secret_length = data_length;
6850 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006851 prf->other_secret_length = 0;
6852 }
6853
6854 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6855
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006857}
6858
Janos Follath6660f0e2019-06-17 08:44:03 +01006859static psa_status_t psa_tls12_prf_psk_to_ms_input(
6860 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006861 psa_key_derivation_step_t step,
6862 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006864{
Gilles Peskine449bd832023-01-11 14:50:10 +01006865 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006866 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 return psa_tls12_prf_psk_to_ms_set_key(prf,
6868 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006869 break;
6870 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6872 data,
6873 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006874 break;
6875 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006877 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006878
Przemek Stekiele47201b2022-04-19 13:53:28 +02006879 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006880}
John Durkop07cc04a2020-11-16 22:08:34 -08006881#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006882
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006883#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6884static psa_status_t psa_tls12_ecjpake_to_pms_input(
6885 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006886 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006887 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006889{
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6891 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6892 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006893 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006894
6895 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 if (data[0] != 0x04) {
6897 return PSA_ERROR_INVALID_ARGUMENT;
6898 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006899
6900 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006902
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006904}
6905#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306906
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306907#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306908static psa_status_t psa_pbkdf2_set_input_cost(
6909 psa_pbkdf2_key_derivation_t *pbkdf2,
6910 psa_key_derivation_step_t step,
6911 uint64_t data)
6912{
6913 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6914 return PSA_ERROR_INVALID_ARGUMENT;
6915 }
6916
6917 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6918 return PSA_ERROR_BAD_STATE;
6919 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306920
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306921 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306922 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306923 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306924
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306925 if (data == 0) {
6926 return PSA_ERROR_INVALID_ARGUMENT;
6927 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306928
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306929 pbkdf2->input_cost = data;
6930 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6931
6932 return PSA_SUCCESS;
6933}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306934
6935static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6936 const uint8_t *data,
6937 size_t data_length)
6938{
Gilles Peskineead17662023-08-20 22:02:51 +02006939 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6940 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6941 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6942 /* Appending to existing salt. No state change. */
6943 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306944 return PSA_ERROR_BAD_STATE;
6945 }
6946
Gilles Peskineca57d782023-07-20 19:08:06 +02006947 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006948 /* Appending an empty string, nothing to do. */
6949 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306950 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306951
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306952 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6953 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306954 return PSA_ERROR_INSUFFICIENT_MEMORY;
6955 }
6956
Gilles Peskineead17662023-08-20 22:02:51 +02006957 if (pbkdf2->salt_length != 0) {
6958 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6959 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306960 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306961 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306962 mbedtls_free(pbkdf2->salt);
6963 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306964 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306965 return PSA_SUCCESS;
6966}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306967
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306968#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306969static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306970 const uint8_t *input,
6971 size_t input_len,
6972 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306973 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306974{
6975 psa_status_t status = PSA_SUCCESS;
6976 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6977 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306978 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306979 } else {
6980 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306981 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306982 }
6983 return status;
6984}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306985#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306986
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306987#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306988static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6989 size_t input_len,
6990 uint8_t *output,
6991 size_t *output_len)
6992{
6993 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306994 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306995 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306996 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306997 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6998 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6999 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307000 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05307001 * mac_size as the driver function sets mac_output_length = mac_size
7002 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307003 status = psa_driver_wrapper_mac_compute(&attributes,
7004 zeros, sizeof(zeros),
7005 PSA_ALG_CMAC, input, input_len,
7006 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307007 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7008 128U,
7009 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307010 output_len);
7011 } else {
7012 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307013 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307014 }
7015 return status;
7016}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307017#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307018
7019static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307020 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307021 const uint8_t *data,
7022 size_t data_length)
7023{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307024 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307025 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7026 return PSA_ERROR_BAD_STATE;
7027 }
7028
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307029#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307030 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7031 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7032 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7033 pbkdf2->password,
7034 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307035 } else
7036#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7037#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7038 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307039 status = psa_pbkdf2_cmac_set_password(data, data_length,
7040 pbkdf2->password,
7041 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307042 } else
7043#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7044 {
7045 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307046 }
7047
7048 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7049
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307050 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307051}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307052
7053static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307054 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307055 psa_key_derivation_step_t step,
7056 const uint8_t *data,
7057 size_t data_length)
7058{
7059 switch (step) {
7060 case PSA_KEY_DERIVATION_INPUT_SALT:
7061 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7062 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307063 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307064 default:
7065 return PSA_ERROR_INVALID_ARGUMENT;
7066 }
7067}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307068#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307069
Gilles Peskineb8965192019-09-24 16:21:10 +02007070/** Check whether the given key type is acceptable for the given
7071 * input step of a key derivation.
7072 *
7073 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7074 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7075 * Both secret and non-secret inputs can alternatively have the type
7076 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7077 * that the input was passed as a buffer rather than via a key object.
7078 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007079static int psa_key_derivation_check_input_type(
7080 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007082{
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007084 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 if (key_type == PSA_KEY_TYPE_DERIVE) {
7086 return PSA_SUCCESS;
7087 }
7088 if (key_type == PSA_KEY_TYPE_NONE) {
7089 return PSA_SUCCESS;
7090 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007091 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007092 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 if (key_type == PSA_KEY_TYPE_DERIVE) {
7094 return PSA_SUCCESS;
7095 }
7096 if (key_type == PSA_KEY_TYPE_NONE) {
7097 return PSA_SUCCESS;
7098 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007099 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007100 case PSA_KEY_DERIVATION_INPUT_LABEL:
7101 case PSA_KEY_DERIVATION_INPUT_SALT:
7102 case PSA_KEY_DERIVATION_INPUT_INFO:
7103 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7105 return PSA_SUCCESS;
7106 }
7107 if (key_type == PSA_KEY_TYPE_NONE) {
7108 return PSA_SUCCESS;
7109 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007110 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307111 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7112 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7113 return PSA_SUCCESS;
7114 }
7115 if (key_type == PSA_KEY_TYPE_DERIVE) {
7116 return PSA_SUCCESS;
7117 }
7118 if (key_type == PSA_KEY_TYPE_NONE) {
7119 return PSA_SUCCESS;
7120 }
7121 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007122 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007123 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007124}
7125
Janos Follathb80a94e2019-06-12 15:54:46 +01007126static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007127 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007128 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007129 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007130 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007132{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007133 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007135
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 status = psa_key_derivation_check_input_type(step, key_type);
7137 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007138 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007140
Przemek Stekiel69c46792022-06-10 12:59:51 +02007141#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7143 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7144 step, data, data_length);
7145 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007146#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007147#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7149 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7150 step, data, data_length);
7151 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007152#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7153#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7155 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7156 step, data, data_length);
7157 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007158#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007159#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007161 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7163 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007164#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307165#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307166 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307167 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7168 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307169 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307170#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007171 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007172 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007173 (void) data;
7174 (void) data_length;
7175 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007177 }
7178
Gilles Peskine224b0d62019-09-23 18:13:17 +02007179exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 if (status != PSA_SUCCESS) {
7181 psa_key_derivation_abort(operation);
7182 }
7183 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007184}
7185
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307186static psa_status_t psa_key_derivation_input_integer_internal(
7187 psa_key_derivation_operation_t *operation,
7188 psa_key_derivation_step_t step,
7189 uint64_t value)
7190{
7191 psa_status_t status;
7192 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7193
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307194#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307195 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307196 status = psa_pbkdf2_set_input_cost(
7197 &operation->ctx.pbkdf2, step, value);
7198 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307199#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307200 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307201 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307202 (void) value;
7203 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307204 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307205 }
7206
7207 if (status != PSA_SUCCESS) {
7208 psa_key_derivation_abort(operation);
7209 }
7210 return status;
7211}
7212
Janos Follath51f4a0f2019-06-14 11:35:55 +01007213psa_status_t psa_key_derivation_input_bytes(
7214 psa_key_derivation_operation_t *operation,
7215 psa_key_derivation_step_t step,
7216 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007218{
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 return psa_key_derivation_input_internal(operation, step,
7220 PSA_KEY_TYPE_NONE,
7221 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007222}
7223
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307224psa_status_t psa_key_derivation_input_integer(
7225 psa_key_derivation_operation_t *operation,
7226 psa_key_derivation_step_t step,
7227 uint64_t value)
7228{
7229 return psa_key_derivation_input_integer_internal(operation, step, value);
7230}
7231
Janos Follath51f4a0f2019-06-14 11:35:55 +01007232psa_status_t psa_key_derivation_input_key(
7233 psa_key_derivation_operation_t *operation,
7234 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007236{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007237 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007238 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007239 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007240
Ronald Cron5c522922020-11-14 16:35:34 +01007241 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007242 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7243 if (status != PSA_SUCCESS) {
7244 psa_key_derivation_abort(operation);
7245 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007246 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007247
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307248 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7249 * permission to output to a key object. */
7250 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7251 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007252 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007253 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007254
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 status = psa_key_derivation_input_internal(operation,
7256 step, slot->attr.type,
7257 slot->key.data,
7258 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007259
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007261
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007263}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007264
7265
7266
7267/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007268/* Key agreement */
7269/****************************************************************/
7270
Gilles Peskine449bd832023-01-11 14:50:10 +01007271psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7272 const uint8_t *key_buffer,
7273 size_t key_buffer_size,
7274 psa_algorithm_t alg,
7275 const uint8_t *peer_key,
7276 size_t peer_key_length,
7277 uint8_t *shared_secret,
7278 size_t shared_secret_size,
7279 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007280{
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007282#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007283 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7285 key_buffer_size, alg,
7286 peer_key, peer_key_length,
7287 shared_secret,
7288 shared_secret_size,
7289 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007290#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007291
7292#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7293 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007294 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007295 peer_key,
7296 peer_key_length,
7297 key_buffer,
7298 key_buffer_size,
7299 shared_secret,
7300 shared_secret_size,
7301 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007302#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7303
Gilles Peskine01d718c2018-09-18 12:01:02 +02007304 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007305 (void) attributes;
7306 (void) key_buffer;
7307 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007308 (void) peer_key;
7309 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007310 (void) shared_secret;
7311 (void) shared_secret_size;
7312 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007313 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007314 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007315}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007316
Aditya Deshpande17845b82022-10-13 17:21:01 +01007317/** Internal function for raw key agreement
7318 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007319 * to the driver's implementation if a driver is present.
7320 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007321 * (psa_key_agreement_raw_builtin).
7322 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007323static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7324 psa_key_slot_t *private_key,
7325 const uint8_t *peer_key,
7326 size_t peer_key_length,
7327 uint8_t *shared_secret,
7328 size_t shared_secret_size,
7329 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007330{
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7332 return PSA_ERROR_NOT_SUPPORTED;
7333 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007334
7335 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007337 };
7338
Gilles Peskine449bd832023-01-11 14:50:10 +01007339 return psa_driver_wrapper_key_agreement(&attributes,
7340 private_key->key.data,
7341 private_key->key.bytes, alg,
7342 peer_key, peer_key_length,
7343 shared_secret,
7344 shared_secret_size,
7345 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007346}
7347
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007348/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007349 * to potentially free embedded data structures and wipe confidential data.
7350 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007351static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7352 psa_key_derivation_step_t step,
7353 psa_key_slot_t *private_key,
7354 const uint8_t *peer_key,
7355 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007356{
7357 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007358 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007359 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007361
7362 /* Step 1: run the secret agreement algorithm to generate the shared
7363 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 status = psa_key_agreement_raw_internal(ka_alg,
7365 private_key,
7366 peer_key, peer_key_length,
7367 shared_secret,
7368 sizeof(shared_secret),
7369 &shared_secret_length);
7370 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007371 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007373
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007374 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007375 * the shared secret. A shared secret is permitted wherever a key
7376 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007377 status = psa_key_derivation_input_internal(operation, step,
7378 PSA_KEY_TYPE_DERIVE,
7379 shared_secret,
7380 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007381exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7383 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007384}
7385
Gilles Peskine449bd832023-01-11 14:50:10 +01007386psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7387 psa_key_derivation_step_t step,
7388 mbedtls_svc_key_id_t private_key,
7389 const uint8_t *peer_key,
7390 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007391{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007392 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007393 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007394 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007395
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7397 return PSA_ERROR_INVALID_ARGUMENT;
7398 }
Ronald Cron5c522922020-11-14 16:35:34 +01007399 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7401 if (status != PSA_SUCCESS) {
7402 return status;
7403 }
7404 status = psa_key_agreement_internal(operation, step,
7405 slot,
7406 peer_key, peer_key_length);
7407 if (status != PSA_SUCCESS) {
7408 psa_key_derivation_abort(operation);
7409 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007410 /* If a private key has been added as SECRET, we allow the derived
7411 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007413 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007415 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007416
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007418
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007420}
7421
Gilles Peskine449bd832023-01-11 14:50:10 +01007422psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7423 mbedtls_svc_key_id_t private_key,
7424 const uint8_t *peer_key,
7425 size_t peer_key_length,
7426 uint8_t *output,
7427 size_t output_size,
7428 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007429{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007430 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007431 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007432 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007433 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007434
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007436 status = PSA_ERROR_INVALID_ARGUMENT;
7437 goto exit;
7438 }
Ronald Cron5c522922020-11-14 16:35:34 +01007439 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7441 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007442 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007444
Gilles Peskine3e561302022-04-14 00:17:15 +02007445 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7446 * for the output size. The PSA specification only guarantees that this
7447 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7448 * but it might be nice to allow smaller buffers if the output fits.
7449 * At the time of writing this comment, with only ECDH implemented,
7450 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7451 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7452 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007453 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7455 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007456 status = PSA_ERROR_BUFFER_TOO_SMALL;
7457 goto exit;
7458 }
7459
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 status = psa_key_agreement_raw_internal(alg, slot,
7461 peer_key, peer_key_length,
7462 output, output_size,
7463 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007464
7465exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007467 /* If an error happens and is not handled properly, the output
7468 * may be used as a key to protect sensitive data. Arrange for such
7469 * a key to be random, which is likely to result in decryption or
7470 * verification errors. This is better than filling the buffer with
7471 * some constant data such as zeros, which would result in the data
7472 * being protected with a reproducible, easily knowable key.
7473 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007475 *output_length = output_size;
7476 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007477
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007479
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007481}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007482
7483
Gilles Peskine30524eb2020-11-13 17:02:26 +01007484
Gilles Peskine86a440b2018-11-12 18:39:40 +01007485/****************************************************************/
7486/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007487/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007488
Gilles Peskine672a7712023-04-28 21:00:28 +02007489#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7490#include "entropy_poll.h"
7491#endif
7492
Gilles Peskine30524eb2020-11-13 17:02:26 +01007493/** Initialize the PSA random generator.
7494 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007495static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007496{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007497#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007499#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7500
Gilles Peskine30524eb2020-11-13 17:02:26 +01007501 /* Set default configuration if
7502 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007504 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 }
7506 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007507 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007509
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007511#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7512 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7513 /* The PSA entropy injection feature depends on using NV seed as an entropy
7514 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 mbedtls_entropy_add_source(&rng->entropy,
7516 mbedtls_nv_seed_poll, NULL,
7517 MBEDTLS_ENTROPY_BLOCK_SIZE,
7518 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007519#endif
7520
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007522#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007523}
7524
7525/** Deinitialize the PSA random generator.
7526 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007527static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007528{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007529#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007531#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7533 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007534#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007535}
7536
7537/** Seed the PSA random generator.
7538 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007539static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007540{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007541#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7542 /* Do nothing: the external RNG seeds itself. */
7543 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007545#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007546 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7548 drbg_seed, sizeof(drbg_seed) - 1);
7549 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007550#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007551}
7552
Gilles Peskine449bd832023-01-11 14:50:10 +01007553psa_status_t psa_generate_random(uint8_t *output,
7554 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007555{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007556 GUARD_MODULE_INITIALIZED;
7557
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007558#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7559
7560 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7562 output, output_size,
7563 &output_length);
7564 if (status != PSA_SUCCESS) {
7565 return status;
7566 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007567 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007568 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 if (output_length != output_size) {
7570 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7571 }
7572 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007573
7574#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7575
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007577 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7579 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7580 output_size);
7581 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7582 output, request_size);
7583 if (ret != 0) {
7584 return mbedtls_to_psa_error(ret);
7585 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007586 output_size -= request_size;
7587 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007588 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007590#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007591}
7592
Gilles Peskine8814fc42020-12-14 15:33:44 +01007593/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007594 *
7595 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7596 * `psa_generate_random(...)`. The state parameter is ignored since the
7597 * PSA API doesn't support passing an explicit state.
7598 *
7599 * In the non-external case, psa_generate_random() calls an
7600 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7601 * and semantics as mbedtls_psa_get_random(). As an optimization,
7602 * instead of doing this back-and-forth between the PSA API and the
7603 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7604 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007605 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007606#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7607int mbedtls_psa_get_random(void *p_rng,
7608 unsigned char *output,
7609 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007610{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007611 /* This function takes a pointer to the RNG state because that's what
7612 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7613 * its own state internally and doesn't let the caller access that state.
7614 * So we just ignore the state parameter, and in practice we'll pass
7615 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007616 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007617 psa_status_t status = psa_generate_random(output, output_size);
7618 if (status == PSA_SUCCESS) {
7619 return 0;
7620 } else {
7621 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7622 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007623}
7624#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7625
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007626#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007627psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7628 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007629{
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 if (global_data.initialized) {
7631 return PSA_ERROR_NOT_PERMITTED;
7632 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007633
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7635 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7636 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7637 return PSA_ERROR_INVALID_ARGUMENT;
7638 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007639
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007641}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007642#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007643
Ronald Cron3772afe2021-02-08 16:10:05 +01007644/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007645 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007646 * \param type The key type
7647 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007648 *
7649 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007650 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007651 * \retval #PSA_ERROR_INVALID_ARGUMENT
7652 * The size in bits of the key is not valid.
7653 * \retval #PSA_ERROR_NOT_SUPPORTED
7654 * The type and/or the size in bits of the key or the combination of
7655 * the two is not supported.
7656 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007657static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007659{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007660 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007661
Gilles Peskine449bd832023-01-11 14:50:10 +01007662 if (key_type_is_raw_bytes(type)) {
7663 status = psa_validate_unstructured_key_bit_size(type, bits);
7664 if (status != PSA_SUCCESS) {
7665 return status;
7666 }
7667 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007668#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7670 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7671 return PSA_ERROR_NOT_SUPPORTED;
7672 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007673 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007674 return PSA_ERROR_NOT_SUPPORTED;
7675 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007676
Ronald Cron01b2aba2020-10-05 09:42:02 +02007677 /* Accept only byte-aligned keys, for the same reasons as
7678 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 if (bits % 8 != 0) {
7680 return PSA_ERROR_NOT_SUPPORTED;
7681 }
7682 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007683#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007684
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007685#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007687 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 return PSA_SUCCESS;
7689 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007690#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007691
Valerio Settia55f0422023-07-10 15:34:41 +02007692#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007693 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007694 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007695 return PSA_ERROR_NOT_SUPPORTED;
7696 }
7697 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007698#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007699 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007700 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007701 }
7702
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007704}
7705
Ronald Cron55ed0592020-10-05 10:30:40 +02007706psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007707 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007708 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007709{
7710 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007711 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007712
Gilles Peskine449bd832023-01-11 14:50:10 +01007713 if ((attributes->domain_parameters == NULL) &&
7714 (attributes->domain_parameters_size != 0)) {
7715 return PSA_ERROR_INVALID_ARGUMENT;
7716 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007717
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 if (key_type_is_raw_bytes(type)) {
7719 status = psa_generate_random(key_buffer, key_buffer_size);
7720 if (status != PSA_SUCCESS) {
7721 return status;
7722 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007723
David Brown12ca5032021-02-11 11:02:00 -07007724#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 if (type == PSA_KEY_TYPE_DES) {
7726 psa_des_set_key_parity(key_buffer, key_buffer_size);
7727 }
David Brown8107e312021-02-12 08:08:46 -07007728#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007730
Valerio Setti76df8c12023-07-11 14:11:28 +02007731#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007732 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7733 return mbedtls_psa_rsa_generate_key(attributes,
7734 key_buffer,
7735 key_buffer_size,
7736 key_buffer_length);
7737 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007738#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007739
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007740#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7742 return mbedtls_psa_ecp_generate_key(attributes,
7743 key_buffer,
7744 key_buffer_size,
7745 key_buffer_length);
7746 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007747#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007748
Valerio Settia55f0422023-07-10 15:34:41 +02007749#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007750 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7751 return mbedtls_psa_ffdh_generate_key(attributes,
7752 key_buffer,
7753 key_buffer_size,
7754 key_buffer_length);
7755 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007756#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007757 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 (void) key_buffer_length;
7759 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007760 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007761
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007763}
Darryl Green0c6575a2018-11-07 16:05:30 +00007764
Gilles Peskine449bd832023-01-11 14:50:10 +01007765psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7766 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007767{
7768 psa_status_t status;
7769 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007770 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007771 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007772
Ronald Cron81709fc2020-11-14 12:10:32 +01007773 *key = MBEDTLS_SVC_KEY_ID_INIT;
7774
Gilles Peskine0f84d622019-09-12 19:03:13 +02007775 /* Reject any attempt to create a zero-length key so that we don't
7776 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007777 if (psa_get_key_bits(attributes) == 0) {
7778 return PSA_ERROR_INVALID_ARGUMENT;
7779 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007780
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007781 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007782 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7783 return PSA_ERROR_INVALID_ARGUMENT;
7784 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007785
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7787 &slot, &driver);
7788 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007789 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 }
Gilles Peskine11792082019-08-06 18:36:36 +02007791
Ronald Cron977c2472020-10-13 08:32:21 +02007792 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307793 * storage ( thus not in the case of generating a key in a secure element
7794 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7795 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 if (slot->key.data == NULL) {
7797 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7798 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007799 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 attributes->core.type, attributes->core.bits);
7801 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007802 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007804
7805 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 attributes->core.type,
7807 attributes->core.bits);
7808 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007809 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 attributes, &key_buffer_size);
7811 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007812 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 }
Ronald Cron977c2472020-10-13 08:32:21 +02007814 }
Ronald Cron977c2472020-10-13 08:32:21 +02007815
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7817 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007818 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 }
Ronald Cron977c2472020-10-13 08:32:21 +02007820 }
7821
Gilles Peskine449bd832023-01-11 14:50:10 +01007822 status = psa_driver_wrapper_generate_key(attributes,
7823 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007824
Gilles Peskine449bd832023-01-11 14:50:10 +01007825 if (status != PSA_SUCCESS) {
7826 psa_remove_key_data_from_memory(slot);
7827 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007828
Gilles Peskine11792082019-08-06 18:36:36 +02007829exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007830 if (status == PSA_SUCCESS) {
7831 status = psa_finish_key_creation(slot, driver, key);
7832 }
7833 if (status != PSA_SUCCESS) {
7834 psa_fail_key_creation(slot, driver);
7835 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007836
Gilles Peskine449bd832023-01-11 14:50:10 +01007837 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007838}
7839
Gilles Peskinee59236f2018-01-27 23:32:46 +01007840/****************************************************************/
7841/* Module setup */
7842/****************************************************************/
7843
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007844#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007845psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 void (* entropy_init)(mbedtls_entropy_context *ctx),
7847 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007848{
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7850 return PSA_ERROR_BAD_STATE;
7851 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007852 global_data.rng.entropy_init = entropy_init;
7853 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007854 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007855}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007856#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007857
Gilles Peskine449bd832023-01-11 14:50:10 +01007858void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007859{
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 psa_wipe_all_key_slots();
7861 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7862 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007863 }
7864 /* Wipe all remaining data, including configuration.
7865 * In particular, this sets all state indicator to the value
7866 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007868
7869 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007871}
7872
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007873#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7874/** Recover a transaction that was interrupted by a power failure.
7875 *
7876 * This function is called during initialization, before psa_crypto_init()
7877 * returns. If this function returns a failure status, the initialization
7878 * fails.
7879 */
7880static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007881 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007882{
Gilles Peskine449bd832023-01-11 14:50:10 +01007883 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007884 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7885 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 /* TODO - fall through to the failure case until this
7887 * is implemented.
7888 * https://github.com/ARMmbed/mbed-crypto/issues/218
7889 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007890 default:
7891 /* We found an unsupported transaction in the storage.
7892 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007894 }
7895}
7896#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7897
Gilles Peskine449bd832023-01-11 14:50:10 +01007898psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007899{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007900 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007901
Gilles Peskinec6b69072018-11-20 21:42:52 +01007902 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 if (global_data.initialized != 0) {
7904 return PSA_SUCCESS;
7905 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007906
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007907 /* Init drivers */
7908 status = psa_driver_wrapper_init();
7909 if (status != PSA_SUCCESS) {
7910 goto exit;
7911 }
7912 global_data.drivers_initialized = 1;
7913
Gilles Peskine30524eb2020-11-13 17:02:26 +01007914 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007915 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007916 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007917 status = mbedtls_psa_random_seed(&global_data.rng);
7918 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007919 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007921 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007922
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 status = psa_initialize_key_slots();
7924 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01007925 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007927
Gilles Peskine4b734222019-07-24 15:56:31 +02007928#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 status = psa_crypto_load_transaction();
7930 if (status == PSA_SUCCESS) {
7931 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7932 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007933 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007934 }
7935 status = psa_crypto_stop_transaction();
7936 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007937 /* There's no transaction to complete. It's all good. */
7938 status = PSA_SUCCESS;
7939 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007940#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007941
Gilles Peskinec6b69072018-11-20 21:42:52 +01007942 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007943 global_data.initialized = 1;
7944
7945exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007946 if (status != PSA_SUCCESS) {
7947 mbedtls_psa_crypto_free();
7948 }
7949 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007950}
7951
Yanray Wangffc3c482023-07-11 12:01:04 +08007952#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007953psa_status_t psa_crypto_driver_pake_get_password_len(
7954 const psa_crypto_driver_pake_inputs_t *inputs,
7955 size_t *password_len)
7956{
7957 if (inputs->password_len == 0) {
7958 return PSA_ERROR_BAD_STATE;
7959 }
7960
7961 *password_len = inputs->password_len;
7962
7963 return PSA_SUCCESS;
7964}
7965
7966psa_status_t psa_crypto_driver_pake_get_password(
7967 const psa_crypto_driver_pake_inputs_t *inputs,
7968 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7969{
7970 if (inputs->password_len == 0) {
7971 return PSA_ERROR_BAD_STATE;
7972 }
7973
7974 if (buffer_size < inputs->password_len) {
7975 return PSA_ERROR_BUFFER_TOO_SMALL;
7976 }
7977
7978 memcpy(buffer, inputs->password, inputs->password_len);
7979 *buffer_length = inputs->password_len;
7980
7981 return PSA_SUCCESS;
7982}
7983
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007984psa_status_t psa_crypto_driver_pake_get_user_len(
7985 const psa_crypto_driver_pake_inputs_t *inputs,
7986 size_t *user_len)
7987{
7988 if (inputs->user_len == 0) {
7989 return PSA_ERROR_BAD_STATE;
7990 }
7991
7992 *user_len = inputs->user_len;
7993
7994 return PSA_SUCCESS;
7995}
7996
7997psa_status_t psa_crypto_driver_pake_get_user(
7998 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007999 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008000{
8001 if (inputs->user_len == 0) {
8002 return PSA_ERROR_BAD_STATE;
8003 }
8004
Przemek Stekielc0e62502023-03-14 11:49:36 +01008005 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008006 return PSA_ERROR_BUFFER_TOO_SMALL;
8007 }
8008
Przemek Stekielc0e62502023-03-14 11:49:36 +01008009 memcpy(user_id, inputs->user, inputs->user_len);
8010 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008011
8012 return PSA_SUCCESS;
8013}
8014
8015psa_status_t psa_crypto_driver_pake_get_peer_len(
8016 const psa_crypto_driver_pake_inputs_t *inputs,
8017 size_t *peer_len)
8018{
8019 if (inputs->peer_len == 0) {
8020 return PSA_ERROR_BAD_STATE;
8021 }
8022
8023 *peer_len = inputs->peer_len;
8024
8025 return PSA_SUCCESS;
8026}
8027
8028psa_status_t psa_crypto_driver_pake_get_peer(
8029 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008030 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008031{
8032 if (inputs->peer_len == 0) {
8033 return PSA_ERROR_BAD_STATE;
8034 }
8035
Przemek Stekielc0e62502023-03-14 11:49:36 +01008036 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008037 return PSA_ERROR_BUFFER_TOO_SMALL;
8038 }
8039
Przemek Stekielc0e62502023-03-14 11:49:36 +01008040 memcpy(peer_id, inputs->peer, inputs->peer_len);
8041 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008042
8043 return PSA_SUCCESS;
8044}
8045
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008046psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8047 const psa_crypto_driver_pake_inputs_t *inputs,
8048 psa_pake_cipher_suite_t *cipher_suite)
8049{
8050 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8051 return PSA_ERROR_BAD_STATE;
8052 }
8053
8054 *cipher_suite = inputs->cipher_suite;
8055
8056 return PSA_SUCCESS;
8057}
8058
Neil Armstronga7d08c32022-06-01 18:21:20 +02008059psa_status_t psa_pake_setup(
8060 psa_pake_operation_t *operation,
8061 const psa_pake_cipher_suite_t *cipher_suite)
8062{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008063 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008064
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008065 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008066 status = PSA_ERROR_BAD_STATE;
8067 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008068 }
8069
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008070 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008071 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008072 status = PSA_ERROR_INVALID_ARGUMENT;
8073 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008074 }
8075
Przemek Stekiel51eac532022-12-07 11:04:51 +01008076 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8077
Przemek Stekiele12ed362022-12-21 12:54:46 +01008078 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008079 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8080 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008081 operation->data.inputs.cipher_suite = *cipher_suite;
8082
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008083#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008084 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008085 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008086 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008087
David Horstmann16f01512023-06-14 17:21:07 +01008088 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008089 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008090 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008091#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008092 {
8093 status = PSA_ERROR_NOT_SUPPORTED;
8094 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008095 }
8096
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008097 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8098
Przemek Stekiel51eac532022-12-07 11:04:51 +01008099 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008100exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008101 psa_pake_abort(operation);
8102 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008103}
8104
8105psa_status_t psa_pake_set_password_key(
8106 psa_pake_operation_t *operation,
8107 mbedtls_svc_key_id_t password)
8108{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008109 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008110 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8111 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008112 psa_key_attributes_t attributes;
8113 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008114
Przemek Stekiel51eac532022-12-07 11:04:51 +01008115 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008116 status = PSA_ERROR_BAD_STATE;
8117 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008118 }
8119
Przemek Stekiel6c764412022-11-22 14:05:12 +01008120 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8121 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008122 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008123 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008124 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008125 }
8126
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008127 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008128 .core = slot->attr
8129 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008130
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008131 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008132
Przemek Stekiel51eac532022-12-07 11:04:51 +01008133 if (type != PSA_KEY_TYPE_PASSWORD &&
8134 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8135 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008136 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008137 }
8138
Przemek Stekiel51eac532022-12-07 11:04:51 +01008139 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8140 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008141 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008142 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008143 }
8144
8145 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8146 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008147 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008148exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008149 if (status != PSA_SUCCESS) {
8150 psa_pake_abort(operation);
8151 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008152 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008153 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008154}
8155
8156psa_status_t psa_pake_set_user(
8157 psa_pake_operation_t *operation,
8158 const uint8_t *user_id,
8159 size_t user_id_len)
8160{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008161 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008162
8163 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008164 status = PSA_ERROR_BAD_STATE;
8165 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008166 }
8167
Przemek Stekiel51eac532022-12-07 11:04:51 +01008168 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008169 status = PSA_ERROR_INVALID_ARGUMENT;
8170 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008171 }
8172
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008173 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008174 status = PSA_ERROR_BAD_STATE;
8175 goto exit;
8176 }
8177
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008178 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8179 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008180 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8181 goto exit;
8182 }
8183
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008184 memcpy(operation->data.inputs.user, user_id, user_id_len);
8185 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008186
8187 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008188exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008189 psa_pake_abort(operation);
8190 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008191}
8192
8193psa_status_t psa_pake_set_peer(
8194 psa_pake_operation_t *operation,
8195 const uint8_t *peer_id,
8196 size_t peer_id_len)
8197{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008198 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008199
8200 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008201 status = PSA_ERROR_BAD_STATE;
8202 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008203 }
8204
Przemek Stekiel51eac532022-12-07 11:04:51 +01008205 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008206 status = PSA_ERROR_INVALID_ARGUMENT;
8207 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008208 }
8209
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008210 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008211 status = PSA_ERROR_BAD_STATE;
8212 goto exit;
8213 }
8214
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008215 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8216 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008217 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8218 goto exit;
8219 }
8220
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008221 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8222 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008223
8224 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008225exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008226 psa_pake_abort(operation);
8227 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008228}
8229
8230psa_status_t psa_pake_set_role(
8231 psa_pake_operation_t *operation,
8232 psa_pake_role_t role)
8233{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008234 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008235
Przemek Stekiel51eac532022-12-07 11:04:51 +01008236 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008237 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008238 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008239 }
8240
Przemek Stekiel09104b82023-03-06 14:11:51 +01008241 switch (operation->alg) {
8242#if defined(PSA_WANT_ALG_JPAKE)
8243 case PSA_ALG_JPAKE:
8244 if (role == PSA_PAKE_ROLE_NONE) {
8245 return PSA_SUCCESS;
8246 }
8247 status = PSA_ERROR_INVALID_ARGUMENT;
8248 break;
8249#endif
8250 default:
8251 (void) role;
8252 status = PSA_ERROR_NOT_SUPPORTED;
8253 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008254 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008255exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008256 psa_pake_abort(operation);
8257 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008258}
8259
David Horstmanne7f21e62023-05-12 18:17:21 +01008260/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008261#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008262static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008263 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008264{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008265 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008266 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008267 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008268
David Horstmann024e5c52023-06-14 15:48:21 +01008269 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008270 is_x1 = (stage->outputs < 1);
8271 } else {
8272 is_x1 = (stage->inputs < 1);
8273 }
8274
David Horstmann74a3d8c2023-06-14 18:28:19 +01008275 key_share_step = is_x1 ?
8276 PSA_JPAKE_X1_STEP_KEY_SHARE :
8277 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008278 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008279 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8280 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8281 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8282 } else {
8283 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008284 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008285 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008286}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008287#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008288
Przemek Stekiel2797d372022-12-22 11:19:22 +01008289static psa_status_t psa_pake_complete_inputs(
8290 psa_pake_operation_t *operation)
8291{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008292 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008293 /* Create copy of the inputs on stack as inputs share memory
8294 with the driver context which will be setup by the driver. */
8295 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008296
Przemek Stekielfde11282023-03-13 16:06:09 +01008297 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008298 return PSA_ERROR_BAD_STATE;
8299 }
8300
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008301 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008302 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8303 return PSA_ERROR_BAD_STATE;
8304 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008305 }
8306
Przemek Stekiel18620a32023-01-17 16:34:52 +01008307 /* Clear driver context */
8308 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8309
8310 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008311
8312 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008313 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008314
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008315 /* User and peer are translated to role. */
8316 mbedtls_free(inputs.user);
8317 mbedtls_free(inputs.peer);
8318
Przemek Stekiel2797d372022-12-22 11:19:22 +01008319 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008320#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008321 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008322 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008323 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008324#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008325 {
8326 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008327 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008328 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008329 return status;
8330}
8331
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008332#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008333static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008334 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008335 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008336 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008337{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008338 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8339 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8340 step != PSA_PAKE_STEP_ZK_PROOF) {
8341 return PSA_ERROR_INVALID_ARGUMENT;
8342 }
8343
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008344 psa_jpake_computation_stage_t *computation_stage =
8345 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008346
David Horstmann5da95602023-06-08 15:37:12 +01008347 if (computation_stage->round != PSA_JPAKE_FIRST &&
8348 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008349 return PSA_ERROR_BAD_STATE;
8350 }
8351
David Horstmanne7f21e62023-05-12 18:17:21 +01008352 /* Check that the step we are given is the one we were expecting */
8353 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008354 return PSA_ERROR_BAD_STATE;
8355 }
8356
David Horstmanne7f21e62023-05-12 18:17:21 +01008357 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8358 computation_stage->inputs == 0 &&
8359 computation_stage->outputs == 0) {
8360 /* Start of the round, so function decides whether we are inputting
8361 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008362 computation_stage->io_mode = io_mode;
8363 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008364 /* Middle of the round so the mode we are in must match the function
8365 * called by the user */
8366 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008367 }
8368
8369 return PSA_SUCCESS;
8370}
8371
David Horstmanne7f21e62023-05-12 18:17:21 +01008372static psa_status_t psa_jpake_epilogue(
8373 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008374 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008375{
David Horstmanne7f21e62023-05-12 18:17:21 +01008376 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008377 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008378
David Horstmanne7f21e62023-05-12 18:17:21 +01008379 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8380 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008381 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008382 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008383 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008384 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008385 }
8386 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008387 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008388 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008389 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008390 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008391 }
8392 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008393 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8394 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008395 /* End of a round, move to the next round */
8396 stage->inputs = 0;
8397 stage->outputs = 0;
8398 stage->round++;
8399 }
8400 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008401 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008402 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008403 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008404 return PSA_SUCCESS;
8405}
David Horstmanne7f21e62023-05-12 18:17:21 +01008406
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008407#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008408
Neil Armstronga7d08c32022-06-01 18:21:20 +02008409psa_status_t psa_pake_output(
8410 psa_pake_operation_t *operation,
8411 psa_pake_step_t step,
8412 uint8_t *output,
8413 size_t output_size,
8414 size_t *output_length)
8415{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008416 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008417 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008418 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008419
8420 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008421 status = psa_pake_complete_inputs(operation);
8422 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008423 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008424 }
8425 }
8426
8427 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008428 status = PSA_ERROR_BAD_STATE;
8429 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008430 }
8431
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008432 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008433 status = PSA_ERROR_INVALID_ARGUMENT;
8434 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008435 }
8436
Przemek Stekiele12ed362022-12-21 12:54:46 +01008437 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008438#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008439 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008440 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008441 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008442 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008443 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008444 driver_step = convert_jpake_computation_stage_to_driver_step(
8445 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008446 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008447#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008448 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008449 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008450 status = PSA_ERROR_NOT_SUPPORTED;
8451 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008452 }
8453
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008454 status = psa_driver_wrapper_pake_output(operation, driver_step,
8455 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008456
8457 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008458 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008459 }
8460
8461 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008462#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008463 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008464 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008465 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008466 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008467 }
8468 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008469#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008470 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008471 status = PSA_ERROR_NOT_SUPPORTED;
8472 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008473 }
8474
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008475 return PSA_SUCCESS;
8476exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008477 psa_pake_abort(operation);
8478 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008479}
8480
8481psa_status_t psa_pake_input(
8482 psa_pake_operation_t *operation,
8483 psa_pake_step_t step,
8484 const uint8_t *input,
8485 size_t input_length)
8486{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008487 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008488 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008489 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8490 operation->primitive,
8491 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008492
8493 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008494 status = psa_pake_complete_inputs(operation);
8495 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008496 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008497 }
8498 }
8499
8500 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008501 status = PSA_ERROR_BAD_STATE;
8502 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008503 }
8504
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008505 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008506 status = PSA_ERROR_INVALID_ARGUMENT;
8507 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008508 }
8509
Przemek Stekiele12ed362022-12-21 12:54:46 +01008510 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008511#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008512 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008513 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008514 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008515 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008516 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008517 driver_step = convert_jpake_computation_stage_to_driver_step(
8518 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008519 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008520#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008521 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008522 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008523 status = PSA_ERROR_NOT_SUPPORTED;
8524 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008525 }
8526
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008527 status = psa_driver_wrapper_pake_input(operation, driver_step,
8528 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008529
8530 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008531 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008532 }
8533
8534 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008535#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008536 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008537 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008538 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008539 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008540 }
8541 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008542#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008543 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008544 status = PSA_ERROR_NOT_SUPPORTED;
8545 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008546 }
8547
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008548 return PSA_SUCCESS;
8549exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008550 psa_pake_abort(operation);
8551 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008552}
8553
8554psa_status_t psa_pake_get_implicit_key(
8555 psa_pake_operation_t *operation,
8556 psa_key_derivation_operation_t *output)
8557{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008558 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008559 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008560 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008561 size_t shared_key_len = 0;
8562
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008563 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008564 status = PSA_ERROR_BAD_STATE;
8565 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008566 }
8567
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008568#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008569 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008570 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008571 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008572 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008573 status = PSA_ERROR_BAD_STATE;
8574 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008575 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008576 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008577#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008578 {
8579 status = PSA_ERROR_NOT_SUPPORTED;
8580 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008581 }
8582
Przemek Stekiel0c781802022-11-29 14:53:13 +01008583 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8584 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008585 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008586 &shared_key_len);
8587
8588 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008589 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008590 }
8591
8592 status = psa_key_derivation_input_bytes(output,
8593 PSA_KEY_DERIVATION_INPUT_SECRET,
8594 shared_key,
8595 shared_key_len);
8596
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008597 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008598exit:
8599 abort_status = psa_pake_abort(operation);
8600 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008601}
8602
8603psa_status_t psa_pake_abort(
8604 psa_pake_operation_t *operation)
8605{
Przemek Stekield69dca92023-01-31 19:59:20 +01008606 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008607
Przemek Stekield69dca92023-01-31 19:59:20 +01008608 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008609 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008610 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008611
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008612 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8613 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008614 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008615 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008616 }
8617 if (operation->data.inputs.user != NULL) {
8618 mbedtls_free(operation->data.inputs.user);
8619 }
8620 if (operation->data.inputs.peer != NULL) {
8621 mbedtls_free(operation->data.inputs.peer);
8622 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008623 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008624 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008625
Przemek Stekield69dca92023-01-31 19:59:20 +01008626 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008627}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008628#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008629
David Horstmann00d7a042023-12-07 18:39:17 +00008630/* Memory copying test hooks. These are called before input copy, after input
8631 * copy, before output copy and after output copy, respectively.
8632 * They are used by memory-poisoning tests to temporarily unpoison buffers
8633 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008634#if defined(MBEDTLS_TEST_HOOKS)
8635void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8636void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8637void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8638void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8639#endif
David Horstmannfde97392023-10-30 20:29:43 +00008640
David Horstmann1b7279a2023-11-15 15:18:30 +00008641/** Copy from an input buffer to a local copy.
8642 *
8643 * \param[in] input Pointer to input buffer.
8644 * \param[in] input_len Length of the input buffer.
8645 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8646 * \param[out] input_copy_len Length of the local copy buffer.
8647 * \return #PSA_SUCCESS, if the buffer was successfully
8648 * copied.
8649 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8650 * copy is too small to hold contents of the
8651 * input buffer.
8652 */
8653MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008654psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8655 uint8_t *input_copy, size_t input_copy_len)
8656{
8657 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008658 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008659 }
8660
David Horstmann372b8bb2023-11-24 16:21:04 +00008661#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008662 if (psa_input_pre_copy_hook != NULL) {
8663 psa_input_pre_copy_hook(input, input_len);
8664 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008665#endif
8666
David Horstmann777e7412023-11-15 17:33:47 +00008667 if (input_len > 0) {
8668 memcpy(input_copy, input, input_len);
8669 }
David Horstmannfde97392023-10-30 20:29:43 +00008670
David Horstmann372b8bb2023-11-24 16:21:04 +00008671#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008672 if (psa_input_post_copy_hook != NULL) {
8673 psa_input_post_copy_hook(input, input_len);
8674 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008675#endif
8676
David Horstmannfde97392023-10-30 20:29:43 +00008677 return PSA_SUCCESS;
8678}
8679
David Horstmann1b7279a2023-11-15 15:18:30 +00008680/** Copy from a local output buffer into a user-supplied one.
8681 *
8682 * \param[in] output_copy Pointer to a local buffer containing the output.
8683 * \param[in] output_copy_len Length of the local buffer.
8684 * \param[out] output Pointer to user-supplied output buffer.
8685 * \param[out] output_len Length of the user-supplied output buffer.
8686 * \return #PSA_SUCCESS, if the buffer was successfully
8687 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008688 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008689 * user-supplied output buffer is too small to
8690 * hold the contents of the local buffer.
8691 */
8692MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008693psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8694 uint8_t *output, size_t output_len)
8695{
8696 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008697 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008698 }
David Horstmann777e7412023-11-15 17:33:47 +00008699
David Horstmann372b8bb2023-11-24 16:21:04 +00008700#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008701 if (psa_output_pre_copy_hook != NULL) {
8702 psa_output_pre_copy_hook(output, output_len);
8703 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008704#endif
8705
David Horstmann777e7412023-11-15 17:33:47 +00008706 if (output_copy_len > 0) {
8707 memcpy(output, output_copy, output_copy_len);
8708 }
8709
David Horstmann372b8bb2023-11-24 16:21:04 +00008710#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008711 if (psa_output_post_copy_hook != NULL) {
8712 psa_output_post_copy_hook(output, output_len);
8713 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008714#endif
8715
David Horstmann8978f5c2023-10-30 20:37:12 +00008716 return PSA_SUCCESS;
8717}
8718
David Horstmannf1734052023-11-20 17:15:32 +00008719psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8720 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008721{
8722 psa_status_t status;
8723
David Horstmann9db14482023-11-23 15:50:37 +00008724 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008725
David Horstmannc5cc1c32023-11-15 18:11:26 +00008726 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008727 return PSA_SUCCESS;
8728 }
8729
David Horstmannf1734052023-11-20 17:15:32 +00008730 local_input->buffer = mbedtls_calloc(input_len, 1);
8731 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008732 /* Since we dealt with the zero-length case above, we know that
8733 * a NULL return value means a failure of allocation. */
8734 return PSA_ERROR_INSUFFICIENT_MEMORY;
8735 }
David Horstmannf1734052023-11-20 17:15:32 +00008736 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008737
David Horstmannf1734052023-11-20 17:15:32 +00008738 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008739
8740 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008741 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008742 if (status != PSA_SUCCESS) {
8743 goto error;
8744 }
8745
8746 return PSA_SUCCESS;
8747
8748error:
David Horstmannf1734052023-11-20 17:15:32 +00008749 mbedtls_free(local_input->buffer);
8750 local_input->buffer = NULL;
8751 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008752 return status;
8753}
8754
David Horstmannf1734052023-11-20 17:15:32 +00008755void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008756{
David Horstmannf1734052023-11-20 17:15:32 +00008757 mbedtls_free(local_input->buffer);
8758 local_input->buffer = NULL;
8759 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008760}
8761
David Horstmann89875a42023-11-20 12:54:09 +00008762psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8763 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008764{
David Horstmann9db14482023-11-23 15:50:37 +00008765 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008766
David Horstmannc5cc1c32023-11-15 18:11:26 +00008767 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008768 return PSA_SUCCESS;
8769 }
David Horstmann89875a42023-11-20 12:54:09 +00008770 local_output->buffer = mbedtls_calloc(output_len, 1);
8771 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008772 /* Since we dealt with the zero-length case above, we know that
8773 * a NULL return value means a failure of allocation. */
8774 return PSA_ERROR_INSUFFICIENT_MEMORY;
8775 }
David Horstmann89875a42023-11-20 12:54:09 +00008776 local_output->length = output_len;
8777 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008778
8779 return PSA_SUCCESS;
8780}
8781
Gabor Mezei1882c512024-01-24 13:07:17 +01008782psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8783 psa_crypto_local_output_t *local_output)
8784{
8785 psa_status_t status;
8786 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8787
8788 if (output_len == 0) {
8789 return PSA_SUCCESS;
8790 }
8791 local_output->buffer = mbedtls_calloc(output_len, 1);
8792 if (local_output->buffer == NULL) {
8793 /* Since we dealt with the zero-length case above, we know that
8794 * a NULL return value means a failure of allocation. */
8795 return PSA_ERROR_INSUFFICIENT_MEMORY;
8796 }
8797 local_output->length = output_len;
8798 local_output->original = output;
8799
8800 status = psa_crypto_copy_input(output, output_len,
8801 local_output->buffer, local_output->length);
8802 if (status != PSA_SUCCESS) {
8803 goto error;
8804 }
8805
8806 return PSA_SUCCESS;
8807
8808error:
8809 mbedtls_free(local_output->buffer);
8810 local_output->buffer = NULL;
8811 local_output->length = 0;
8812 return status;
8813}
8814
David Horstmann89875a42023-11-20 12:54:09 +00008815psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008816{
David Horstmannc335a4e2023-11-15 15:57:32 +00008817 psa_status_t status;
8818
David Horstmann89875a42023-11-20 12:54:09 +00008819 if (local_output->buffer == NULL) {
8820 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008821 return PSA_SUCCESS;
8822 }
David Horstmann89875a42023-11-20 12:54:09 +00008823 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008824 /* We have an internal copy but nothing to copy back to. */
8825 return PSA_ERROR_CORRUPTION_DETECTED;
8826 }
8827
David Horstmann89875a42023-11-20 12:54:09 +00008828 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8829 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008830 if (status != PSA_SUCCESS) {
8831 return status;
8832 }
David Horstmann9467ea32023-11-08 17:44:18 +00008833
David Horstmann89875a42023-11-20 12:54:09 +00008834 mbedtls_free(local_output->buffer);
8835 local_output->buffer = NULL;
8836 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008837
8838 return PSA_SUCCESS;
8839}
8840
Gilles Peskinee59236f2018-01-27 23:32:46 +01008841#endif /* MBEDTLS_PSA_CRYPTO_C */