blob: 4fc940c9f4fde588d1ddb392f8d59880c5e5cef8 [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,
Ryan Everettb1d2c672024-01-08 17:19:30 +00001717 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 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;
Ryan Everettb1d2c672024-01-08 17:19:30 +00001725 LOCAL_OUTPUT_DECLARE(data_external, data);
Darryl Greendd8fb772018-11-07 16:00:44 +00001726
Ronald Crone907e552021-01-18 13:22:38 +01001727 /* Reject a zero-length output buffer now, since this can never be a
1728 * valid key representation. This way we know that data must be a valid
1729 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 if (data_size == 0) {
1731 return PSA_ERROR_BUFFER_TOO_SMALL;
1732 }
Ronald Crone907e552021-01-18 13:22:38 +01001733
Darryl Greendd8fb772018-11-07 16:00:44 +00001734 /* Set the key to empty now, so that even when there are errors, we always
1735 * set data_length to a value between 0 and data_size. On error, setting
1736 * the key to empty is a good choice because an empty key representation is
1737 * unlikely to be accepted anywhere. */
1738 *data_length = 0;
1739
1740 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1742 if (status != PSA_SUCCESS) {
1743 return status;
1744 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001745
Ryan Everettb1d2c672024-01-08 17:19:30 +00001746 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1747
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1749 status = PSA_ERROR_INVALID_ARGUMENT;
1750 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001751 }
1752
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001753 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001754 .core = slot->attr
1755 };
Ronald Cron67227982020-11-26 15:16:05 +01001756 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001757 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001759
1760exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001762
Ryan Everettb1d2c672024-01-08 17:19:30 +00001763 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001765}
1766
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001767MBEDTLS_STATIC_ASSERT(
1768 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1769 "One or more key attribute flag is listed as both external-only and dual-use")
1770MBEDTLS_STATIC_ASSERT(
1771 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1772 "One or more key attribute flag is listed as both internal-only and dual-use")
1773MBEDTLS_STATIC_ASSERT(
1774 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1775 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001776
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001777/** Validate that a key policy is internally well-formed.
1778 *
1779 * This function only rejects invalid policies. It does not validate the
1780 * consistency of the policy with respect to other attributes of the key
1781 * such as the key type.
1782 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001783static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001784{
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1786 PSA_KEY_USAGE_COPY |
1787 PSA_KEY_USAGE_ENCRYPT |
1788 PSA_KEY_USAGE_DECRYPT |
1789 PSA_KEY_USAGE_SIGN_MESSAGE |
1790 PSA_KEY_USAGE_VERIFY_MESSAGE |
1791 PSA_KEY_USAGE_SIGN_HASH |
1792 PSA_KEY_USAGE_VERIFY_HASH |
1793 PSA_KEY_USAGE_VERIFY_DERIVATION |
1794 PSA_KEY_USAGE_DERIVE)) != 0) {
1795 return PSA_ERROR_INVALID_ARGUMENT;
1796 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001797
Gilles Peskine449bd832023-01-11 14:50:10 +01001798 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001799}
1800
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001801/** Validate the internal consistency of key attributes.
1802 *
1803 * This function only rejects invalid attribute values. If does not
1804 * validate the consistency of the attributes with any key data that may
1805 * be involved in the creation of the key.
1806 *
1807 * Call this function early in the key creation process.
1808 *
1809 * \param[in] attributes Key attributes for the new key.
1810 * \param[out] p_drv On any return, the driver for the key, if any.
1811 * NULL for a transparent key.
1812 *
1813 */
1814static psa_status_t psa_validate_key_attributes(
1815 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001817{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001818 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1820 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001821
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 status = psa_validate_key_location(lifetime, p_drv);
1823 if (status != PSA_SUCCESS) {
1824 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001825 }
1826
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 status = psa_validate_key_persistence(lifetime);
1828 if (status != PSA_SUCCESS) {
1829 return status;
1830 }
1831
1832 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1833 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1834 return PSA_ERROR_INVALID_ARGUMENT;
1835 }
1836 } else {
1837 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1838 return PSA_ERROR_INVALID_ARGUMENT;
1839 }
1840 }
1841
1842 status = psa_validate_key_policy(&attributes->core.policy);
1843 if (status != PSA_SUCCESS) {
1844 return status;
1845 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001846
1847 /* Refuse to create overly large keys.
1848 * Note that this doesn't trigger on import if the attributes don't
1849 * explicitly specify a size (so psa_get_key_bits returns 0), so
1850 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1852 return PSA_ERROR_NOT_SUPPORTED;
1853 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001854
Gilles Peskine91e8c332019-08-02 19:19:39 +02001855 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1857 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1858 return PSA_ERROR_INVALID_ARGUMENT;
1859 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001860
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001862}
1863
Gilles Peskine4747d192019-04-17 15:05:45 +02001864/** Prepare a key slot to receive key material.
1865 *
1866 * This function allocates a key slot and sets its metadata.
1867 *
1868 * If this function fails, call psa_fail_key_creation().
1869 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001870 * This function is intended to be used as follows:
1871 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001872 * it with the specified attributes, and in case of a volatile key assign it
1873 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001874 * -# Populate the slot with the key material.
1875 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1876 * In case of failure at any step, stop the sequence and call
1877 * psa_fail_key_creation().
1878 *
Ronald Cron5c522922020-11-14 16:35:34 +01001879 * On success, the key slot is locked. It is the responsibility of the caller
1880 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001881 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001882 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001883 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001884 * \param[out] p_slot On success, a pointer to the prepared slot.
1885 * \param[out] p_drv On any return, the driver for the key, if any.
1886 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001887 *
1888 * \retval #PSA_SUCCESS
1889 * The key slot is ready to receive key material.
1890 * \return If this function fails, the key slot is an invalid state.
1891 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001892 */
1893static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001894 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001895 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001896 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001897 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001898{
1899 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001900 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001901 psa_key_slot_t *slot;
1902
Gilles Peskinedf179142019-07-15 22:02:14 +02001903 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001904 *p_drv = NULL;
1905
Gilles Peskine449bd832023-01-11 14:50:10 +01001906 status = psa_validate_key_attributes(attributes, p_drv);
1907 if (status != PSA_SUCCESS) {
1908 return status;
1909 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001910
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1912 if (status != PSA_SUCCESS) {
1913 return status;
1914 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001915 slot = *p_slot;
1916
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001917 /* We're storing the declared bit-size of the key. It's up to each
1918 * creation mechanism to verify that this information is correct.
1919 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001920 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001921 * is optional (import, copy). In case of a volatile key, assign it the
1922 * volatile key identifier associated to the slot returned to contain its
1923 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001924
1925 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001926 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001927#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1928 slot->attr.id = volatile_key_id;
1929#else
1930 slot->attr.id.key_id = volatile_key_id;
1931#endif
1932 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001933
Gilles Peskine91e8c332019-08-02 19:19:39 +02001934 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001935 * external-only flags, query `attributes`. Thanks to the check
1936 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001937 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001938 * may have set. */
1939 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001940
Gilles Peskinecbaff462019-07-12 23:46:04 +02001941#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001942 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001943 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001944 * create the key file in internal storage, create the
1945 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001946 * persistent data. This is done by starting a transaction that will
1947 * encompass these three actions.
1948 * For registering a volatile key, we just need to find an appropriate
1949 * slot number inside the SE. Since the key is designated volatile, creating
1950 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001951 /* The first thing to do is to find a slot number for the new key.
1952 * We save the slot number in persistent storage as part of the
1953 * transaction data. It will be needed to recover if the power
1954 * fails during the key creation process, to clean up on the secure
1955 * element side after restarting. Obtaining a slot number from the
1956 * secure element driver updates its persistent state, but we do not yet
1957 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001958 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001960 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1962 &slot_number);
1963 if (status != PSA_SUCCESS) {
1964 return status;
1965 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1968 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001969 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001970 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001971 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 status = psa_crypto_save_transaction();
1973 if (status != PSA_SUCCESS) {
1974 (void) psa_crypto_stop_transaction();
1975 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001976 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001977 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001978
1979 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001981 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001982
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001984 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001986 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001987#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1988
Ryan Everett975d4112023-11-16 13:37:51 +00001989 slot->status = PSA_SLOT_OCCUPIED;
1990
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001992}
Gilles Peskine4747d192019-04-17 15:05:45 +02001993
1994/** Finalize the creation of a key once its key material has been set.
1995 *
1996 * This entails writing the key to persistent storage.
1997 *
1998 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001999 * See the documentation of psa_start_key_creation() for the intended use
2000 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002001 *
Ronald Cron5c522922020-11-14 16:35:34 +01002002 * If the finalization succeeds, the function unlocks the key slot (it was
2003 * locked by psa_start_key_creation()) and the key slot cannot be accessed
2004 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01002005 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002006 * \param[in,out] slot Pointer to the slot with key material.
2007 * \param[in] driver The secure element driver for the key,
2008 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01002009 * \param[out] key On success, identifier of the key. Note that the
2010 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002011 *
2012 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02002013 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01002014 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
2015 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
2016 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
2017 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
2018 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
2019 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01002020 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002021 * \return If this function fails, the key slot is an invalid state.
2022 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02002023 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002024static psa_status_t psa_finish_key_creation(
2025 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01002026 psa_se_drv_table_entry_t *driver,
2027 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002028{
2029 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02002030 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02002031 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02002032
2033#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02002035#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002037 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01002038 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01002040
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00002041 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
2042 sizeof(data.slot_number),
2043 "Slot number size does not match psa_se_key_data_storage_t");
2044
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
2046 status = psa_save_persistent_key(&slot->attr,
2047 (uint8_t *) &data,
2048 sizeof(data));
2049 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02002050#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2051 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002052 /* Key material is saved in export representation in the slot, so
2053 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 status = psa_save_persistent_key(&slot->attr,
2055 slot->key.data,
2056 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02002057 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002058 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002059#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2060
Gilles Peskinecbaff462019-07-12 23:46:04 +02002061#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002062 /* Finish the transaction for a key creation. This does not
2063 * happen when registering an existing key. Detect this case
2064 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002065 * creation of a persistent key in a secure element requires a transaction,
2066 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 if (driver != NULL &&
2068 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
2069 status = psa_save_se_persistent_data(driver);
2070 if (status != PSA_SUCCESS) {
2071 psa_destroy_persistent_key(slot->attr.id);
2072 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02002073 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02002075 }
2076#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002079 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 status = psa_unlock_key_slot(slot);
2081 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002082 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002084 }
Ronald Cron50972942020-11-14 11:28:25 +01002085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002087}
2088
2089/** Abort the creation of a key.
2090 *
2091 * You may call this function after calling psa_start_key_creation(),
2092 * or after psa_finish_key_creation() fails. In other circumstances, this
2093 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002094 * See the documentation of psa_start_key_creation() for the intended use
2095 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002096 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002097 * \param[in,out] slot Pointer to the slot with key material.
2098 * \param[in] driver The secure element driver for the key,
2099 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002100 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002101static void psa_fail_key_creation(psa_key_slot_t *slot,
2102 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02002103{
Gilles Peskine011e4282019-06-26 18:34:38 +02002104 (void) driver;
2105
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02002107 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 }
Gilles Peskine011e4282019-06-26 18:34:38 +02002109
2110#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002111 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002112 * element, and the failure happened later (when saving metadata
2113 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002114 * element.
2115 * https://github.com/ARMmbed/mbed-crypto/issues/217
2116 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002117
Gilles Peskined7729582019-08-05 15:55:54 +02002118 /* Abort the ongoing transaction if any (there may not be one if
2119 * the creation process failed before starting one, or if the
2120 * key creation is a registration of a key in a secure element).
2121 * Earlier functions must already have done what it takes to undo any
2122 * partial creation. All that's left is to update the transaction data
2123 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002125#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02002128}
2129
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002130/** Validate optional attributes during key creation.
2131 *
2132 * Some key attributes are optional during key creation. If they are
2133 * specified in the attributes structure, check that they are consistent
2134 * with the data in the slot.
2135 *
2136 * This function should be called near the end of key creation, after
2137 * the slot in memory is fully populated but before saving persistent data.
2138 */
2139static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002140 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002142{
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 if (attributes->core.type != 0) {
2144 if (attributes->core.type != slot->attr.type) {
2145 return PSA_ERROR_INVALID_ARGUMENT;
2146 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002147 }
2148
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002150#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2151 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2153 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002154 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002155 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002156 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002157
Ronald Cron90857082020-11-25 14:58:33 +01002158 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 slot->attr.type,
2160 slot->key.data,
2161 slot->key.bytes,
2162 &rsa);
2163 if (status != PSA_SUCCESS) {
2164 return status;
2165 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 mbedtls_mpi_init(&actual);
2168 mbedtls_mpi_init(&required);
2169 ret = mbedtls_rsa_export(rsa,
2170 NULL, NULL, NULL, NULL, &actual);
2171 mbedtls_rsa_free(rsa);
2172 mbedtls_free(rsa);
2173 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002174 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 }
2176 ret = mbedtls_mpi_read_binary(&required,
2177 attributes->domain_parameters,
2178 attributes->domain_parameters_size);
2179 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002180 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 }
2182 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002183 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 }
2185rsa_exit:
2186 mbedtls_mpi_free(&actual);
2187 mbedtls_mpi_free(&required);
2188 if (ret != 0) {
2189 return mbedtls_to_psa_error(ret);
2190 }
2191 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002192#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2193 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002194 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002195 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002197 }
2198 }
2199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 if (attributes->core.bits != 0) {
2201 if (attributes->core.bits != slot->attr.bits) {
2202 return PSA_ERROR_INVALID_ARGUMENT;
2203 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002204 }
2205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002207}
2208
Gilles Peskine449bd832023-01-11 14:50:10 +01002209psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everettf028fe12024-01-08 17:14:44 +00002210 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 size_t data_length,
2212 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002213{
2214 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002215 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002216 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002217 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002218 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302219 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002220
Ronald Cron81709fc2020-11-14 12:10:32 +01002221 *key = MBEDTLS_SVC_KEY_ID_INIT;
2222
Gilles Peskine0f84d622019-09-12 19:03:13 +02002223 /* Reject zero-length symmetric keys (including raw data key objects).
2224 * This also rejects any key which might be encoded as an empty string,
2225 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 if (data_length == 0) {
2227 return PSA_ERROR_INVALID_ARGUMENT;
2228 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002229
Archana449608b2021-09-08 15:36:05 +05302230 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 if (data_length > SIZE_MAX / 8) {
2232 return PSA_ERROR_NOT_SUPPORTED;
2233 }
Archana6ed4bda2021-08-04 10:47:15 +05302234
Ryan Everettf028fe12024-01-08 17:14:44 +00002235 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2236
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2238 &slot, &driver);
2239 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002240 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002242
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002243 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302244 * storage ( thus not in the case of importing a key in a secure element
2245 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2246 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 if (slot->key.data == NULL) {
2248 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302249 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 attributes, data, data_length, &storage_size);
2251 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302252 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 }
Archanad8a83dc2021-06-14 10:04:16 +05302254 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 status = psa_allocate_buffer_to_slot(slot, storage_size);
2256 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002257 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002259 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002260
2261 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 status = psa_driver_wrapper_import_key(attributes,
2263 data, data_length,
2264 slot->key.data,
2265 slot->key.bytes,
2266 &slot->key.bytes, &bits);
2267 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002268 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002272 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002274 status = PSA_ERROR_INVALID_ARGUMENT;
2275 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002276 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002277
Archana6ed4bda2021-08-04 10:47:15 +05302278 /* Enforce a size limit, and in particular ensure that the bit
2279 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302281 status = PSA_ERROR_NOT_SUPPORTED;
2282 goto exit;
2283 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 status = psa_validate_optional_attributes(slot, attributes);
2285 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002286 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002288
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002290exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002291 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 if (status != PSA_SUCCESS) {
2293 psa_fail_key_creation(slot, driver);
2294 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002295
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002297}
2298
Gilles Peskined7729582019-08-05 15:55:54 +02002299#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2300psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002302{
2303 psa_status_t status;
2304 psa_key_slot_t *slot = NULL;
2305 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002306 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002307
2308 /* Leaving attributes unspecified is not currently supported.
2309 * It could make sense to query the key type and size from the
2310 * secure element, but not all secure elements support this
2311 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2313 return PSA_ERROR_NOT_SUPPORTED;
2314 }
2315 if (psa_get_key_bits(attributes) == 0) {
2316 return PSA_ERROR_NOT_SUPPORTED;
2317 }
Gilles Peskined7729582019-08-05 15:55:54 +02002318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2320 &slot, &driver);
2321 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002322 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 }
Gilles Peskined7729582019-08-05 15:55:54 +02002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002326
2327exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 if (status != PSA_SUCCESS) {
2329 psa_fail_key_creation(slot, driver);
2330 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002331
Gilles Peskined7729582019-08-05 15:55:54 +02002332 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 psa_close_key(key);
2334 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002335}
2336#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2337
Gilles Peskine449bd832023-01-11 14:50:10 +01002338psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2339 const psa_key_attributes_t *specified_attributes,
2340 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002341{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002342 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002343 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002344 psa_key_slot_t *source_slot = NULL;
2345 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002346 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002347 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302348 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002349
Ronald Cron81709fc2020-11-14 12:10:32 +01002350 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2351
Archana8a180362021-07-05 02:18:48 +05302352 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2354 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002355 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 status = psa_validate_optional_attributes(source_slot,
2359 specified_attributes);
2360 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002361 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002363
Archana9d17bf42021-09-10 06:22:44 +05302364 /* The target key type and number of bits have been validated by
2365 * psa_validate_optional_attributes() to be either equal to zero or
2366 * equal to the ones of the source key. So it is safe to inherit
2367 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302368 * */
Archana9d17bf42021-09-10 06:22:44 +05302369 actual_attributes.core.bits = source_slot->attr.bits;
2370 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302371
2372
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 status = psa_restrict_key_policy(source_slot->attr.type,
2374 &actual_attributes.core.policy,
2375 &source_slot->attr.policy);
2376 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002377 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2381 &target_slot, &driver);
2382 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002383 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 }
2385 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2386 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302387 /*
Archana9d17bf42021-09-10 06:22:44 +05302388 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302389 * the source key would need to be exported as plaintext and re-imported
2390 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302391 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302392 * appropriate API invocations from the application, if needed.
2393 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002394 status = PSA_ERROR_NOT_SUPPORTED;
2395 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002396 }
Archana8a180362021-07-05 02:18:48 +05302397 /*
2398 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302399 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302400 * - For opaque keys this translates to an invocation of the drivers'
2401 * copy_key entry point through the dispatch layer.
2402 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2404 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2405 &storage_size);
2406 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302407 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 }
Archana374fe5b2021-09-08 15:50:28 +05302409
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2411 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302412 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 }
Archana374fe5b2021-09-08 15:50:28 +05302414
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 status = psa_driver_wrapper_copy_key(&actual_attributes,
2416 source_slot->key.data,
2417 source_slot->key.bytes,
2418 target_slot->key.data,
2419 target_slot->key.bytes,
2420 &target_slot->key.bytes);
2421 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302422 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 }
2424 } else {
2425 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302426 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 source_slot->key.bytes);
2428 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302429 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 }
Archana8a180362021-07-05 02:18:48 +05302431 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002433exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 if (status != PSA_SUCCESS) {
2435 psa_fail_key_creation(target_slot, driver);
2436 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002437
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002439
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002441}
2442
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002443
2444
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002445/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002446/* Message digests */
2447/****************************************************************/
2448
Gilles Peskine449bd832023-01-11 14:50:10 +01002449psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002450{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002451 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 if (operation->id == 0) {
2453 return PSA_SUCCESS;
2454 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002455
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002457 operation->id = 0;
2458
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002460}
2461
Gilles Peskine449bd832023-01-11 14:50:10 +01002462psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2463 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002464{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002465 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002466
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002467 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002469 status = PSA_ERROR_BAD_STATE;
2470 goto exit;
2471 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002472
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002474 status = PSA_ERROR_INVALID_ARGUMENT;
2475 goto exit;
2476 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002477
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002478 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2479 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002483
2484exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 if (status != PSA_SUCCESS) {
2486 psa_hash_abort(operation);
2487 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002488
2489 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002490}
2491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2493 const uint8_t *input,
2494 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002495{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002496 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2497
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002499 status = PSA_ERROR_BAD_STATE;
2500 goto exit;
2501 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002502
Steven Cooremanc8288352021-03-04 14:02:19 +01002503 /* Don't require hash implementations to behave correctly on a
2504 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 if (input_length == 0) {
2506 return PSA_SUCCESS;
2507 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002508
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002510
2511exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 if (status != PSA_SUCCESS) {
2513 psa_hash_abort(operation);
2514 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002517}
2518
Gilles Peskine449bd832023-01-11 14:50:10 +01002519psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2520 uint8_t *hash,
2521 size_t hash_size,
2522 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002523{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002524 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 if (operation->id == 0) {
2526 return PSA_ERROR_BAD_STATE;
2527 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002528
Steven Cooreman1e582352021-02-18 17:24:37 +01002529 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 operation, hash, hash_size, hash_length);
2531 psa_hash_abort(operation);
2532 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002533}
2534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2536 const uint8_t *hash,
2537 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002538{
Ronald Cron69a63422021-10-18 09:47:58 +02002539 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002540 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002541 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 operation,
2543 actual_hash, sizeof(actual_hash),
2544 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002545
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002547 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002551 status = PSA_ERROR_INVALID_SIGNATURE;
2552 goto exit;
2553 }
2554
Dave Rodgman78701152023-08-29 14:20:18 +01002555 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002556 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002558
2559exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2561 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002562 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002564
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002566}
2567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568psa_status_t psa_hash_compute(psa_algorithm_t alg,
2569 const uint8_t *input, size_t input_length,
2570 uint8_t *hash, size_t hash_size,
2571 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002572{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002573 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 if (!PSA_ALG_IS_HASH(alg)) {
2575 return PSA_ERROR_INVALID_ARGUMENT;
2576 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2579 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002580}
2581
Gilles Peskine449bd832023-01-11 14:50:10 +01002582psa_status_t psa_hash_compare(psa_algorithm_t alg,
2583 const uint8_t *input, size_t input_length,
2584 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002585{
Ronald Cron69a63422021-10-18 09:47:58 +02002586 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002587 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 if (!PSA_ALG_IS_HASH(alg)) {
2590 return PSA_ERROR_INVALID_ARGUMENT;
2591 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002592
Steven Cooreman1e582352021-02-18 17:24:37 +01002593 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 alg, input, input_length,
2595 actual_hash, sizeof(actual_hash),
2596 &actual_hash_length);
2597 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002598 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 }
2600 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002601 status = PSA_ERROR_INVALID_SIGNATURE;
2602 goto exit;
2603 }
Dave Rodgman78701152023-08-29 14:20:18 +01002604 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002605 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002607
2608exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2610 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002611}
2612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2614 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002615{
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (source_operation->id == 0 ||
2617 target_operation->id != 0) {
2618 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002619 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002620
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2622 target_operation);
2623 if (status != PSA_SUCCESS) {
2624 psa_hash_abort(target_operation);
2625 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002626
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002628}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002629
2630
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002631/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002632/* MAC */
2633/****************************************************************/
2634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002636{
Steven Cooremane6804192021-03-19 18:28:56 +01002637 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 if (operation->id == 0) {
2639 return PSA_SUCCESS;
2640 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002643 operation->mac_size = 0;
2644 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002645 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002648}
2649
Ronald Cron2dff3b22021-06-17 16:33:22 +02002650static psa_status_t psa_mac_finalize_alg_and_key_validation(
2651 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002652 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002654{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002655 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 psa_key_type_t key_type = psa_get_key_type(attributes);
2657 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002658
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 if (!PSA_ALG_IS_MAC(alg)) {
2660 return PSA_ERROR_INVALID_ARGUMENT;
2661 }
Steven Cooremane6804192021-03-19 18:28:56 +01002662
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002663 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 status = psa_mac_key_can_do(alg, key_type);
2665 if (status != PSA_SUCCESS) {
2666 return status;
2667 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002668
Steven Cooremand1a68f12021-05-10 11:13:41 +02002669 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002673 /* A very short MAC is too short for security since it can be
2674 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2675 * so we make this our minimum, even though 32 bits is still
2676 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002678 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2681 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002682 /* It's impossible to "truncate" to a larger length than the full length
2683 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002685 }
2686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002688 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2689 * that is disabled in the compile-time configuration. The result can
2690 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2691 * configuration into account. In this case, force a return of
2692 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2693 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2694 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2695 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2696 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002698 }
2699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002701}
2702
Gilles Peskine449bd832023-01-11 14:50:10 +01002703static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2704 mbedtls_svc_key_id_t key,
2705 psa_algorithm_t alg,
2706 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002707{
2708 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2709 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002710 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002711 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002712
2713 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002715 status = PSA_ERROR_BAD_STATE;
2716 goto exit;
2717 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002718
2719 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 key,
2721 &slot,
2722 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2723 alg);
2724 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002725 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002727
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002728 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002729 .core = slot->attr
2730 };
2731
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2733 &operation->mac_size);
2734 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002735 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002737
2738 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002739 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 if (is_sign) {
2741 status = psa_driver_wrapper_mac_sign_setup(operation,
2742 &attributes,
2743 slot->key.data,
2744 slot->key.bytes,
2745 alg);
2746 } else {
2747 status = psa_driver_wrapper_mac_verify_setup(operation,
2748 &attributes,
2749 slot->key.data,
2750 slot->key.bytes,
2751 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002752 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002753
Gilles Peskinefbfac682018-07-08 20:51:54 +02002754exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 if (status != PSA_SUCCESS) {
2756 psa_mac_abort(operation);
2757 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002758
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002762}
2763
Gilles Peskine449bd832023-01-11 14:50:10 +01002764psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2765 mbedtls_svc_key_id_t key,
2766 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002767{
Gilles Peskine449bd832023-01-11 14:50:10 +01002768 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002769}
2770
Gilles Peskine449bd832023-01-11 14:50:10 +01002771psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2772 mbedtls_svc_key_id_t key,
2773 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002774{
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002776}
2777
Gilles Peskine449bd832023-01-11 14:50:10 +01002778psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2779 const uint8_t *input,
2780 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002781{
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 if (operation->id == 0) {
2783 return PSA_ERROR_BAD_STATE;
2784 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002785
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002786 /* Don't require hash implementations to behave correctly on a
2787 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 if (input_length == 0) {
2789 return PSA_SUCCESS;
2790 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002791
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2793 input, input_length);
2794 if (status != PSA_SUCCESS) {
2795 psa_mac_abort(operation);
2796 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002797
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002799}
2800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2802 uint8_t *mac,
2803 size_t mac_size,
2804 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002805{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002806 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2807 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002808
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002810 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002811 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002812 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002813
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002815 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002816 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002817 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002818
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002819 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2820 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002822 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002823 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002824 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002825
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002827 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002828 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002829 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002830
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 status = psa_driver_wrapper_mac_sign_finish(operation,
2832 mac, operation->mac_size,
2833 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002834
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002835exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002836 /* In case of success, set the potential excess room in the output buffer
2837 * to an invalid value, to avoid potentially leaking a longer MAC.
2838 * In case of error, set the output length and content to a safe default,
2839 * such that in case the caller misses an error check, the output would be
2840 * an unachievable MAC.
2841 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002843 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002844 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002845 }
mohammad16036df908f2018-04-02 08:34:15 -07002846
Paul Elliottdc42ca82023-02-24 18:11:59 +00002847 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002848
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002852}
2853
Gilles Peskine449bd832023-01-11 14:50:10 +01002854psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2855 const uint8_t *mac,
2856 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002857{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002858 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2859 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002862 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002863 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002864 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002865
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002867 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002868 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002869 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002872 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002873 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002874 }
2875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 status = psa_driver_wrapper_mac_verify_finish(operation,
2877 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002878
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002879exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002881
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002883}
2884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2886 psa_algorithm_t alg,
2887 const uint8_t *input,
2888 size_t input_length,
2889 uint8_t *mac,
2890 size_t mac_size,
2891 size_t *mac_length,
2892 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002893{
2894 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002895 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2896 psa_key_slot_t *slot;
2897 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002898 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002899
Ronald Cron51131b52021-06-17 17:17:20 +02002900 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 key,
2902 &slot,
2903 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2904 alg);
2905 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002906 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002908
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002909 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002910 .core = slot->attr
2911 };
2912
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2914 &operation_mac_size);
2915 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002916 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002918
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002920 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002921 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002922 }
2923
2924 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 &attributes,
2926 slot->key.data, slot->key.bytes,
2927 alg,
2928 input, input_length,
2929 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002930
2931exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002932 /* In case of success, set the potential excess room in the output buffer
2933 * to an invalid value, to avoid potentially leaking a longer MAC.
2934 * In case of error, set the output length and content to a safe default,
2935 * such that in case the caller misses an error check, the output would be
2936 * an unachievable MAC.
2937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002939 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002940 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002941 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002942
2943 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002946
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002948}
2949
Gilles Peskine449bd832023-01-11 14:50:10 +01002950psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002951 psa_algorithm_t alg,
2952 const uint8_t *input,
2953 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 uint8_t *mac,
2955 size_t mac_size,
2956 size_t *mac_length)
2957{
2958 return psa_mac_compute_internal(key, alg,
2959 input, input_length,
2960 mac, mac_size, mac_length, 1);
2961}
2962
2963psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2964 psa_algorithm_t alg,
2965 const uint8_t *input,
2966 size_t input_length,
2967 const uint8_t *mac,
2968 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002969{
2970 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002971 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2972 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002973
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 status = psa_mac_compute_internal(key, alg,
2975 input, input_length,
2976 actual_mac, sizeof(actual_mac),
2977 &actual_mac_length, 0);
2978 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002979 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002981
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 if (mac_length != actual_mac_length) {
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 }
Dave Rodgman78701152023-08-29 14:20:18 +01002986 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002987 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002988 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002989 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002990
2991exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002993
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002995}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002996
Gilles Peskinee59236f2018-01-27 23:32:46 +01002997/****************************************************************/
2998/* Asymmetric cryptography */
2999/****************************************************************/
3000
Gilles Peskine449bd832023-01-11 14:50:10 +01003001static psa_status_t psa_sign_verify_check_alg(int input_is_message,
3002 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003003{
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 if (input_is_message) {
3005 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
3006 return PSA_ERROR_INVALID_ARGUMENT;
3007 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003008
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 if (PSA_ALG_IS_SIGN_HASH(alg)) {
3010 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
3011 return PSA_ERROR_INVALID_ARGUMENT;
3012 }
3013 }
3014 } else {
3015 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
3016 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003017 }
3018 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003019
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003021}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003022
Gilles Peskine449bd832023-01-11 14:50:10 +01003023static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
3024 int input_is_message,
3025 psa_algorithm_t alg,
3026 const uint8_t *input,
3027 size_t input_length,
3028 uint8_t *signature,
3029 size_t signature_size,
3030 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003031{
3032 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3033 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3034 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003035 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003036
3037 *signature_length = 0;
3038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 status = psa_sign_verify_check_alg(input_is_message, alg);
3040 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003041 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003043
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003044 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02003045 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003046 * buffer can in principle be empty since it doesn't actually have
3047 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 if (signature_size == 0) {
3049 return PSA_ERROR_BUFFER_TOO_SMALL;
3050 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003051
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003052 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 key, &slot,
3054 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
3055 PSA_KEY_USAGE_SIGN_HASH,
3056 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003057
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003059 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003061
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003063 status = PSA_ERROR_INVALID_ARGUMENT;
3064 goto exit;
3065 }
3066
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003067 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003069 };
3070
Gilles Peskine449bd832023-01-11 14:50:10 +01003071 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003072 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003073 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003074 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 signature, signature_size, signature_length);
3076 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003077
3078 status = psa_driver_wrapper_sign_hash(
3079 &attributes, slot->key.data, slot->key.bytes,
3080 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003082 }
3083
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003084
3085exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003086 psa_wipe_tag_output_buffer(signature, status, signature_size,
3087 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003088
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003092}
3093
Gilles Peskine449bd832023-01-11 14:50:10 +01003094static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3095 int input_is_message,
3096 psa_algorithm_t alg,
3097 const uint8_t *input,
3098 size_t input_length,
3099 const uint8_t *signature,
3100 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003101{
3102 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3103 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3104 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003105
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 status = psa_sign_verify_check_alg(input_is_message, alg);
3107 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003108 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003110
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003111 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 key, &slot,
3113 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3114 PSA_KEY_USAGE_VERIFY_HASH,
3115 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003116
Gilles Peskine449bd832023-01-11 14:50:10 +01003117 if (status != PSA_SUCCESS) {
3118 return status;
3119 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003120
3121 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003123 };
3124
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003126 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003127 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003128 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 signature, signature_length);
3130 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003131 status = psa_driver_wrapper_verify_hash(
3132 &attributes, slot->key.data, slot->key.bytes,
3133 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003135 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003136
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003138
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003140
3141}
3142
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003143psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003144 const psa_key_attributes_t *attributes,
3145 const uint8_t *key_buffer,
3146 size_t key_buffer_size,
3147 psa_algorithm_t alg,
3148 const uint8_t *input,
3149 size_t input_length,
3150 uint8_t *signature,
3151 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003153{
3154 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003155
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003157 size_t hash_length;
3158 uint8_t hash[PSA_HASH_MAX_SIZE];
3159
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003160 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003161 PSA_ALG_SIGN_GET_HASH(alg),
3162 input, input_length,
3163 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003164
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003166 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003168
3169 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 attributes, key_buffer, key_buffer_size,
3171 alg, hash, hash_length,
3172 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003173 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003174
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003176}
3177
Gilles Peskine449bd832023-01-11 14:50:10 +01003178psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3179 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003180 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003181 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003182 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 size_t signature_size,
3184 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003185{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3187 LOCAL_INPUT_DECLARE(input_external, input);
3188 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3189
3190 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3191 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3192 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3193 signature_size, signature_length);
3194
Thomas Daubney3e65f522024-01-30 12:37:25 +00003195#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003196exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003197#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003198 LOCAL_INPUT_FREE(input_external, input);
3199 LOCAL_OUTPUT_FREE(signature_external, signature);
3200 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003201}
3202
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003203psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003204 const psa_key_attributes_t *attributes,
3205 const uint8_t *key_buffer,
3206 size_t key_buffer_size,
3207 psa_algorithm_t alg,
3208 const uint8_t *input,
3209 size_t input_length,
3210 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003211 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003212{
3213 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003214
Gilles Peskine449bd832023-01-11 14:50:10 +01003215 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003216 size_t hash_length;
3217 uint8_t hash[PSA_HASH_MAX_SIZE];
3218
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003219 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 PSA_ALG_SIGN_GET_HASH(alg),
3221 input, input_length,
3222 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003223
Gilles Peskine449bd832023-01-11 14:50:10 +01003224 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003225 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003226 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003227
3228 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003229 attributes, key_buffer, key_buffer_size,
3230 alg, hash, hash_length,
3231 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003232 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003233
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003235}
3236
Gilles Peskine449bd832023-01-11 14:50:10 +01003237psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3238 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003239 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003241 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003243{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003244 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3245 LOCAL_INPUT_DECLARE(input_external, input);
3246 LOCAL_INPUT_DECLARE(signature_external, signature);
3247
3248 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3249 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3250 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3251 signature_length);
3252
Thomas Daubney3e65f522024-01-30 12:37:25 +00003253#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003254exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003255#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003256 LOCAL_INPUT_FREE(input_external, input);
3257 LOCAL_INPUT_FREE(signature_external, signature);
3258
3259 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003260}
3261
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003262psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003263 const psa_key_attributes_t *attributes,
3264 const uint8_t *key_buffer, size_t key_buffer_size,
3265 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003267{
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3269 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3270 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003271#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3273 return mbedtls_psa_rsa_sign_hash(
3274 attributes,
3275 key_buffer, key_buffer_size,
3276 alg, hash, hash_length,
3277 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003278#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3279 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003280 } else {
3281 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003282 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003283 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3284 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003285#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3287 return mbedtls_psa_ecdsa_sign_hash(
3288 attributes,
3289 key_buffer, key_buffer_size,
3290 alg, hash, hash_length,
3291 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003292#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3293 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 } else {
3295 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003296 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003297 }
Ronald Cron4501c982021-03-19 20:09:32 +01003298
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 (void) key_buffer;
3300 (void) key_buffer_size;
3301 (void) hash;
3302 (void) hash_length;
3303 (void) signature;
3304 (void) signature_size;
3305 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003306
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003308}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003309
Gilles Peskine449bd832023-01-11 14:50:10 +01003310psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3311 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003312 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003314 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 size_t signature_size,
3316 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003317{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003318 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3319 LOCAL_INPUT_DECLARE(hash_external, hash);
3320 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3321
3322 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3323 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3324 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3325 signature_size, signature_length);
3326
Thomas Daubney3e65f522024-01-30 12:37:25 +00003327#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003328exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003329#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003330 LOCAL_INPUT_FREE(hash_external, hash);
3331 LOCAL_OUTPUT_FREE(signature_external, signature);
3332
3333 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003334}
3335
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003336psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003337 const psa_key_attributes_t *attributes,
3338 const uint8_t *key_buffer, size_t key_buffer_size,
3339 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003341{
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3343 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3344 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003345#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003346 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3347 return mbedtls_psa_rsa_verify_hash(
3348 attributes,
3349 key_buffer, key_buffer_size,
3350 alg, hash, hash_length,
3351 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003352#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3353 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 } else {
3355 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003356 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003357 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3358 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003359#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3361 return mbedtls_psa_ecdsa_verify_hash(
3362 attributes,
3363 key_buffer, key_buffer_size,
3364 alg, hash, hash_length,
3365 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003366#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3367 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 } else {
3369 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003370 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003371 }
Ronald Cron4501c982021-03-19 20:09:32 +01003372
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 (void) key_buffer;
3374 (void) key_buffer_size;
3375 (void) hash;
3376 (void) hash_length;
3377 (void) signature;
3378 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003379
Gilles Peskine449bd832023-01-11 14:50:10 +01003380 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003381}
3382
Gilles Peskine449bd832023-01-11 14:50:10 +01003383psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3384 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003385 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003387 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003388 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003389{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3391 LOCAL_INPUT_DECLARE(hash_external, hash);
3392 LOCAL_INPUT_DECLARE(signature_external, signature);
3393
3394 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3395 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3396 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3397 signature_length);
3398
Thomas Daubney3e65f522024-01-30 12:37:25 +00003399#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003400exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003401#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003402 LOCAL_INPUT_FREE(hash_external, hash);
3403 LOCAL_INPUT_FREE(signature_external, signature);
3404
3405 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003406}
3407
Gilles Peskine449bd832023-01-11 14:50:10 +01003408psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3409 psa_algorithm_t alg,
3410 const uint8_t *input,
3411 size_t input_length,
3412 const uint8_t *salt,
3413 size_t salt_length,
3414 uint8_t *output,
3415 size_t output_size,
3416 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003417{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003418 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003419 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003420 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003421 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003422
Darryl Green5cc689a2018-07-24 15:34:10 +01003423 (void) input;
3424 (void) input_length;
3425 (void) salt;
3426 (void) output;
3427 (void) output_size;
3428
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003429 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003430
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3432 return PSA_ERROR_INVALID_ARGUMENT;
3433 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003434
Ronald Cron5c522922020-11-14 16:35:34 +01003435 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003436 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3437 if (status != PSA_SUCCESS) {
3438 return status;
3439 }
3440 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3441 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003442 status = PSA_ERROR_INVALID_ARGUMENT;
3443 goto exit;
3444 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003445
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003446 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003447 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003448 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003449
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003450 status = psa_driver_wrapper_asymmetric_encrypt(
3451 &attributes, slot->key.data, slot->key.bytes,
3452 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003453 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003454exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003456
Gilles Peskine449bd832023-01-11 14:50:10 +01003457 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003458}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003459
Gilles Peskine449bd832023-01-11 14:50:10 +01003460psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3461 psa_algorithm_t alg,
3462 const uint8_t *input,
3463 size_t input_length,
3464 const uint8_t *salt,
3465 size_t salt_length,
3466 uint8_t *output,
3467 size_t output_size,
3468 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003469{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003470 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003471 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003472 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003473 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003474
Darryl Green5cc689a2018-07-24 15:34:10 +01003475 (void) input;
3476 (void) input_length;
3477 (void) salt;
3478 (void) output;
3479 (void) output_size;
3480
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003481 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003482
Gilles Peskine449bd832023-01-11 14:50:10 +01003483 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3484 return PSA_ERROR_INVALID_ARGUMENT;
3485 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003486
Ronald Cron5c522922020-11-14 16:35:34 +01003487 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003488 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3489 if (status != PSA_SUCCESS) {
3490 return status;
3491 }
3492 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003493 status = PSA_ERROR_INVALID_ARGUMENT;
3494 goto exit;
3495 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003496
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003497 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003498 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003499 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003500
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003501 status = psa_driver_wrapper_asymmetric_decrypt(
3502 &attributes, slot->key.data, slot->key.bytes,
3503 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003504 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003505
3506exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003507 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003508
Gilles Peskine449bd832023-01-11 14:50:10 +01003509 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003510}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003511
Paul Elliott9fe12f62022-11-30 19:16:02 +00003512/****************************************************************/
3513/* Asymmetric interruptible cryptography */
3514/****************************************************************/
3515
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003516static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3517
Paul Elliott9fe12f62022-11-30 19:16:02 +00003518void psa_interruptible_set_max_ops(uint32_t max_ops)
3519{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003520 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003521}
3522
3523uint32_t psa_interruptible_get_max_ops(void)
3524{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003525 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003526}
3527
Paul Elliott9fe12f62022-11-30 19:16:02 +00003528uint32_t psa_sign_hash_get_num_ops(
3529 const psa_sign_hash_interruptible_operation_t *operation)
3530{
Paul Elliott296ede92022-12-15 17:00:30 +00003531 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003532}
3533
3534uint32_t psa_verify_hash_get_num_ops(
3535 const psa_verify_hash_interruptible_operation_t *operation)
3536{
Paul Elliott296ede92022-12-15 17:00:30 +00003537 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003538}
3539
Paul Elliott59ad9452022-12-18 15:09:02 +00003540static psa_status_t psa_sign_hash_abort_internal(
3541 psa_sign_hash_interruptible_operation_t *operation)
3542{
3543 if (operation->id == 0) {
3544 /* The object has (apparently) been initialized but it is not (yet)
3545 * in use. It's ok to call abort on such an object, and there's
3546 * nothing to do. */
3547 return PSA_SUCCESS;
3548 }
3549
3550 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3551
3552 status = psa_driver_wrapper_sign_hash_abort(operation);
3553
3554 operation->id = 0;
3555
Paul Elliotte6145dc2023-02-07 12:51:21 +00003556 /* Do not clear either the error_occurred or num_ops elements here as they
3557 * only want to be cleared by the application calling abort, not by abort
3558 * being called at completion of an operation. */
3559
Paul Elliott59ad9452022-12-18 15:09:02 +00003560 return status;
3561}
3562
Paul Elliott9fe12f62022-11-30 19:16:02 +00003563psa_status_t psa_sign_hash_start(
3564 psa_sign_hash_interruptible_operation_t *operation,
3565 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3566 const uint8_t *hash, size_t hash_length)
3567{
3568 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3569 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3570 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003571 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003572
Paul Elliottc9774412023-02-06 15:14:07 +00003573 /* Check that start has not been previously called, or operation has not
3574 * previously errored. */
3575 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003576 return PSA_ERROR_BAD_STATE;
3577 }
3578
Paul Elliott9fe12f62022-11-30 19:16:02 +00003579 status = psa_sign_verify_check_alg(0, alg);
3580 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003581 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003582 return status;
3583 }
3584
3585 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3586 PSA_KEY_USAGE_SIGN_HASH,
3587 alg);
3588
3589 if (status != PSA_SUCCESS) {
3590 goto exit;
3591 }
3592
3593 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3594 status = PSA_ERROR_INVALID_ARGUMENT;
3595 goto exit;
3596 }
3597
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003598 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003599 .core = slot->attr
3600 };
3601
Paul Elliott296ede92022-12-15 17:00:30 +00003602 /* Ensure ops count gets reset, in case of operation re-use. */
3603 operation->num_ops = 0;
3604
Paul Elliott9fe12f62022-11-30 19:16:02 +00003605 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3606 slot->key.data,
3607 slot->key.bytes, alg,
3608 hash, hash_length);
3609exit:
3610
3611 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003612 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003613 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003614 }
3615
3616 unlock_status = psa_unlock_key_slot(slot);
3617
Paul Elliottc9774412023-02-06 15:14:07 +00003618 if (unlock_status != PSA_SUCCESS) {
3619 operation->error_occurred = 1;
3620 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003621
Paul Elliottc9774412023-02-06 15:14:07 +00003622 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003623}
3624
3625
3626psa_status_t psa_sign_hash_complete(
3627 psa_sign_hash_interruptible_operation_t *operation,
3628 uint8_t *signature, size_t signature_size,
3629 size_t *signature_length)
3630{
3631 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3632
3633 *signature_length = 0;
3634
Paul Elliottc9774412023-02-06 15:14:07 +00003635 /* Check that start has been called first, and that operation has not
3636 * previously errored. */
3637 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003638 status = PSA_ERROR_BAD_STATE;
3639 goto exit;
3640 }
3641
Paul Elliott096abc42023-02-03 18:33:23 +00003642 /* Immediately reject a zero-length signature buffer. This guarantees that
3643 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003644 if (signature_size == 0) {
3645 status = PSA_ERROR_BUFFER_TOO_SMALL;
3646 goto exit;
3647 }
3648
3649 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3650 signature_size,
3651 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003652
Paul Elliott296ede92022-12-15 17:00:30 +00003653 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003654 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003655
Paul Elliottebe225c2023-02-10 14:32:53 +00003656exit:
3657
Paul Elliott59200a22023-02-21 15:07:40 +00003658 psa_wipe_tag_output_buffer(signature, status, signature_size,
3659 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003660
Paul Elliott53bb3122023-02-10 14:22:22 +00003661 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003662 if (status != PSA_SUCCESS) {
3663 operation->error_occurred = 1;
3664 }
3665
Paul Elliott59ad9452022-12-18 15:09:02 +00003666 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003667 }
3668
3669 return status;
3670}
3671
3672psa_status_t psa_sign_hash_abort(
3673 psa_sign_hash_interruptible_operation_t *operation)
3674{
Paul Elliott59ad9452022-12-18 15:09:02 +00003675 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3676
3677 status = psa_sign_hash_abort_internal(operation);
3678
3679 /* We clear the number of ops done here, so that it is not cleared when
3680 * the operation fails or succeeds, only on manual abort. */
3681 operation->num_ops = 0;
3682
Paul Elliottc9774412023-02-06 15:14:07 +00003683 /* Likewise, failure state. */
3684 operation->error_occurred = 0;
3685
Paul Elliott59ad9452022-12-18 15:09:02 +00003686 return status;
3687}
3688
3689static psa_status_t psa_verify_hash_abort_internal(
3690 psa_verify_hash_interruptible_operation_t *operation)
3691{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003692 if (operation->id == 0) {
3693 /* The object has (apparently) been initialized but it is not (yet)
3694 * in use. It's ok to call abort on such an object, and there's
3695 * nothing to do. */
3696 return PSA_SUCCESS;
3697 }
3698
Paul Elliott59ad9452022-12-18 15:09:02 +00003699 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3700
3701 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003702
3703 operation->id = 0;
3704
Paul Elliotte6145dc2023-02-07 12:51:21 +00003705 /* Do not clear either the error_occurred or num_ops elements here as they
3706 * only want to be cleared by the application calling abort, not by abort
3707 * being called at completion of an operation. */
3708
Paul Elliott59ad9452022-12-18 15:09:02 +00003709 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003710}
3711
3712psa_status_t psa_verify_hash_start(
3713 psa_verify_hash_interruptible_operation_t *operation,
3714 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3715 const uint8_t *hash, size_t hash_length,
3716 const uint8_t *signature, size_t signature_length)
3717{
3718 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3719 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3720 psa_key_slot_t *slot;
3721
Paul Elliottc9774412023-02-06 15:14:07 +00003722 /* Check that start has not been previously called, or operation has not
3723 * previously errored. */
3724 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003725 return PSA_ERROR_BAD_STATE;
3726 }
3727
3728 status = psa_sign_verify_check_alg(0, alg);
3729 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003730 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003731 return status;
3732 }
3733
3734 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3735 PSA_KEY_USAGE_VERIFY_HASH,
3736 alg);
3737
3738 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003739 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003740 return status;
3741 }
3742
3743 psa_key_attributes_t attributes = {
3744 .core = slot->attr
3745 };
3746
Paul Elliott296ede92022-12-15 17:00:30 +00003747 /* Ensure ops count gets reset, in case of operation re-use. */
3748 operation->num_ops = 0;
3749
Paul Elliott9fe12f62022-11-30 19:16:02 +00003750 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3751 slot->key.data,
3752 slot->key.bytes,
3753 alg, hash, hash_length,
3754 signature, signature_length);
3755
3756 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003757 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003758 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003759 }
3760
3761 unlock_status = psa_unlock_key_slot(slot);
3762
Paul Elliottc9774412023-02-06 15:14:07 +00003763 if (unlock_status != PSA_SUCCESS) {
3764 operation->error_occurred = 1;
3765 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003766
Paul Elliottc9774412023-02-06 15:14:07 +00003767 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003768}
3769
3770psa_status_t psa_verify_hash_complete(
3771 psa_verify_hash_interruptible_operation_t *operation)
3772{
3773 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3774
Paul Elliottc9774412023-02-06 15:14:07 +00003775 /* Check that start has been called first, and that operation has not
3776 * previously errored. */
3777 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003778 status = PSA_ERROR_BAD_STATE;
3779 goto exit;
3780 }
3781
3782 status = psa_driver_wrapper_verify_hash_complete(operation);
3783
Paul Elliott296ede92022-12-15 17:00:30 +00003784 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003785 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003786 operation);
3787
Paul Elliottebe225c2023-02-10 14:32:53 +00003788exit:
3789
Paul Elliott9fe12f62022-11-30 19:16:02 +00003790 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003791 if (status != PSA_SUCCESS) {
3792 operation->error_occurred = 1;
3793 }
3794
Paul Elliott59ad9452022-12-18 15:09:02 +00003795 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003796 }
3797
3798 return status;
3799}
3800
3801psa_status_t psa_verify_hash_abort(
3802 psa_verify_hash_interruptible_operation_t *operation)
3803{
Paul Elliott59ad9452022-12-18 15:09:02 +00003804 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003805
Paul Elliott59ad9452022-12-18 15:09:02 +00003806 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003807
Paul Elliott59ad9452022-12-18 15:09:02 +00003808 /* We clear the number of ops done here, so that it is not cleared when
3809 * the operation fails or succeeds, only on manual abort. */
3810 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003811
Paul Elliottc9774412023-02-06 15:14:07 +00003812 /* Likewise, failure state. */
3813 operation->error_occurred = 0;
3814
Paul Elliott59ad9452022-12-18 15:09:02 +00003815 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003816}
3817
Paul Elliott588f8ed2022-12-02 18:10:26 +00003818/****************************************************************/
3819/* Asymmetric interruptible cryptography internal */
3820/* implementations */
3821/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003822
Paul Elliott588f8ed2022-12-02 18:10:26 +00003823void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3824{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003825
Paul Elliott588f8ed2022-12-02 18:10:26 +00003826#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3827 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3828 defined(MBEDTLS_ECP_RESTARTABLE)
3829
3830 /* Internal implementation uses zero to indicate infinite number max ops,
3831 * therefore avoid this value, and set to minimum possible. */
3832 if (max_ops == 0) {
3833 max_ops = 1;
3834 }
3835
Paul Elliott588f8ed2022-12-02 18:10:26 +00003836 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003837#else
3838 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003839#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3840 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3841 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3842}
3843
Paul Elliott588f8ed2022-12-02 18:10:26 +00003844uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003845 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003846{
3847#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3848 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3849 defined(MBEDTLS_ECP_RESTARTABLE)
3850
Paul Elliott93d9ca82023-02-15 18:14:21 +00003851 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003852#else
3853 (void) operation;
3854 return 0;
3855#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3856 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3857 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3858}
3859
3860uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003861 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003862{
3863 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3864 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3865 defined(MBEDTLS_ECP_RESTARTABLE)
3866
Paul Elliott93d9ca82023-02-15 18:14:21 +00003867 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003868#else
3869 (void) operation;
3870 return 0;
3871#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3872 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3873 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3874}
3875
3876psa_status_t mbedtls_psa_sign_hash_start(
3877 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3878 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3879 size_t key_buffer_size, psa_algorithm_t alg,
3880 const uint8_t *hash, size_t hash_length)
3881{
3882 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003883 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003884
Paul Elliott068fe072023-01-16 13:59:15 +00003885 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3886 return PSA_ERROR_NOT_SUPPORTED;
3887 }
3888
3889 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003890 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003891 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003892
3893#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003894 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3895 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003896
Paul Elliotta1c94092023-02-15 16:38:04 +00003897 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3898
Paul Elliott93d9ca82023-02-15 18:14:21 +00003899 /* Ensure num_ops is zero'ed in case of context re-use. */
3900 operation->num_ops = 0;
3901
Paul Elliott068fe072023-01-16 13:59:15 +00003902 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3903 attributes->core.bits,
3904 key_buffer,
3905 key_buffer_size,
3906 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003907
Paul Elliott068fe072023-01-16 13:59:15 +00003908 if (status != PSA_SUCCESS) {
3909 return status;
3910 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003911
Paul Elliott1bc59df2023-02-05 13:41:57 +00003912 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003913 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003914
Paul Elliott068fe072023-01-16 13:59:15 +00003915 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003916 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003917 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003918
Paul Elliott0290a762023-02-09 14:30:24 +00003919 /* We only need to store the same length of hash as the private key size
3920 * here, it would be truncated by the internal implementation anyway. */
3921 required_hash_length = (hash_length < operation->coordinate_bytes ?
3922 hash_length : operation->coordinate_bytes);
3923
Paul Elliottba70ad42023-02-15 18:23:53 +00003924 if (required_hash_length > sizeof(operation->hash)) {
3925 /* Shouldn't happen, but better safe than sorry. */
3926 return PSA_ERROR_CORRUPTION_DETECTED;
3927 }
3928
Paul Elliott0290a762023-02-09 14:30:24 +00003929 memcpy(operation->hash, hash, required_hash_length);
3930 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003931
3932 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003933
3934#else
Paul Elliott068fe072023-01-16 13:59:15 +00003935 (void) operation;
3936 (void) key_buffer;
3937 (void) key_buffer_size;
3938 (void) alg;
3939 (void) hash;
3940 (void) hash_length;
3941 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003942 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003943
Paul Elliott068fe072023-01-16 13:59:15 +00003944 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003945#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3946 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3947 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003948}
3949
3950psa_status_t mbedtls_psa_sign_hash_complete(
3951 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3952 uint8_t *signature, size_t signature_size,
3953 size_t *signature_length)
3954{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003955#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3956 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3957 defined(MBEDTLS_ECP_RESTARTABLE)
3958
Paul Elliotta1c94092023-02-15 16:38:04 +00003959 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003960 mbedtls_mpi r;
3961 mbedtls_mpi s;
3962
Paul Elliott46845252023-02-03 14:59:11 +00003963 mbedtls_mpi_init(&r);
3964 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003965
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003966 /* Ensure max_ops is set to the current value (or default). */
3967 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3968
Paul Elliotta1c94092023-02-15 16:38:04 +00003969 if (signature_size < 2 * operation->coordinate_bytes) {
3970 status = PSA_ERROR_BUFFER_TOO_SMALL;
3971 goto exit;
3972 }
3973
Paul Elliott588f8ed2022-12-02 18:10:26 +00003974 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003975
Paul Elliott588f8ed2022-12-02 18:10:26 +00003976#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3977 status = mbedtls_to_psa_error(
3978 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003979 &r,
3980 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003981 &operation->ctx->d,
3982 operation->hash,
3983 operation->hash_length,
3984 operation->md_alg,
3985 mbedtls_psa_get_random,
3986 MBEDTLS_PSA_RANDOM_STATE,
3987 &operation->restart_ctx));
3988#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003989 status = PSA_ERROR_NOT_SUPPORTED;
3990 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003991#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3992 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003993 status = mbedtls_to_psa_error(
3994 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003995 &r,
3996 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003997 &operation->ctx->d,
3998 operation->hash,
3999 operation->hash_length,
4000 mbedtls_psa_get_random,
4001 MBEDTLS_PSA_RANDOM_STATE,
4002 mbedtls_psa_get_random,
4003 MBEDTLS_PSA_RANDOM_STATE,
4004 &operation->restart_ctx));
4005 }
4006
Paul Elliottf8e5b562023-02-19 18:43:45 +00004007 /* Hide the fact that the restart context only holds a delta of number of
4008 * ops done during the last operation, not an absolute value. */
4009 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4010
Paul Elliott724bd252023-02-08 12:35:08 +00004011 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00004012 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004013 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004014 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004015 operation->coordinate_bytes)
4016 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004017
4018 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004019 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004020 }
4021
4022 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004023 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004024 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004025 operation->coordinate_bytes,
4026 operation->coordinate_bytes)
4027 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004028
4029 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004030 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004031 }
4032
Paul Elliott1bc59df2023-02-05 13:41:57 +00004033 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004034
Paul Elliott724bd252023-02-08 12:35:08 +00004035 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004036 }
Paul Elliott724bd252023-02-08 12:35:08 +00004037
4038exit:
4039
4040 mbedtls_mpi_free(&r);
4041 mbedtls_mpi_free(&s);
4042 return status;
4043
Paul Elliott588f8ed2022-12-02 18:10:26 +00004044 #else
4045
4046 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004047 (void) signature;
4048 (void) signature_size;
4049 (void) signature_length;
4050
4051 return PSA_ERROR_NOT_SUPPORTED;
4052
4053#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4054 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4055 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4056}
4057
4058psa_status_t mbedtls_psa_sign_hash_abort(
4059 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4060{
4061
4062#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4063 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4064 defined(MBEDTLS_ECP_RESTARTABLE)
4065
4066 if (operation->ctx) {
4067 mbedtls_ecdsa_free(operation->ctx);
4068 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004069 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004070 }
4071
4072 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4073
Paul Elliott93d9ca82023-02-15 18:14:21 +00004074 operation->num_ops = 0;
4075
Paul Elliott588f8ed2022-12-02 18:10:26 +00004076 return PSA_SUCCESS;
4077
4078#else
4079
4080 (void) operation;
4081
4082 return PSA_ERROR_NOT_SUPPORTED;
4083
4084#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4085 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4086 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4087}
4088
4089psa_status_t mbedtls_psa_verify_hash_start(
4090 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4091 const psa_key_attributes_t *attributes,
4092 const uint8_t *key_buffer, size_t key_buffer_size,
4093 psa_algorithm_t alg,
4094 const uint8_t *hash, size_t hash_length,
4095 const uint8_t *signature, size_t signature_length)
4096{
4097 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004098 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004099 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004100
Paul Elliott068fe072023-01-16 13:59:15 +00004101 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4102 return PSA_ERROR_NOT_SUPPORTED;
4103 }
4104
4105 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004106 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004107 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004108
4109#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004110 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4111 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004112
Paul Elliotta1c94092023-02-15 16:38:04 +00004113 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4114 mbedtls_mpi_init(&operation->r);
4115 mbedtls_mpi_init(&operation->s);
4116
Paul Elliott93d9ca82023-02-15 18:14:21 +00004117 /* Ensure num_ops is zero'ed in case of context re-use. */
4118 operation->num_ops = 0;
4119
Paul Elliott068fe072023-01-16 13:59:15 +00004120 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4121 attributes->core.bits,
4122 key_buffer,
4123 key_buffer_size,
4124 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004125
Paul Elliott068fe072023-01-16 13:59:15 +00004126 if (status != PSA_SUCCESS) {
4127 return status;
4128 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004129
Paul Elliottc569fc22023-02-10 13:02:54 +00004130 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004131
Paul Elliott1bc59df2023-02-05 13:41:57 +00004132 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004133 return PSA_ERROR_INVALID_SIGNATURE;
4134 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004135
Paul Elliott068fe072023-01-16 13:59:15 +00004136 status = mbedtls_to_psa_error(
4137 mbedtls_mpi_read_binary(&operation->r,
4138 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004139 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004140
Paul Elliott068fe072023-01-16 13:59:15 +00004141 if (status != PSA_SUCCESS) {
4142 return status;
4143 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004144
Paul Elliott068fe072023-01-16 13:59:15 +00004145 status = mbedtls_to_psa_error(
4146 mbedtls_mpi_read_binary(&operation->s,
4147 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004148 coordinate_bytes,
4149 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004150
Paul Elliott068fe072023-01-16 13:59:15 +00004151 if (status != PSA_SUCCESS) {
4152 return status;
4153 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004154
Paul Elliott2c9843f2023-02-15 17:32:42 +00004155 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004156
Paul Elliott2c9843f2023-02-15 17:32:42 +00004157 if (status != PSA_SUCCESS) {
4158 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004159 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004160
Paul Elliott0290a762023-02-09 14:30:24 +00004161 /* We only need to store the same length of hash as the private key size
4162 * here, it would be truncated by the internal implementation anyway. */
4163 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4164 coordinate_bytes);
4165
Paul Elliottba70ad42023-02-15 18:23:53 +00004166 if (required_hash_length > sizeof(operation->hash)) {
4167 /* Shouldn't happen, but better safe than sorry. */
4168 return PSA_ERROR_CORRUPTION_DETECTED;
4169 }
4170
Paul Elliott0290a762023-02-09 14:30:24 +00004171 memcpy(operation->hash, hash, required_hash_length);
4172 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004173
4174 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004175#else
Paul Elliott068fe072023-01-16 13:59:15 +00004176 (void) operation;
4177 (void) key_buffer;
4178 (void) key_buffer_size;
4179 (void) alg;
4180 (void) hash;
4181 (void) hash_length;
4182 (void) signature;
4183 (void) signature_length;
4184 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004185 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004186 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004187
Paul Elliott068fe072023-01-16 13:59:15 +00004188 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004189#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4190 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4191 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004192}
4193
4194psa_status_t mbedtls_psa_verify_hash_complete(
4195 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4196{
4197
4198#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4199 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4200 defined(MBEDTLS_ECP_RESTARTABLE)
4201
Paul Elliottf8e5b562023-02-19 18:43:45 +00004202 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4203
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004204 /* Ensure max_ops is set to the current value (or default). */
4205 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4206
Paul Elliottf8e5b562023-02-19 18:43:45 +00004207 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004208 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4209 operation->hash,
4210 operation->hash_length,
4211 &operation->ctx->Q,
4212 &operation->r,
4213 &operation->s,
4214 &operation->restart_ctx));
4215
Paul Elliottf8e5b562023-02-19 18:43:45 +00004216 /* Hide the fact that the restart context only holds a delta of number of
4217 * ops done during the last operation, not an absolute value. */
4218 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4219
4220 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004221#else
4222 (void) operation;
4223
4224 return PSA_ERROR_NOT_SUPPORTED;
4225
4226#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4227 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4228 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4229}
4230
4231psa_status_t mbedtls_psa_verify_hash_abort(
4232 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4233{
4234
4235#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4236 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4237 defined(MBEDTLS_ECP_RESTARTABLE)
4238
4239 if (operation->ctx) {
4240 mbedtls_ecdsa_free(operation->ctx);
4241 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004242 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004243 }
4244
4245 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4246
Paul Elliott93d9ca82023-02-15 18:14:21 +00004247 operation->num_ops = 0;
4248
Paul Elliott588f8ed2022-12-02 18:10:26 +00004249 mbedtls_mpi_free(&operation->r);
4250 mbedtls_mpi_free(&operation->s);
4251
4252 return PSA_SUCCESS;
4253
4254#else
4255 (void) operation;
4256
4257 return PSA_ERROR_NOT_SUPPORTED;
4258
4259#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4260 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4261 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4262}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004263
mohammad1603503973b2018-03-12 15:59:30 +02004264/****************************************************************/
4265/* Symmetric cryptography */
4266/****************************************************************/
4267
Gilles Peskine449bd832023-01-11 14:50:10 +01004268static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4269 mbedtls_svc_key_id_t key,
4270 psa_algorithm_t alg,
4271 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004272{
4273 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4274 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004275 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4277 PSA_KEY_USAGE_ENCRYPT :
4278 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004279 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004280
4281 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004283 status = PSA_ERROR_BAD_STATE;
4284 goto exit;
4285 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004286
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004288 status = PSA_ERROR_INVALID_ARGUMENT;
4289 goto exit;
4290 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004291
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4293 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004294 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004296
Ronald Cron49fafa92021-03-10 08:34:23 +01004297 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004298 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004299 * so we only set it (in the driver wrapper) after resources have been
4300 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004301 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004303 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004305 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 }
4307 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004308
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004309 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004311 };
4312
Ronald Cronab99ac22020-10-01 16:38:28 +02004313 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 if (cipher_operation == MBEDTLS_ENCRYPT) {
4315 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4316 &attributes,
4317 slot->key.data,
4318 slot->key.bytes,
4319 alg);
4320 } else {
4321 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4322 &attributes,
4323 slot->key.data,
4324 slot->key.bytes,
4325 alg);
4326 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004327
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004328exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 if (status != PSA_SUCCESS) {
4330 psa_cipher_abort(operation);
4331 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004332
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004334
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004336}
4337
Gilles Peskine449bd832023-01-11 14:50:10 +01004338psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4339 mbedtls_svc_key_id_t key,
4340 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004341{
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004343}
4344
Gilles Peskine449bd832023-01-11 14:50:10 +01004345psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4346 mbedtls_svc_key_id_t key,
4347 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004348{
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004350}
4351
Gilles Peskine449bd832023-01-11 14:50:10 +01004352psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4353 uint8_t *iv,
4354 size_t iv_size,
4355 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004356{
Ronald Cron6d051732020-10-01 14:10:20 +02004357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004358 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004359 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004360
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004362 status = PSA_ERROR_BAD_STATE;
4363 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004364 }
4365
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004367 status = PSA_ERROR_BAD_STATE;
4368 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004369 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004370
Ronald Cron2fb90522021-07-05 12:31:44 +02004371 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004373 status = PSA_ERROR_BUFFER_TOO_SMALL;
4374 goto exit;
4375 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004376
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004378 status = PSA_ERROR_GENERIC_ERROR;
4379 goto exit;
4380 }
4381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 status = psa_generate_random(local_iv, default_iv_length);
4383 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004384 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 }
Ronald Cron5618a392021-03-26 09:52:26 +01004386
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 status = psa_driver_wrapper_cipher_set_iv(operation,
4388 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004389
4390exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 if (status == PSA_SUCCESS) {
4392 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004393 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004394 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004396 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004398 }
Ronald Cron6d051732020-10-01 14:10:20 +02004399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004401}
4402
Gilles Peskine449bd832023-01-11 14:50:10 +01004403psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4404 const uint8_t *iv,
4405 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004406{
Ronald Cron6d051732020-10-01 14:10:20 +02004407 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004408
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004410 status = PSA_ERROR_BAD_STATE;
4411 goto exit;
4412 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004413
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004415 status = PSA_ERROR_BAD_STATE;
4416 goto exit;
4417 }
Ronald Crona0d68172021-03-26 10:15:08 +01004418
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004420 status = PSA_ERROR_INVALID_ARGUMENT;
4421 goto exit;
4422 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004423
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 status = psa_driver_wrapper_cipher_set_iv(operation,
4425 iv,
4426 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004427
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004428exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004430 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 } else {
4432 psa_cipher_abort(operation);
4433 }
4434 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004435}
4436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4438 const uint8_t *input,
4439 size_t input_length,
4440 uint8_t *output,
4441 size_t output_size,
4442 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004443{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004444 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004445
Gilles Peskine449bd832023-01-11 14:50:10 +01004446 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004447 status = PSA_ERROR_BAD_STATE;
4448 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004449 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004450
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004452 status = PSA_ERROR_BAD_STATE;
4453 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004454 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004455
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 status = psa_driver_wrapper_cipher_update(operation,
4457 input,
4458 input_length,
4459 output,
4460 output_size,
4461 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004462
4463exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 if (status != PSA_SUCCESS) {
4465 psa_cipher_abort(operation);
4466 }
Ronald Cron6d051732020-10-01 14:10:20 +02004467
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004469}
4470
Gilles Peskine449bd832023-01-11 14:50:10 +01004471psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4472 uint8_t *output,
4473 size_t output_size,
4474 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004475{
David Saadab4ecc272019-02-14 13:48:10 +02004476 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004477
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004479 status = PSA_ERROR_BAD_STATE;
4480 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004481 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004482
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004484 status = PSA_ERROR_BAD_STATE;
4485 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004486 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004487
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 status = psa_driver_wrapper_cipher_finish(operation,
4489 output,
4490 output_size,
4491 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004492
4493exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 if (status == PSA_SUCCESS) {
4495 return psa_cipher_abort(operation);
4496 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004497 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004499
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004501 }
mohammad1603503973b2018-03-12 15:59:30 +02004502}
4503
Gilles Peskine449bd832023-01-11 14:50:10 +01004504psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004505{
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004507 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004508 * in use. It's ok to call abort on such an object, and there's
4509 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004511 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004512
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004514
Ronald Cron49fafa92021-03-10 08:34:23 +01004515 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004516 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004517 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004518
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004520}
4521
Gilles Peskine449bd832023-01-11 14:50:10 +01004522psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4523 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004524 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004526 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 size_t output_size,
4528 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004529{
4530 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004531 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004532 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004533 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4534 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004535 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004536
David Horstmann62a56d92023-12-14 18:12:47 +00004537 LOCAL_INPUT_DECLARE(input_external, input);
4538 LOCAL_OUTPUT_DECLARE(output_external, output);
4539
David Horstmann36df4b22023-12-13 15:55:25 +00004540 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004541 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004542
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004544 status = PSA_ERROR_INVALID_ARGUMENT;
4545 goto exit;
4546 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004547
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4549 PSA_KEY_USAGE_ENCRYPT,
4550 alg);
4551 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004552 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004554
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004555 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004557 };
4558
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4560 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004561 status = PSA_ERROR_GENERIC_ERROR;
4562 goto exit;
4563 }
4564
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 if (default_iv_length > 0) {
4566 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004567 status = PSA_ERROR_BUFFER_TOO_SMALL;
4568 goto exit;
4569 }
4570
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 status = psa_generate_random(local_iv, default_iv_length);
4572 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004573 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004575 }
4576
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004577 status = psa_driver_wrapper_cipher_encrypt(
4578 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004579 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004580 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004582
4583exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 unlock_status = psa_unlock_key_slot(slot);
4585 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004586 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004587 }
Ronald Cron23919522021-07-08 19:00:07 +02004588
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 if (status == PSA_SUCCESS) {
4590 if (default_iv_length > 0) {
4591 memcpy(output, local_iv, default_iv_length);
4592 }
4593 *output_length += default_iv_length;
4594 } else {
4595 *output_length = 0;
4596 }
4597
David Horstmann62a56d92023-12-14 18:12:47 +00004598 LOCAL_INPUT_FREE(input_external, input);
4599 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004600
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004602}
4603
Gilles Peskine449bd832023-01-11 14:50:10 +01004604psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4605 psa_algorithm_t alg,
4606 const uint8_t *input,
4607 size_t input_length,
4608 uint8_t *output,
4609 size_t output_size,
4610 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004611{
4612 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004613 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004614 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004615 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004616
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004618 status = PSA_ERROR_INVALID_ARGUMENT;
4619 goto exit;
4620 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4623 PSA_KEY_USAGE_DECRYPT,
4624 alg);
4625 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004626 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004628
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004629 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004631 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004632
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4634 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004635 status = PSA_ERROR_INVALID_ARGUMENT;
4636 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004638 status = PSA_ERROR_INVALID_ARGUMENT;
4639 goto exit;
4640 }
4641
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004642 status = psa_driver_wrapper_cipher_decrypt(
4643 &attributes, slot->key.data, slot->key.bytes,
4644 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004646
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004647exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 unlock_status = psa_unlock_key_slot(slot);
4649 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004650 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004654 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 }
Ronald Cron23919522021-07-08 19:00:07 +02004656
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004658}
4659
4660
mohammad16035955c982018-04-26 00:53:03 +03004661/****************************************************************/
4662/* AEAD */
4663/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004664
Paul Elliottbaff51c2021-09-28 17:44:45 +01004665/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004666static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004667{
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004669}
4670
4671/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004672static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4673 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004674{
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004676
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004678#if defined(PSA_WANT_ALG_GCM)
4679 case PSA_ALG_GCM:
4680 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 * arbitrarily large nonces. Please note that we do not generally
4682 * recommend the usage of nonces of greater length than
4683 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4684 * size, which can then lead to collisions if you encrypt a very
4685 * large number of messages.*/
4686 if (nonce_length != 0) {
4687 return PSA_SUCCESS;
4688 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004689 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004690#endif /* PSA_WANT_ALG_GCM */
4691#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004692 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 if (nonce_length >= 7 && nonce_length <= 13) {
4694 return PSA_SUCCESS;
4695 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004696 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004697#endif /* PSA_WANT_ALG_CCM */
4698#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004699 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 if (nonce_length == 12) {
4701 return PSA_SUCCESS;
4702 } else if (nonce_length == 8) {
4703 return PSA_ERROR_NOT_SUPPORTED;
4704 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004705 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004706#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004707 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004708 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004710 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004713}
4714
Gilles Peskine449bd832023-01-11 14:50:10 +01004715static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004716{
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4718 return PSA_ERROR_INVALID_ARGUMENT;
4719 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004720
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004722}
4723
Gilles Peskine449bd832023-01-11 14:50:10 +01004724psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4725 psa_algorithm_t alg,
4726 const uint8_t *nonce,
4727 size_t nonce_length,
4728 const uint8_t *additional_data,
4729 size_t additional_data_length,
4730 const uint8_t *plaintext,
4731 size_t plaintext_length,
4732 uint8_t *ciphertext,
4733 size_t ciphertext_size,
4734 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004735{
Ronald Cron215633c2021-03-16 17:15:37 +01004736 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4737 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004738
mohammad1603f08a5502018-06-03 15:05:47 +03004739 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004740
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 status = psa_aead_check_algorithm(alg);
4742 if (status != PSA_SUCCESS) {
4743 return status;
4744 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004745
Ronald Cron9a986162021-03-26 12:40:07 +01004746 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4748 if (status != PSA_SUCCESS) {
4749 return status;
4750 }
mohammad16035955c982018-04-26 00:53:03 +03004751
Ronald Cron215633c2021-03-16 17:15:37 +01004752 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004754 };
mohammad16035955c982018-04-26 00:53:03 +03004755
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 status = psa_aead_check_nonce_length(alg, nonce_length);
4757 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004758 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004760
Ronald Cronde822812021-03-17 16:08:20 +01004761 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004762 &attributes, slot->key.data, slot->key.bytes,
4763 alg,
4764 nonce, nonce_length,
4765 additional_data, additional_data_length,
4766 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004768
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4770 memset(ciphertext, 0, ciphertext_size);
4771 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004772
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004773exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004775
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004777}
4778
Gilles Peskine449bd832023-01-11 14:50:10 +01004779psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4780 psa_algorithm_t alg,
4781 const uint8_t *nonce,
4782 size_t nonce_length,
4783 const uint8_t *additional_data,
4784 size_t additional_data_length,
4785 const uint8_t *ciphertext,
4786 size_t ciphertext_length,
4787 uint8_t *plaintext,
4788 size_t plaintext_size,
4789 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004790{
Ronald Cron215633c2021-03-16 17:15:37 +01004791 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4792 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004793
Gilles Peskineee652a32018-06-01 19:23:52 +02004794 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004795
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 status = psa_aead_check_algorithm(alg);
4797 if (status != PSA_SUCCESS) {
4798 return status;
4799 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004800
Ronald Cron9a986162021-03-26 12:40:07 +01004801 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4803 if (status != PSA_SUCCESS) {
4804 return status;
4805 }
mohammad16035955c982018-04-26 00:53:03 +03004806
Ronald Cron215633c2021-03-16 17:15:37 +01004807 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004809 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004810
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 status = psa_aead_check_nonce_length(alg, nonce_length);
4812 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004813 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004815
Ronald Cronde822812021-03-17 16:08:20 +01004816 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004817 &attributes, slot->key.data, slot->key.bytes,
4818 alg,
4819 nonce, nonce_length,
4820 additional_data, additional_data_length,
4821 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004823
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 if (status != PSA_SUCCESS && plaintext_size != 0) {
4825 memset(plaintext, 0, plaintext_size);
4826 }
mohammad160360a64d02018-06-03 17:20:42 +03004827
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004828exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004830
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 return status;
mohammad16035955c982018-04-26 00:53:03 +03004832}
4833
Gilles Peskine449bd832023-01-11 14:50:10 +01004834static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4835{
4836 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004837
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004839#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004841 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4843 return PSA_ERROR_INVALID_ARGUMENT;
4844 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004845 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004846#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004847
Przemek Stekiel86679c72022-10-06 17:06:56 +02004848#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004850 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4852 return PSA_ERROR_INVALID_ARGUMENT;
4853 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004854 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004855#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004856
Przemek Stekiel86679c72022-10-06 17:06:56 +02004857#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004859 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if (tag_len != 16) {
4861 return PSA_ERROR_INVALID_ARGUMENT;
4862 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004863 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004864#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004865
4866 default:
4867 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004869 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004871}
4872
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004873/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004874static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4875 int is_encrypt,
4876 mbedtls_svc_key_id_t key,
4877 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004878{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004879 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4880 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4881 psa_key_slot_t *slot = NULL;
4882 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004883 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004884
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 status = psa_aead_check_algorithm(alg);
4886 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004887 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004889
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004891 status = PSA_ERROR_BAD_STATE;
4892 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004893 }
4894
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 if (operation->nonce_set || operation->lengths_set ||
4896 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004897 status = PSA_ERROR_BAD_STATE;
4898 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004899 }
4900
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004902 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004904 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4908 alg);
4909 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004910 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004912
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004913 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004914 .core = slot->attr
4915 };
4916
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004918 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004920
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 if (is_encrypt) {
4922 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4923 &attributes,
4924 slot->key.data,
4925 slot->key.bytes,
4926 alg);
4927 } else {
4928 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4929 &attributes,
4930 slot->key.data,
4931 slot->key.bytes,
4932 alg);
4933 }
4934 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004935 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004937
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004939
4940exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004942
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004944 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004946 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 } else {
4948 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004949 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004950
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004952}
4953
Paul Elliott302ff6b2021-04-20 18:10:30 +01004954/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004955psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4956 mbedtls_svc_key_id_t key,
4957 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004958{
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004960}
4961
4962/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004963psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4964 mbedtls_svc_key_id_t key,
4965 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004966{
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004968}
4969
4970/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004971psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4972 uint8_t *nonce,
4973 size_t nonce_size,
4974 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004975{
4976 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004977 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004978 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004979
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004980 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004981
Gilles Peskine449bd832023-01-11 14:50:10 +01004982 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004983 status = PSA_ERROR_BAD_STATE;
4984 goto exit;
4985 }
4986
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004988 status = PSA_ERROR_BAD_STATE;
4989 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004990 }
4991
Paul Elliotte193ea82021-10-01 13:00:16 +01004992 /* For CCM, this size may not be correct according to the PSA
4993 * specification. The PSA Crypto 1.0.1 specification states:
4994 *
4995 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4996 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4997 *
4998 * However this restriction that L has to be the smallest integer is not
4999 * applied in practice, and it is not implementable here since the
5000 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
5002 operation->alg);
5003 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005004 status = PSA_ERROR_BUFFER_TOO_SMALL;
5005 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005006 }
5007
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 status = psa_generate_random(local_nonce, required_nonce_size);
5009 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005010 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005011 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005012
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005014
Paul Elliott39dc6b82021-05-11 19:16:09 +01005015exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 if (status == PSA_SUCCESS) {
5017 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005018 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005019 } else {
5020 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005021 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005022
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005024}
5025
5026/* Set the nonce for a multipart authenticated encryption or decryption
5027 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005028psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
5029 const uint8_t *nonce,
5030 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005031{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005032 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5033
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005035 status = PSA_ERROR_BAD_STATE;
5036 goto exit;
5037 }
5038
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005040 status = PSA_ERROR_BAD_STATE;
5041 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005042 }
5043
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5045 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01005046 status = PSA_ERROR_INVALID_ARGUMENT;
5047 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01005048 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01005049
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5051 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005052
Paul Elliott39dc6b82021-05-11 19:16:09 +01005053exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005055 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 } else {
5057 psa_aead_abort(operation);
5058 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005059
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005061}
5062
5063/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005064psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5065 size_t ad_length,
5066 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005067{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005068 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5069
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005071 status = PSA_ERROR_BAD_STATE;
5072 goto exit;
5073 }
5074
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 if (operation->lengths_set || operation->ad_started ||
5076 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005077 status = PSA_ERROR_BAD_STATE;
5078 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005079 }
5080
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005082#if defined(PSA_WANT_ALG_GCM)
5083 case PSA_ALG_GCM:
5084 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 * bits. Without the guard this code will generate warnings on 32bit
5086 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005087#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 if (((uint64_t) ad_length) >> 61 != 0 ||
5089 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005090 status = PSA_ERROR_INVALID_ARGUMENT;
5091 goto exit;
5092 }
Paul Elliott325d3742021-09-27 17:56:28 +01005093#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005094 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005095#endif /* PSA_WANT_ALG_GCM */
5096#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005097 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005099 status = PSA_ERROR_INVALID_ARGUMENT;
5100 goto exit;
5101 }
5102 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005103#endif /* PSA_WANT_ALG_CCM */
5104#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005105 case PSA_ALG_CHACHA20_POLY1305:
5106 /* No length restrictions for ChaChaPoly. */
5107 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005108#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005109 default:
5110 break;
5111 }
Paul Elliott325d3742021-09-27 17:56:28 +01005112
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5114 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005115
Paul Elliott39dc6b82021-05-11 19:16:09 +01005116exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005118 operation->ad_remaining = ad_length;
5119 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005120 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 } else {
5122 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005123 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005126}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005127
5128/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005129psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5130 const uint8_t *input,
5131 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005132{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005133 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5134
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005136 status = PSA_ERROR_BAD_STATE;
5137 goto exit;
5138 }
5139
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005141 status = PSA_ERROR_BAD_STATE;
5142 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005143 }
5144
Gilles Peskine449bd832023-01-11 14:50:10 +01005145 if (operation->lengths_set) {
5146 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005147 status = PSA_ERROR_INVALID_ARGUMENT;
5148 goto exit;
5149 }
5150
5151 operation->ad_remaining -= input_length;
5152 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005153#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005155 status = PSA_ERROR_BAD_STATE;
5156 goto exit;
5157 }
5158#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005159
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 status = psa_driver_wrapper_aead_update_ad(operation, input,
5161 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005162
Paul Elliott39dc6b82021-05-11 19:16:09 +01005163exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005165 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 } else {
5167 psa_aead_abort(operation);
5168 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005169
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005171}
5172
5173/* Encrypt or decrypt a message fragment in an active multipart AEAD
5174 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005175psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5176 const uint8_t *input,
5177 size_t input_length,
5178 uint8_t *output,
5179 size_t output_size,
5180 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005181{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005183
5184 *output_length = 0;
5185
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005187 status = PSA_ERROR_BAD_STATE;
5188 goto exit;
5189 }
5190
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005192 status = PSA_ERROR_BAD_STATE;
5193 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005194 }
5195
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005197 /* Additional data length was supplied, but not all the additional
5198 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005200 status = PSA_ERROR_INVALID_ARGUMENT;
5201 goto exit;
5202 }
5203
5204 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005206 status = PSA_ERROR_INVALID_ARGUMENT;
5207 goto exit;
5208 }
5209
5210 operation->body_remaining -= input_length;
5211 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005212#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005214 status = PSA_ERROR_BAD_STATE;
5215 goto exit;
5216 }
5217#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005218
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5220 output, output_size,
5221 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005222
Paul Elliott39dc6b82021-05-11 19:16:09 +01005223exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005225 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 } else {
5227 psa_aead_abort(operation);
5228 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005229
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005231}
5232
Gilles Peskine449bd832023-01-11 14:50:10 +01005233static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005234{
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 if (operation->id == 0 || !operation->nonce_set) {
5236 return PSA_ERROR_BAD_STATE;
5237 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005238
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5240 operation->body_remaining != 0)) {
5241 return PSA_ERROR_INVALID_ARGUMENT;
5242 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005243
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005245}
5246
Paul Elliott302ff6b2021-04-20 18:10:30 +01005247/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005248psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5249 uint8_t *ciphertext,
5250 size_t ciphertext_size,
5251 size_t *ciphertext_length,
5252 uint8_t *tag,
5253 size_t tag_size,
5254 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005255{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005256 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5257
Paul Elliott302ff6b2021-04-20 18:10:30 +01005258 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005259 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005260
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 status = psa_aead_final_checks(operation);
5262 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005263 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005265
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005267 status = PSA_ERROR_BAD_STATE;
5268 goto exit;
5269 }
5270
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5272 ciphertext_size,
5273 ciphertext_length,
5274 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005275
Paul Elliott39dc6b82021-05-11 19:16:09 +01005276exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005277
5278
Paul Elliottf47b0952021-05-21 18:02:33 +01005279 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005280 * the zero tag size, make sure the tag is set to something implausible.
5281 * Even if the operation succeeds, make sure we clear the rest of the
5282 * buffer to prevent potential leakage of anything previously placed in
5283 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005284 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005285
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005287
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005289}
5290
5291/* Finish authenticating and decrypting a message in a multipart AEAD
5292 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005293psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5294 uint8_t *plaintext,
5295 size_t plaintext_size,
5296 size_t *plaintext_length,
5297 const uint8_t *tag,
5298 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005299{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005300 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5301
Paul Elliott302ff6b2021-04-20 18:10:30 +01005302 *plaintext_length = 0;
5303
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 status = psa_aead_final_checks(operation);
5305 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005306 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005308
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005310 status = PSA_ERROR_BAD_STATE;
5311 goto exit;
5312 }
5313
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5315 plaintext_size,
5316 plaintext_length,
5317 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005318
5319exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005320 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005321
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005323}
5324
5325/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005326psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005327{
5328 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5329
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005331 /* The object has (apparently) been initialized but it is not (yet)
5332 * in use. It's ok to call abort on such an object, and there's
5333 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005335 }
5336
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005338
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005340
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005342}
5343
Gilles Peskinee59236f2018-01-27 23:32:46 +01005344/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005345/* Generators */
5346/****************************************************************/
5347
Przemek Stekiel69c46792022-06-10 12:59:51 +02005348#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005349 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005350 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305351 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305352 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005353#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005354#endif /* At least one builtin KDF */
5355
Przemek Stekiel69c46792022-06-10 12:59:51 +02005356#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005357 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5358 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5359static psa_status_t psa_key_derivation_start_hmac(
5360 psa_mac_operation_t *operation,
5361 psa_algorithm_t hash_alg,
5362 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005364{
5365 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5366 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5368 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5369 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005370
Steven Cooreman72f736a2021-05-07 14:14:37 +02005371 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005373
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 status = psa_driver_wrapper_mac_sign_setup(operation,
5375 &attributes,
5376 hmac_key, hmac_key_length,
5377 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005378
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 psa_reset_key_attributes(&attributes);
5380 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005381}
5382#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005383
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005384#define HKDF_STATE_INIT 0 /* no input yet */
5385#define HKDF_STATE_STARTED 1 /* got salt */
5386#define HKDF_STATE_KEYED 2 /* got key */
5387#define HKDF_STATE_OUTPUT 3 /* output started */
5388
Gilles Peskinecbe66502019-05-16 16:59:18 +02005389static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005391{
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5393 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5394 } else {
5395 return operation->alg;
5396 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005397}
5398
Gilles Peskine449bd832023-01-11 14:50:10 +01005399psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005400{
5401 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5403 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005404 /* The object has (apparently) been initialized but it is not
5405 * in use. It's ok to call abort on such an object, and there's
5406 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005408#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5410 mbedtls_free(operation->ctx.hkdf.info);
5411 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5412 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005413#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005414#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5415 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5417 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5418 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5419 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005420 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005422 }
5423
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005425 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005427 }
5428
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005430 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005432 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005433#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005435 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005437 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005438#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005439 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005440
5441 /* We leave the fields Ai and output_block to be erased safely by the
5442 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005444#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5445 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005446#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005447 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5448 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5449 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5450 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005451#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305452#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305453 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305454 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005455 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305456 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305457 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305458
5459 status = PSA_SUCCESS;
5460 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305461#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005462 {
5463 status = PSA_ERROR_BAD_STATE;
5464 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 mbedtls_platform_zeroize(operation, sizeof(*operation));
5466 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005467}
5468
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005469psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005471{
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005473 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005475 }
5476
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005477 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005479}
5480
Gilles Peskine449bd832023-01-11 14:50:10 +01005481psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5482 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005483{
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 if (operation->alg == 0) {
5485 return PSA_ERROR_BAD_STATE;
5486 }
5487 if (capacity > operation->capacity) {
5488 return PSA_ERROR_INVALID_ARGUMENT;
5489 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005490 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005492}
5493
Przemek Stekiel69c46792022-06-10 12:59:51 +02005494#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005495/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005496static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5497 psa_algorithm_t kdf_alg,
5498 uint8_t *output,
5499 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005500{
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5502 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005503 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005504 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005505#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005507#else
5508 const uint8_t last_block = 0xff;
5509#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005510
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 if (hkdf->state < HKDF_STATE_KEYED ||
5512 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005513#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005515#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 )) {
5517 return PSA_ERROR_BAD_STATE;
5518 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005519 hkdf->state = HKDF_STATE_OUTPUT;
5520
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005522 /* Copy what remains of the current block */
5523 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005525 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005526 }
5527 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005528 output += n;
5529 output_length -= n;
5530 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005532 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005534 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005535 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005536 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005537 * object was corrupted or if this function is called directly
5538 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 if (hkdf->block_number == last_block) {
5540 return PSA_ERROR_BAD_STATE;
5541 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005542
5543 /* We need a new block */
5544 ++hkdf->block_number;
5545 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005546
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5548 hash_alg,
5549 hkdf->prk,
5550 hash_length);
5551 if (status != PSA_SUCCESS) {
5552 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005553 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005554
5555 if (hkdf->block_number != 1) {
5556 status = psa_mac_update(&hkdf->hmac,
5557 hkdf->output_block,
5558 hash_length);
5559 if (status != PSA_SUCCESS) {
5560 return status;
5561 }
5562 }
5563 status = psa_mac_update(&hkdf->hmac,
5564 hkdf->info,
5565 hkdf->info_length);
5566 if (status != PSA_SUCCESS) {
5567 return status;
5568 }
5569 status = psa_mac_update(&hkdf->hmac,
5570 &hkdf->block_number, 1);
5571 if (status != PSA_SUCCESS) {
5572 return status;
5573 }
5574 status = psa_mac_sign_finish(&hkdf->hmac,
5575 hkdf->output_block,
5576 sizeof(hkdf->output_block),
5577 &hmac_output_length);
5578 if (status != PSA_SUCCESS) {
5579 return status;
5580 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005581 }
5582
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005584}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005585#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005586
John Durkop07cc04a2020-11-16 22:08:34 -08005587#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5588 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005589static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5590 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005592{
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5594 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005595 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5596 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005597 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005598
Janos Follath7742fee2019-06-17 12:58:10 +01005599 /* We can't be wanting more output after block 0xff, otherwise
5600 * the capacity check in psa_key_derivation_output_bytes() would have
5601 * prevented this call. It could happen only if the operation
5602 * object was corrupted or if this function is called directly
5603 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 if (tls12_prf->block_number == 0xff) {
5605 return PSA_ERROR_CORRUPTION_DETECTED;
5606 }
Janos Follath7742fee2019-06-17 12:58:10 +01005607
5608 /* We need a new block */
5609 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005610 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005611
5612 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5613 *
5614 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5615 *
5616 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5617 * HMAC_hash(secret, A(2) + seed) +
5618 * HMAC_hash(secret, A(3) + seed) + ...
5619 *
5620 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005621 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005622 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005623 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005624 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005625 * is currently extracted as `output_block` and where i is
5626 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005627 */
5628
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 status = psa_key_derivation_start_hmac(&hmac,
5630 hash_alg,
5631 tls12_prf->secret,
5632 tls12_prf->secret_length);
5633 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005634 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005636
5637 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005639 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5640 * the variable seed and in this instance means it in the context of the
5641 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 status = psa_mac_update(&hmac,
5643 tls12_prf->label,
5644 tls12_prf->label_length);
5645 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005646 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005647 }
5648 status = psa_mac_update(&hmac,
5649 tls12_prf->seed,
5650 tls12_prf->seed_length);
5651 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005652 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005653 }
5654 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005655 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5657 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005658 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005660 }
5661
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 status = psa_mac_sign_finish(&hmac,
5663 tls12_prf->Ai, hash_length,
5664 &hmac_output_length);
5665 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005666 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 }
5668 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005669 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005670 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005671
5672 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 status = psa_key_derivation_start_hmac(&hmac,
5674 hash_alg,
5675 tls12_prf->secret,
5676 tls12_prf->secret_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->Ai, hash_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->label, tls12_prf->label_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_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5689 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005690 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 }
5692 status = psa_mac_sign_finish(&hmac,
5693 tls12_prf->output_block, hash_length,
5694 &hmac_output_length);
5695 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005696 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005698
Janos Follath7742fee2019-06-17 12:58:10 +01005699
5700cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 cleanup_status = psa_mac_abort(&hmac);
5702 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005703 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005704 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005705
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005707}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005708
Janos Follath844eb0e2019-06-19 12:10:49 +01005709static psa_status_t psa_key_derivation_tls12_prf_read(
5710 psa_tls12_prf_key_derivation_t *tls12_prf,
5711 psa_algorithm_t alg,
5712 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005714{
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5716 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005717 psa_status_t status;
5718 uint8_t offset, length;
5719
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005721 case PSA_TLS12_PRF_STATE_LABEL_SET:
5722 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5723 break;
5724 case PSA_TLS12_PRF_STATE_OUTPUT:
5725 break;
5726 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005728 }
5729
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005731 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 if (tls12_prf->left_in_block == 0) {
5733 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5734 alg);
5735 if (status != PSA_SUCCESS) {
5736 return status;
5737 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005738
5739 continue;
5740 }
5741
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005743 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005745 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005746 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005747
5748 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005750 output += length;
5751 output_length -= length;
5752 tls12_prf->left_in_block -= length;
5753 }
5754
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005756}
John Durkop07cc04a2020-11-16 22:08:34 -08005757#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5758 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005759
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005760#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5761static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5762 psa_tls12_ecjpake_to_pms_t *ecjpake,
5763 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005765{
5766 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005767 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005768
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 if (output_length != 32) {
5770 return PSA_ERROR_INVALID_ARGUMENT;
5771 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005772
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5774 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5775 &output_size);
5776 if (status != PSA_SUCCESS) {
5777 return status;
5778 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005779
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 if (output_size != output_length) {
5781 return PSA_ERROR_GENERIC_ERROR;
5782 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005783
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005785}
5786#endif
5787
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305788#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305789static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5790 psa_pbkdf2_key_derivation_t *pbkdf2,
5791 psa_algorithm_t prf_alg,
5792 uint8_t prf_output_length,
5793 psa_key_attributes_t *attributes)
5794{
5795 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305796 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305797 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305798 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305799 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305800 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305801 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305802
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305803 mac_operation.is_sign = 1;
5804 mac_operation.mac_size = prf_output_length;
5805 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305806
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305807 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5808 attributes,
5809 pbkdf2->password,
5810 pbkdf2->password_length,
5811 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305812 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305813 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305814 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305815 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5816 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305817 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305818 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305819 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305820 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305821 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305822 }
5823 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5824 &mac_output_length);
5825 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305826 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305827 }
5828
5829 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305830 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305831 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305832 }
5833
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305834 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305835
5836 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305837 /* We are passing prf_output_length as mac_size because the driver
5838 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305839 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305840 status = psa_driver_wrapper_mac_compute(attributes,
5841 pbkdf2->password,
5842 pbkdf2->password_length,
5843 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305844 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305845 &mac_output_length);
5846 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305847 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305848 }
5849
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305850 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305851 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305852
5853cleanup:
5854 /* Zeroise buffers to clear sensitive data from memory. */
5855 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5856 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305857}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305858
5859static psa_status_t psa_key_derivation_pbkdf2_read(
5860 psa_pbkdf2_key_derivation_t *pbkdf2,
5861 psa_algorithm_t kdf_alg,
5862 uint8_t *output,
5863 size_t output_length)
5864{
5865 psa_status_t status;
5866 psa_algorithm_t prf_alg;
5867 uint8_t prf_output_length;
5868 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5869 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5870 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5871
5872 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5873 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5874 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5875 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305876 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5877 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305878 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305879 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305880 } else {
5881 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305882 }
5883
5884 switch (pbkdf2->state) {
5885 case PSA_PBKDF2_STATE_PASSWORD_SET:
5886 /* Initially we need a new block so bytes_used is equal to block size*/
5887 pbkdf2->bytes_used = prf_output_length;
5888 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5889 break;
5890 case PSA_PBKDF2_STATE_OUTPUT:
5891 break;
5892 default:
5893 return PSA_ERROR_BAD_STATE;
5894 }
5895
5896 while (output_length != 0) {
5897 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5898 if (n > output_length) {
5899 n = (uint8_t) output_length;
5900 }
5901 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5902 output += n;
5903 output_length -= n;
5904 pbkdf2->bytes_used += n;
5905
5906 if (output_length == 0) {
5907 break;
5908 }
5909
5910 /* We need a new block */
5911 pbkdf2->bytes_used = 0;
5912 pbkdf2->block_number++;
5913
5914 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5915 prf_output_length,
5916 &attributes);
5917 if (status != PSA_SUCCESS) {
5918 return status;
5919 }
5920 }
5921
5922 return PSA_SUCCESS;
5923}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305924#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305925
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005926psa_status_t psa_key_derivation_output_bytes(
5927 psa_key_derivation_operation_t *operation,
5928 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005930{
5931 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005932 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005933
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005935 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005937 }
5938
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005940 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005941 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005942 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005943 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005944 goto exit;
5945 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005947 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005948 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005949 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5950 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005951 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005952 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005953 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005954 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005955 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005956
Przemek Stekiel69c46792022-06-10 12:59:51 +02005957#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5959 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5960 output, output_length);
5961 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005962#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005963#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5964 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5966 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5967 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5968 kdf_alg, output,
5969 output_length);
5970 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005971#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5972 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005973#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005974 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005975 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5977 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005978#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305979#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305980 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305981 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5982 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305983 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305984#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005985
Gilles Peskineeab56e42018-07-12 17:12:33 +02005986 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005987 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005989 }
5990
5991exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005993 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005994 * This allows us to differentiate between exhausted operations and
5995 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5996 * operations. */
5997 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005999 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006000 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02006001 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006003}
6004
David Brown7807bf72021-02-09 16:28:23 -07006005#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006006static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02006007{
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 if (data_size >= 8) {
6009 mbedtls_des_key_set_parity(data);
6010 }
6011 if (data_size >= 16) {
6012 mbedtls_des_key_set_parity(data + 8);
6013 }
6014 if (data_size >= 24) {
6015 mbedtls_des_key_set_parity(data + 16);
6016 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006017}
David Brown7807bf72021-02-09 16:28:23 -07006018#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006019
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006020/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 * ECC keys on a Weierstrass elliptic curve require the generation
6022 * of a private key which is an integer
6023 * in the range [1, N - 1], where N is the boundary of the private key domain:
6024 * N is the prime p for Diffie-Hellman, or the order of the
6025 * curve’s base point for ECC.
6026 *
6027 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6028 * This function generates the private key using the following process:
6029 *
6030 * 1. Draw a byte string of length ceiling(m/8) bytes.
6031 * 2. If m is not a multiple of 8, set the most significant
6032 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6033 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6034 * 4. If k > N - 2, discard the result and return to step 1.
6035 * 5. Output k + 1 as the private key.
6036 *
6037 * This method allows compliance to NIST standards, specifically the methods titled
6038 * Key-Pair Generation by Testing Candidates in the following publications:
6039 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6040 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6041 * Diffie-Hellman keys.
6042 *
6043 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6044 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6045 *
6046 * Note: Function allocates memory for *data buffer, so given *data should be
6047 * always NULL.
6048 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006049#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6050#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006051static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006052 psa_key_slot_t *slot,
6053 size_t bits,
6054 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006055 uint8_t **data
6056 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006057{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006058 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006059 mbedtls_mpi k;
6060 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006061 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006062 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006063 size_t m;
6064 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006065
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 mbedtls_mpi_init(&k);
6067 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006068
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006069 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006071 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006073
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006075 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006076 goto cleanup;
6077 }
6078
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006079 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006081
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006083
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006084 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006085 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006086 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006087
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006088 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006089
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006090 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006092
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006093 /* Note: This function is always called with *data == NULL and it
6094 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 *data = mbedtls_calloc(1, m_bytes);
6096 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006097 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006098 goto cleanup;
6099 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006100
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006102 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006104 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006106
6107 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006109 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006110 * (8 * ceiling(m/8) - m) bits of the first byte in
6111 * the string to zero.
6112 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006114 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006115 }
6116
6117 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 * big-endian byte string.
6119 */
6120 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006121
6122 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 * Result of comparison is returned. When it indicates error
6124 * then this function is called again.
6125 */
6126 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006127 }
6128
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006129 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6131 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006132cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 if (ret != 0) {
6134 status = mbedtls_to_psa_error(ret);
6135 }
6136 if (status != PSA_SUCCESS) {
6137 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006138 *data = NULL;
6139 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006140 mbedtls_mpi_free(&k);
6141 mbedtls_mpi_free(&diff_N_2);
6142 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006143}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006144
6145/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6146 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6147 *
6148 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6149 * draw a 32-byte string and process it as specified in
6150 * Elliptic Curves for Security [RFC7748] §5.
6151 *
6152 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6153 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6154 *
6155 * Note: Function allocates memory for *data buffer, so given *data should be
6156 * always NULL.
6157 */
6158
6159static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6160 size_t bits,
6161 psa_key_derivation_operation_t *operation,
6162 uint8_t **data
6163 )
6164{
6165 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006166 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006167
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006169 case 255:
6170 output_length = 32;
6171 break;
6172 case 448:
6173 output_length = 56;
6174 break;
6175 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006177 break;
6178 }
6179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006181
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 if (*data == NULL) {
6183 return PSA_ERROR_INSUFFICIENT_MEMORY;
6184 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006185
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006187
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006189 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006191
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006193 case 255:
6194 (*data)[0] &= 248;
6195 (*data)[31] &= 127;
6196 (*data)[31] |= 64;
6197 break;
6198 case 448:
6199 (*data)[0] &= 252;
6200 (*data)[55] |= 128;
6201 break;
6202 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006204 break;
6205 }
6206
6207 return status;
6208}
Valerio Setti86587ab2023-06-27 13:09:30 +02006209#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6210static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6211 psa_key_slot_t *slot, size_t bits,
6212 psa_key_derivation_operation_t *operation, uint8_t **data)
6213{
6214 (void) slot;
6215 (void) bits;
6216 (void) operation;
6217 (void) data;
6218 return PSA_ERROR_NOT_SUPPORTED;
6219}
6220
6221static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6222 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6223{
6224 (void) bits;
6225 (void) operation;
6226 (void) data;
6227 return PSA_ERROR_NOT_SUPPORTED;
6228}
6229#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6230#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006231
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006232static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006233 psa_key_slot_t *slot,
6234 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006236{
6237 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306239 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006240 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006241 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006242
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6244 return PSA_ERROR_INVALID_ARGUMENT;
6245 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006246
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006247#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006248 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6250 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6251 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006252 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6254 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006255 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 }
6257 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006258 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6260 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006261 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006263 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006264 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006265#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006266 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 if (key_type_is_raw_bytes(slot->attr.type)) {
6268 if (bits % 8 != 0) {
6269 return PSA_ERROR_INVALID_ARGUMENT;
6270 }
6271 data = mbedtls_calloc(1, bytes);
6272 if (data == NULL) {
6273 return PSA_ERROR_INSUFFICIENT_MEMORY;
6274 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006275
Gilles Peskine449bd832023-01-11 14:50:10 +01006276 status = psa_key_derivation_output_bytes(operation, data, bytes);
6277 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006278 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 }
David Brown12ca5032021-02-11 11:02:00 -07006280#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6282 psa_des_set_key_parity(data, bytes);
6283 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006284#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 } else {
6286 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006287 }
Ronald Crondd04d422020-11-28 15:14:42 +01006288
Ronald Cronbf33c932020-11-28 18:06:53 +01006289 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006290 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006292 };
6293
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6295 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6296 &storage_size);
6297 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306298 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 }
Archanad8a83dc2021-06-14 10:04:16 +05306300 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 status = psa_allocate_buffer_to_slot(slot, storage_size);
6302 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306303 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 }
Archanad8a83dc2021-06-14 10:04:16 +05306305
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 status = psa_driver_wrapper_import_key(&attributes,
6307 data, bytes,
6308 slot->key.data,
6309 slot->key.bytes,
6310 &slot->key.bytes, &bits);
6311 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006312 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006314
6315exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 mbedtls_free(data);
6317 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006318}
6319
Gilles Peskine449bd832023-01-11 14:50:10 +01006320psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6321 psa_key_derivation_operation_t *operation,
6322 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006323{
6324 psa_status_t status;
6325 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006326 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006327
Ronald Cron81709fc2020-11-14 12:10:32 +01006328 *key = MBEDTLS_SVC_KEY_ID_INIT;
6329
Gilles Peskine0f84d622019-09-12 19:03:13 +02006330 /* Reject any attempt to create a zero-length key so that we don't
6331 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 if (psa_get_key_bits(attributes) == 0) {
6333 return PSA_ERROR_INVALID_ARGUMENT;
6334 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006335
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 if (operation->alg == PSA_ALG_NONE) {
6337 return PSA_ERROR_BAD_STATE;
6338 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006339
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 if (!operation->can_output_key) {
6341 return PSA_ERROR_NOT_PERMITTED;
6342 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006343
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6345 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006346#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006348 /* Deriving a key in a secure element is not implemented yet. */
6349 status = PSA_ERROR_NOT_SUPPORTED;
6350 }
6351#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006352 if (status == PSA_SUCCESS) {
6353 status = psa_generate_derived_key_internal(slot,
6354 attributes->core.bits,
6355 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006356 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 if (status == PSA_SUCCESS) {
6358 status = psa_finish_key_creation(slot, driver, key);
6359 }
6360 if (status != PSA_SUCCESS) {
6361 psa_fail_key_creation(slot, driver);
6362 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006363
Gilles Peskine449bd832023-01-11 14:50:10 +01006364 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006365}
6366
Gilles Peskineeab56e42018-07-12 17:12:33 +02006367
6368
6369/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006370/* Key derivation */
6371/****************************************************************/
6372
Steven Cooreman932ffb72021-02-15 12:14:32 +01006373#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006374static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006375{
6376#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6378 return 1;
6379 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006380#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006381#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6383 return 1;
6384 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006385#endif
6386#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6388 return 1;
6389 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006390#endif
6391#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6393 return 1;
6394 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006395#endif
6396#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6398 return 1;
6399 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006400#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006401#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6403 return 1;
6404 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006405#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306406#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6407 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6408 return 1;
6409 }
6410#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306411#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6412 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6413 return 1;
6414 }
6415#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006416 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006417}
6418
Gilles Peskine449bd832023-01-11 14:50:10 +01006419static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006420{
6421 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 psa_status_t status = psa_hash_setup(&operation, alg);
6423 psa_hash_abort(&operation);
6424 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006425}
6426
Gilles Peskine969c5d62019-01-16 15:53:06 +01006427static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006428 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006429 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006430{
Janos Follath5fe19732019-06-20 15:09:30 +01006431 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6432 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006434
Gilles Peskine969c5d62019-01-16 15:53:06 +01006435 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 if (!is_kdf_alg_supported(kdf_alg)) {
6437 return PSA_ERROR_NOT_SUPPORTED;
6438 }
John Durkop07cc04a2020-11-16 22:08:34 -08006439
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006440 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306441 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6443 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306444 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6445 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6446 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306447 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306448 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 if (hash_size == 0) {
6450 return PSA_ERROR_NOT_SUPPORTED;
6451 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006452
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006453 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6454 * we might fail later, which is somewhat unfriendly and potentially
6455 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 psa_status_t status = psa_hash_try_support(hash_alg);
6457 if (status != PSA_SUCCESS) {
6458 return status;
6459 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006460 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006461
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6463 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6464 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6465 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006466 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006467#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006468 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006469 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6470 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006471 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006473#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6474 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 operation->capacity = 255 * hash_size;
6476 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006477}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006478
Gilles Peskine449bd832023-01-11 14:50:10 +01006479static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006480{
6481#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 if (alg == PSA_ALG_ECDH) {
6483 return PSA_SUCCESS;
6484 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006485#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006486#if defined(PSA_WANT_ALG_FFDH)
6487 if (alg == PSA_ALG_FFDH) {
6488 return PSA_SUCCESS;
6489 }
6490#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006491 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006492 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006493}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006494
6495static int psa_key_derivation_allows_free_form_secret_input(
6496 psa_algorithm_t kdf_alg)
6497{
6498#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6499 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6500 return 0;
6501 }
6502#endif
6503 (void) kdf_alg;
6504 return 1;
6505}
John Durkop07cc04a2020-11-16 22:08:34 -08006506#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006507
Gilles Peskine449bd832023-01-11 14:50:10 +01006508psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6509 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006510{
6511 psa_status_t status;
6512
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 if (operation->alg != 0) {
6514 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006515 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006516
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6518 return PSA_ERROR_INVALID_ARGUMENT;
6519 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6520#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6521 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6522 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6523 status = psa_key_agreement_try_support(ka_alg);
6524 if (status != PSA_SUCCESS) {
6525 return status;
6526 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006527 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6528 return PSA_ERROR_INVALID_ARGUMENT;
6529 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6531#else
6532 return PSA_ERROR_NOT_SUPPORTED;
6533#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6534 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6535#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6536 status = psa_key_derivation_setup_kdf(operation, alg);
6537#else
6538 return PSA_ERROR_NOT_SUPPORTED;
6539#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6540 } else {
6541 return PSA_ERROR_INVALID_ARGUMENT;
6542 }
6543
6544 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006545 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 }
6547 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006548}
6549
Przemek Stekiel69c46792022-06-10 12:59:51 +02006550#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006551static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6552 psa_algorithm_t kdf_alg,
6553 psa_key_derivation_step_t step,
6554 const uint8_t *data,
6555 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006556{
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006558 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006560 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006561#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6563 return PSA_ERROR_INVALID_ARGUMENT;
6564 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006565#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 if (hkdf->state != HKDF_STATE_INIT) {
6567 return PSA_ERROR_BAD_STATE;
6568 } else {
6569 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6570 hash_alg,
6571 data, data_length);
6572 if (status != PSA_SUCCESS) {
6573 return status;
6574 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006575 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006577 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006578 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006579#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006581 /* We shouldn't be in different state as HKDF_EXPAND only allows
6582 * two inputs: SECRET (this case) and INFO which does not modify
6583 * the state. It could happen only if the hkdf
6584 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 if (hkdf->state != HKDF_STATE_INIT) {
6586 return PSA_ERROR_BAD_STATE;
6587 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006588
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006589 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6591 return PSA_ERROR_INVALID_ARGUMENT;
6592 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006593
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 memcpy(hkdf->prk, data, data_length);
6595 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006596#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006597 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006598 /* HKDF: If no salt was provided, use an empty salt.
6599 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006601#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006602 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6603 return PSA_ERROR_BAD_STATE;
6604 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006605#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6607 hash_alg,
6608 NULL, 0);
6609 if (status != PSA_SUCCESS) {
6610 return status;
6611 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006612 hkdf->state = HKDF_STATE_STARTED;
6613 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 if (hkdf->state != HKDF_STATE_STARTED) {
6615 return PSA_ERROR_BAD_STATE;
6616 }
6617 status = psa_mac_update(&hkdf->hmac,
6618 data, data_length);
6619 if (status != PSA_SUCCESS) {
6620 return status;
6621 }
6622 status = psa_mac_sign_finish(&hkdf->hmac,
6623 hkdf->prk,
6624 sizeof(hkdf->prk),
6625 &data_length);
6626 if (status != PSA_SUCCESS) {
6627 return status;
6628 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006629 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006630
Gilles Peskine2b522db2019-04-12 15:11:49 +02006631 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006632 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006633#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006635 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006637 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006639#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006640 {
6641 /* Block 0 is empty, and the next block will be
6642 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006644 }
6645
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006647 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006648#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6650 return PSA_ERROR_INVALID_ARGUMENT;
6651 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006652#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006653#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6655 hkdf->state == HKDF_STATE_INIT) {
6656 return PSA_ERROR_BAD_STATE;
6657 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006658#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 if (hkdf->state == HKDF_STATE_OUTPUT) {
6660 return PSA_ERROR_BAD_STATE;
6661 }
6662 if (hkdf->info_set) {
6663 return PSA_ERROR_BAD_STATE;
6664 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006665 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006666 if (data_length != 0) {
6667 hkdf->info = mbedtls_calloc(1, data_length);
6668 if (hkdf->info == NULL) {
6669 return PSA_ERROR_INSUFFICIENT_MEMORY;
6670 }
6671 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006672 }
6673 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006675 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006676 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006677 }
6678}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006679#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006680
John Durkop07cc04a2020-11-16 22:08:34 -08006681#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6682 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006683static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6684 const uint8_t *data,
6685 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006686{
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6688 return PSA_ERROR_BAD_STATE;
6689 }
Janos Follathf08e2652019-06-13 09:05:41 +01006690
Gilles Peskine449bd832023-01-11 14:50:10 +01006691 if (data_length != 0) {
6692 prf->seed = mbedtls_calloc(1, data_length);
6693 if (prf->seed == NULL) {
6694 return PSA_ERROR_INSUFFICIENT_MEMORY;
6695 }
Janos Follathf08e2652019-06-13 09:05:41 +01006696
Gilles Peskine449bd832023-01-11 14:50:10 +01006697 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006698 prf->seed_length = data_length;
6699 }
Janos Follathf08e2652019-06-13 09:05:41 +01006700
Gilles Peskine43f958b2020-12-13 14:55:14 +01006701 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006702
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006704}
6705
Gilles Peskine449bd832023-01-11 14:50:10 +01006706static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6707 const uint8_t *data,
6708 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006709{
Gilles Peskine449bd832023-01-11 14:50:10 +01006710 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6711 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6712 return PSA_ERROR_BAD_STATE;
6713 }
Janos Follath81550542019-06-13 14:26:34 +01006714
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 if (data_length != 0) {
6716 prf->secret = mbedtls_calloc(1, data_length);
6717 if (prf->secret == NULL) {
6718 return PSA_ERROR_INSUFFICIENT_MEMORY;
6719 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006720
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006722 prf->secret_length = data_length;
6723 }
Janos Follath81550542019-06-13 14:26:34 +01006724
Gilles Peskine43f958b2020-12-13 14:55:14 +01006725 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006726
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006728}
6729
Gilles Peskine449bd832023-01-11 14:50:10 +01006730static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6731 const uint8_t *data,
6732 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006733{
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6735 return PSA_ERROR_BAD_STATE;
6736 }
Janos Follath63028dd2019-06-13 09:15:47 +01006737
Gilles Peskine449bd832023-01-11 14:50:10 +01006738 if (data_length != 0) {
6739 prf->label = mbedtls_calloc(1, data_length);
6740 if (prf->label == NULL) {
6741 return PSA_ERROR_INSUFFICIENT_MEMORY;
6742 }
Janos Follath63028dd2019-06-13 09:15:47 +01006743
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006745 prf->label_length = data_length;
6746 }
Janos Follath63028dd2019-06-13 09:15:47 +01006747
Gilles Peskine43f958b2020-12-13 14:55:14 +01006748 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006749
Gilles Peskine449bd832023-01-11 14:50:10 +01006750 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006751}
6752
Gilles Peskine449bd832023-01-11 14:50:10 +01006753static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6754 psa_key_derivation_step_t step,
6755 const uint8_t *data,
6756 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006757{
Gilles Peskine449bd832023-01-11 14:50:10 +01006758 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006759 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006761 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006763 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006765 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006767 }
6768}
John Durkop07cc04a2020-11-16 22:08:34 -08006769#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6770 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6771
6772#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6773static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6774 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006775 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006777{
6778 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6780 4 + data_length + prf->other_secret_length :
6781 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006782
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6784 return PSA_ERROR_INVALID_ARGUMENT;
6785 }
John Durkop07cc04a2020-11-16 22:08:34 -08006786
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 uint8_t *pms = mbedtls_calloc(1, pms_len);
6788 if (pms == NULL) {
6789 return PSA_ERROR_INSUFFICIENT_MEMORY;
6790 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006791 uint8_t *cur = pms;
6792
6793 /* pure-PSK:
6794 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006795 *
6796 * The premaster secret is formed as follows: if the PSK is N octets
6797 * long, concatenate a uint16 with the value N, N zero octets, a second
6798 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006799 *
6800 * mixed-PSK:
6801 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6802 * follows: concatenate a uint16 with the length of the other secret,
6803 * the other secret itself, uint16 with the length of PSK, and the
6804 * PSK itself.
6805 * For details please check:
6806 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6807 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6808 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006809 */
6810
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6812 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6813 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6814 if (prf->other_secret_length != 0) {
6815 memcpy(cur, prf->other_secret, prf->other_secret_length);
6816 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006817 cur += prf->other_secret_length;
6818 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 } else {
6820 *cur++ = MBEDTLS_BYTE_1(data_length);
6821 *cur++ = MBEDTLS_BYTE_0(data_length);
6822 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006823 cur += data_length;
6824 }
6825
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 *cur++ = MBEDTLS_BYTE_1(data_length);
6827 *cur++ = MBEDTLS_BYTE_0(data_length);
6828 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006829 cur += data_length;
6830
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006831 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006832
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006833 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006834 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006835}
Janos Follath6660f0e2019-06-17 08:44:03 +01006836
Przemek Stekiele47201b2022-04-19 13:53:28 +02006837static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6838 psa_tls12_prf_key_derivation_t *prf,
6839 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006841{
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6843 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006844 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006845
6846 if (data_length != 0) {
6847 prf->other_secret = mbedtls_calloc(1, data_length);
6848 if (prf->other_secret == NULL) {
6849 return PSA_ERROR_INSUFFICIENT_MEMORY;
6850 }
6851
6852 memcpy(prf->other_secret, data, data_length);
6853 prf->other_secret_length = data_length;
6854 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006855 prf->other_secret_length = 0;
6856 }
6857
6858 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6859
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006861}
6862
Janos Follath6660f0e2019-06-17 08:44:03 +01006863static psa_status_t psa_tls12_prf_psk_to_ms_input(
6864 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006865 psa_key_derivation_step_t step,
6866 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006868{
Gilles Peskine449bd832023-01-11 14:50:10 +01006869 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006870 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 return psa_tls12_prf_psk_to_ms_set_key(prf,
6872 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006873 break;
6874 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6876 data,
6877 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006878 break;
6879 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006881 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006882
Przemek Stekiele47201b2022-04-19 13:53:28 +02006883 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006884}
John Durkop07cc04a2020-11-16 22:08:34 -08006885#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006886
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006887#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6888static psa_status_t psa_tls12_ecjpake_to_pms_input(
6889 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006890 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006891 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006893{
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6895 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6896 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006897 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006898
6899 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 if (data[0] != 0x04) {
6901 return PSA_ERROR_INVALID_ARGUMENT;
6902 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006903
6904 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006906
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006908}
6909#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306910
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306911#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306912static psa_status_t psa_pbkdf2_set_input_cost(
6913 psa_pbkdf2_key_derivation_t *pbkdf2,
6914 psa_key_derivation_step_t step,
6915 uint64_t data)
6916{
6917 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6918 return PSA_ERROR_INVALID_ARGUMENT;
6919 }
6920
6921 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6922 return PSA_ERROR_BAD_STATE;
6923 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306924
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306925 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306926 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306927 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306928
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306929 if (data == 0) {
6930 return PSA_ERROR_INVALID_ARGUMENT;
6931 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306932
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306933 pbkdf2->input_cost = data;
6934 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6935
6936 return PSA_SUCCESS;
6937}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306938
6939static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6940 const uint8_t *data,
6941 size_t data_length)
6942{
Gilles Peskineead17662023-08-20 22:02:51 +02006943 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6944 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6945 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6946 /* Appending to existing salt. No state change. */
6947 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306948 return PSA_ERROR_BAD_STATE;
6949 }
6950
Gilles Peskineca57d782023-07-20 19:08:06 +02006951 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006952 /* Appending an empty string, nothing to do. */
6953 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306954 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306955
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306956 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6957 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306958 return PSA_ERROR_INSUFFICIENT_MEMORY;
6959 }
6960
Gilles Peskineead17662023-08-20 22:02:51 +02006961 if (pbkdf2->salt_length != 0) {
6962 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6963 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306964 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306965 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306966 mbedtls_free(pbkdf2->salt);
6967 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306968 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306969 return PSA_SUCCESS;
6970}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306971
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306972#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306973static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306974 const uint8_t *input,
6975 size_t input_len,
6976 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306977 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306978{
6979 psa_status_t status = PSA_SUCCESS;
6980 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6981 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306982 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306983 } else {
6984 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306985 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306986 }
6987 return status;
6988}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306989#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306990
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306991#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306992static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6993 size_t input_len,
6994 uint8_t *output,
6995 size_t *output_len)
6996{
6997 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306998 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306999 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05307000 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307001 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
7002 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
7003 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307004 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05307005 * mac_size as the driver function sets mac_output_length = mac_size
7006 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307007 status = psa_driver_wrapper_mac_compute(&attributes,
7008 zeros, sizeof(zeros),
7009 PSA_ALG_CMAC, input, input_len,
7010 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307011 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7012 128U,
7013 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307014 output_len);
7015 } else {
7016 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307017 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307018 }
7019 return status;
7020}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307021#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307022
7023static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307024 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307025 const uint8_t *data,
7026 size_t data_length)
7027{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307028 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307029 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7030 return PSA_ERROR_BAD_STATE;
7031 }
7032
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307033#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307034 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7035 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7036 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7037 pbkdf2->password,
7038 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307039 } else
7040#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7041#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7042 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307043 status = psa_pbkdf2_cmac_set_password(data, data_length,
7044 pbkdf2->password,
7045 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307046 } else
7047#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7048 {
7049 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307050 }
7051
7052 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7053
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307054 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307055}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307056
7057static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307058 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307059 psa_key_derivation_step_t step,
7060 const uint8_t *data,
7061 size_t data_length)
7062{
7063 switch (step) {
7064 case PSA_KEY_DERIVATION_INPUT_SALT:
7065 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7066 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307067 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307068 default:
7069 return PSA_ERROR_INVALID_ARGUMENT;
7070 }
7071}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307072#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307073
Gilles Peskineb8965192019-09-24 16:21:10 +02007074/** Check whether the given key type is acceptable for the given
7075 * input step of a key derivation.
7076 *
7077 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7078 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7079 * Both secret and non-secret inputs can alternatively have the type
7080 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7081 * that the input was passed as a buffer rather than via a key object.
7082 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007083static int psa_key_derivation_check_input_type(
7084 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007086{
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007088 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 if (key_type == PSA_KEY_TYPE_DERIVE) {
7090 return PSA_SUCCESS;
7091 }
7092 if (key_type == PSA_KEY_TYPE_NONE) {
7093 return PSA_SUCCESS;
7094 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007095 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007096 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 if (key_type == PSA_KEY_TYPE_DERIVE) {
7098 return PSA_SUCCESS;
7099 }
7100 if (key_type == PSA_KEY_TYPE_NONE) {
7101 return PSA_SUCCESS;
7102 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007103 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007104 case PSA_KEY_DERIVATION_INPUT_LABEL:
7105 case PSA_KEY_DERIVATION_INPUT_SALT:
7106 case PSA_KEY_DERIVATION_INPUT_INFO:
7107 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7109 return PSA_SUCCESS;
7110 }
7111 if (key_type == PSA_KEY_TYPE_NONE) {
7112 return PSA_SUCCESS;
7113 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007114 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307115 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7116 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7117 return PSA_SUCCESS;
7118 }
7119 if (key_type == PSA_KEY_TYPE_DERIVE) {
7120 return PSA_SUCCESS;
7121 }
7122 if (key_type == PSA_KEY_TYPE_NONE) {
7123 return PSA_SUCCESS;
7124 }
7125 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007126 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007128}
7129
Janos Follathb80a94e2019-06-12 15:54:46 +01007130static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007131 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007132 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007133 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007134 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007136{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007137 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007139
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 status = psa_key_derivation_check_input_type(step, key_type);
7141 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007142 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007144
Przemek Stekiel69c46792022-06-10 12:59:51 +02007145#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7147 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7148 step, data, data_length);
7149 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007150#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007151#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7153 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7154 step, data, data_length);
7155 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007156#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7157#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7159 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7160 step, data, data_length);
7161 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007162#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007163#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007165 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7167 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007168#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307169#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307170 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307171 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7172 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307173 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307174#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007175 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007176 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007177 (void) data;
7178 (void) data_length;
7179 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007181 }
7182
Gilles Peskine224b0d62019-09-23 18:13:17 +02007183exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007184 if (status != PSA_SUCCESS) {
7185 psa_key_derivation_abort(operation);
7186 }
7187 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007188}
7189
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307190static psa_status_t psa_key_derivation_input_integer_internal(
7191 psa_key_derivation_operation_t *operation,
7192 psa_key_derivation_step_t step,
7193 uint64_t value)
7194{
7195 psa_status_t status;
7196 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7197
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307198#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307199 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307200 status = psa_pbkdf2_set_input_cost(
7201 &operation->ctx.pbkdf2, step, value);
7202 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307203#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307204 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307205 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307206 (void) value;
7207 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307208 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307209 }
7210
7211 if (status != PSA_SUCCESS) {
7212 psa_key_derivation_abort(operation);
7213 }
7214 return status;
7215}
7216
Janos Follath51f4a0f2019-06-14 11:35:55 +01007217psa_status_t psa_key_derivation_input_bytes(
7218 psa_key_derivation_operation_t *operation,
7219 psa_key_derivation_step_t step,
7220 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007221 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007222{
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 return psa_key_derivation_input_internal(operation, step,
7224 PSA_KEY_TYPE_NONE,
7225 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007226}
7227
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307228psa_status_t psa_key_derivation_input_integer(
7229 psa_key_derivation_operation_t *operation,
7230 psa_key_derivation_step_t step,
7231 uint64_t value)
7232{
7233 return psa_key_derivation_input_integer_internal(operation, step, value);
7234}
7235
Janos Follath51f4a0f2019-06-14 11:35:55 +01007236psa_status_t psa_key_derivation_input_key(
7237 psa_key_derivation_operation_t *operation,
7238 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007240{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007241 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007242 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007243 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007244
Ronald Cron5c522922020-11-14 16:35:34 +01007245 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007246 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7247 if (status != PSA_SUCCESS) {
7248 psa_key_derivation_abort(operation);
7249 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007250 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007251
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307252 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7253 * permission to output to a key object. */
7254 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7255 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007256 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007258
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 status = psa_key_derivation_input_internal(operation,
7260 step, slot->attr.type,
7261 slot->key.data,
7262 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007263
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007265
Gilles Peskine449bd832023-01-11 14:50:10 +01007266 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007267}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007268
7269
7270
7271/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007272/* Key agreement */
7273/****************************************************************/
7274
Gilles Peskine449bd832023-01-11 14:50:10 +01007275psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7276 const uint8_t *key_buffer,
7277 size_t key_buffer_size,
7278 psa_algorithm_t alg,
7279 const uint8_t *peer_key,
7280 size_t peer_key_length,
7281 uint8_t *shared_secret,
7282 size_t shared_secret_size,
7283 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007284{
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007286#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007287 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007288 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7289 key_buffer_size, alg,
7290 peer_key, peer_key_length,
7291 shared_secret,
7292 shared_secret_size,
7293 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007294#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007295
7296#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7297 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007298 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007299 peer_key,
7300 peer_key_length,
7301 key_buffer,
7302 key_buffer_size,
7303 shared_secret,
7304 shared_secret_size,
7305 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007306#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7307
Gilles Peskine01d718c2018-09-18 12:01:02 +02007308 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007309 (void) attributes;
7310 (void) key_buffer;
7311 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007312 (void) peer_key;
7313 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007314 (void) shared_secret;
7315 (void) shared_secret_size;
7316 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007318 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007319}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007320
Aditya Deshpande17845b82022-10-13 17:21:01 +01007321/** Internal function for raw key agreement
7322 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007323 * to the driver's implementation if a driver is present.
7324 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007325 * (psa_key_agreement_raw_builtin).
7326 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007327static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7328 psa_key_slot_t *private_key,
7329 const uint8_t *peer_key,
7330 size_t peer_key_length,
7331 uint8_t *shared_secret,
7332 size_t shared_secret_size,
7333 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007334{
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7336 return PSA_ERROR_NOT_SUPPORTED;
7337 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007338
7339 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007341 };
7342
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 return psa_driver_wrapper_key_agreement(&attributes,
7344 private_key->key.data,
7345 private_key->key.bytes, alg,
7346 peer_key, peer_key_length,
7347 shared_secret,
7348 shared_secret_size,
7349 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007350}
7351
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007352/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007353 * to potentially free embedded data structures and wipe confidential data.
7354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007355static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7356 psa_key_derivation_step_t step,
7357 psa_key_slot_t *private_key,
7358 const uint8_t *peer_key,
7359 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007360{
7361 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007362 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007363 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007365
7366 /* Step 1: run the secret agreement algorithm to generate the shared
7367 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 status = psa_key_agreement_raw_internal(ka_alg,
7369 private_key,
7370 peer_key, peer_key_length,
7371 shared_secret,
7372 sizeof(shared_secret),
7373 &shared_secret_length);
7374 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007375 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007377
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007378 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007379 * the shared secret. A shared secret is permitted wherever a key
7380 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 status = psa_key_derivation_input_internal(operation, step,
7382 PSA_KEY_TYPE_DERIVE,
7383 shared_secret,
7384 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007385exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7387 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007388}
7389
Gilles Peskine449bd832023-01-11 14:50:10 +01007390psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7391 psa_key_derivation_step_t step,
7392 mbedtls_svc_key_id_t private_key,
7393 const uint8_t *peer_key,
7394 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007395{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007396 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007397 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007398 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007399
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7401 return PSA_ERROR_INVALID_ARGUMENT;
7402 }
Ronald Cron5c522922020-11-14 16:35:34 +01007403 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7405 if (status != PSA_SUCCESS) {
7406 return status;
7407 }
7408 status = psa_key_agreement_internal(operation, step,
7409 slot,
7410 peer_key, peer_key_length);
7411 if (status != PSA_SUCCESS) {
7412 psa_key_derivation_abort(operation);
7413 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007414 /* If a private key has been added as SECRET, we allow the derived
7415 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007417 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007419 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007420
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007422
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007424}
7425
Gilles Peskine449bd832023-01-11 14:50:10 +01007426psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7427 mbedtls_svc_key_id_t private_key,
7428 const uint8_t *peer_key,
7429 size_t peer_key_length,
7430 uint8_t *output,
7431 size_t output_size,
7432 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007433{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007434 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007435 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007436 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007437 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007438
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007440 status = PSA_ERROR_INVALID_ARGUMENT;
7441 goto exit;
7442 }
Ronald Cron5c522922020-11-14 16:35:34 +01007443 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7445 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007446 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007448
Gilles Peskine3e561302022-04-14 00:17:15 +02007449 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7450 * for the output size. The PSA specification only guarantees that this
7451 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7452 * but it might be nice to allow smaller buffers if the output fits.
7453 * At the time of writing this comment, with only ECDH implemented,
7454 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7455 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7456 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007457 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7459 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007460 status = PSA_ERROR_BUFFER_TOO_SMALL;
7461 goto exit;
7462 }
7463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 status = psa_key_agreement_raw_internal(alg, slot,
7465 peer_key, peer_key_length,
7466 output, output_size,
7467 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007468
7469exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007471 /* If an error happens and is not handled properly, the output
7472 * may be used as a key to protect sensitive data. Arrange for such
7473 * a key to be random, which is likely to result in decryption or
7474 * verification errors. This is better than filling the buffer with
7475 * some constant data such as zeros, which would result in the data
7476 * being protected with a reproducible, easily knowable key.
7477 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007479 *output_length = output_size;
7480 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007481
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007483
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007485}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007486
7487
Gilles Peskine30524eb2020-11-13 17:02:26 +01007488
Gilles Peskine86a440b2018-11-12 18:39:40 +01007489/****************************************************************/
7490/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007491/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007492
Gilles Peskine672a7712023-04-28 21:00:28 +02007493#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7494#include "entropy_poll.h"
7495#endif
7496
Gilles Peskine30524eb2020-11-13 17:02:26 +01007497/** Initialize the PSA random generator.
7498 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007499static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007500{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007501#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007503#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7504
Gilles Peskine30524eb2020-11-13 17:02:26 +01007505 /* Set default configuration if
7506 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007508 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 }
7510 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007511 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007513
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007515#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7516 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7517 /* The PSA entropy injection feature depends on using NV seed as an entropy
7518 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007519 mbedtls_entropy_add_source(&rng->entropy,
7520 mbedtls_nv_seed_poll, NULL,
7521 MBEDTLS_ENTROPY_BLOCK_SIZE,
7522 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007523#endif
7524
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007526#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007527}
7528
7529/** Deinitialize the PSA random generator.
7530 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007531static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007532{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007533#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007535#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7537 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007538#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007539}
7540
7541/** Seed the PSA random generator.
7542 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007543static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007544{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007545#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7546 /* Do nothing: the external RNG seeds itself. */
7547 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007549#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007550 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7552 drbg_seed, sizeof(drbg_seed) - 1);
7553 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007554#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007555}
7556
Gilles Peskine449bd832023-01-11 14:50:10 +01007557psa_status_t psa_generate_random(uint8_t *output,
7558 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007559{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007560 GUARD_MODULE_INITIALIZED;
7561
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007562#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7563
7564 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7566 output, output_size,
7567 &output_length);
7568 if (status != PSA_SUCCESS) {
7569 return status;
7570 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007571 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007572 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 if (output_length != output_size) {
7574 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7575 }
7576 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007577
7578#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007581 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7583 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7584 output_size);
7585 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7586 output, request_size);
7587 if (ret != 0) {
7588 return mbedtls_to_psa_error(ret);
7589 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007590 output_size -= request_size;
7591 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007592 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007594#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007595}
7596
Gilles Peskine8814fc42020-12-14 15:33:44 +01007597/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007598 *
7599 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7600 * `psa_generate_random(...)`. The state parameter is ignored since the
7601 * PSA API doesn't support passing an explicit state.
7602 *
7603 * In the non-external case, psa_generate_random() calls an
7604 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7605 * and semantics as mbedtls_psa_get_random(). As an optimization,
7606 * instead of doing this back-and-forth between the PSA API and the
7607 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7608 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007609 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007610#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7611int mbedtls_psa_get_random(void *p_rng,
7612 unsigned char *output,
7613 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007614{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007615 /* This function takes a pointer to the RNG state because that's what
7616 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7617 * its own state internally and doesn't let the caller access that state.
7618 * So we just ignore the state parameter, and in practice we'll pass
7619 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007620 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 psa_status_t status = psa_generate_random(output, output_size);
7622 if (status == PSA_SUCCESS) {
7623 return 0;
7624 } else {
7625 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7626 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007627}
7628#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7629
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007630#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007631psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7632 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007633{
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 if (global_data.initialized) {
7635 return PSA_ERROR_NOT_PERMITTED;
7636 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007637
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7639 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7640 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7641 return PSA_ERROR_INVALID_ARGUMENT;
7642 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007643
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007645}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007646#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007647
Ronald Cron3772afe2021-02-08 16:10:05 +01007648/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007649 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007650 * \param type The key type
7651 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007652 *
7653 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007654 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007655 * \retval #PSA_ERROR_INVALID_ARGUMENT
7656 * The size in bits of the key is not valid.
7657 * \retval #PSA_ERROR_NOT_SUPPORTED
7658 * The type and/or the size in bits of the key or the combination of
7659 * the two is not supported.
7660 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007661static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007662 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007663{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007664 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007665
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 if (key_type_is_raw_bytes(type)) {
7667 status = psa_validate_unstructured_key_bit_size(type, bits);
7668 if (status != PSA_SUCCESS) {
7669 return status;
7670 }
7671 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007672#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007673 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7674 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7675 return PSA_ERROR_NOT_SUPPORTED;
7676 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007677 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007678 return PSA_ERROR_NOT_SUPPORTED;
7679 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007680
Ronald Cron01b2aba2020-10-05 09:42:02 +02007681 /* Accept only byte-aligned keys, for the same reasons as
7682 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 if (bits % 8 != 0) {
7684 return PSA_ERROR_NOT_SUPPORTED;
7685 }
7686 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007687#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007688
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007689#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007690 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007691 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 return PSA_SUCCESS;
7693 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007694#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007695
Valerio Settia55f0422023-07-10 15:34:41 +02007696#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007697 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007698 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007699 return PSA_ERROR_NOT_SUPPORTED;
7700 }
7701 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007702#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007703 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007705 }
7706
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007708}
7709
Ronald Cron55ed0592020-10-05 10:30:40 +02007710psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007711 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007713{
7714 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007715 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007716
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 if ((attributes->domain_parameters == NULL) &&
7718 (attributes->domain_parameters_size != 0)) {
7719 return PSA_ERROR_INVALID_ARGUMENT;
7720 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007721
Gilles Peskine449bd832023-01-11 14:50:10 +01007722 if (key_type_is_raw_bytes(type)) {
7723 status = psa_generate_random(key_buffer, key_buffer_size);
7724 if (status != PSA_SUCCESS) {
7725 return status;
7726 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007727
David Brown12ca5032021-02-11 11:02:00 -07007728#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 if (type == PSA_KEY_TYPE_DES) {
7730 psa_des_set_key_parity(key_buffer, key_buffer_size);
7731 }
David Brown8107e312021-02-12 08:08:46 -07007732#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007733 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007734
Valerio Setti76df8c12023-07-11 14:11:28 +02007735#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7737 return mbedtls_psa_rsa_generate_key(attributes,
7738 key_buffer,
7739 key_buffer_size,
7740 key_buffer_length);
7741 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007742#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007743
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007744#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7746 return mbedtls_psa_ecp_generate_key(attributes,
7747 key_buffer,
7748 key_buffer_size,
7749 key_buffer_length);
7750 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007751#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007752
Valerio Settia55f0422023-07-10 15:34:41 +02007753#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007754 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7755 return mbedtls_psa_ffdh_generate_key(attributes,
7756 key_buffer,
7757 key_buffer_size,
7758 key_buffer_length);
7759 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007760#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007761 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 (void) key_buffer_length;
7763 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007764 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007765
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007767}
Darryl Green0c6575a2018-11-07 16:05:30 +00007768
Gilles Peskine449bd832023-01-11 14:50:10 +01007769psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7770 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007771{
7772 psa_status_t status;
7773 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007774 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007775 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007776
Ronald Cron81709fc2020-11-14 12:10:32 +01007777 *key = MBEDTLS_SVC_KEY_ID_INIT;
7778
Gilles Peskine0f84d622019-09-12 19:03:13 +02007779 /* Reject any attempt to create a zero-length key so that we don't
7780 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 if (psa_get_key_bits(attributes) == 0) {
7782 return PSA_ERROR_INVALID_ARGUMENT;
7783 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007784
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007785 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7787 return PSA_ERROR_INVALID_ARGUMENT;
7788 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007789
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7791 &slot, &driver);
7792 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007793 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 }
Gilles Peskine11792082019-08-06 18:36:36 +02007795
Ronald Cron977c2472020-10-13 08:32:21 +02007796 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307797 * storage ( thus not in the case of generating a key in a secure element
7798 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7799 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 if (slot->key.data == NULL) {
7801 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7802 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007803 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 attributes->core.type, attributes->core.bits);
7805 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007806 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007807 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007808
7809 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 attributes->core.type,
7811 attributes->core.bits);
7812 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007813 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 attributes, &key_buffer_size);
7815 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007816 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 }
Ronald Cron977c2472020-10-13 08:32:21 +02007818 }
Ronald Cron977c2472020-10-13 08:32:21 +02007819
Gilles Peskine449bd832023-01-11 14:50:10 +01007820 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7821 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007822 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007823 }
Ronald Cron977c2472020-10-13 08:32:21 +02007824 }
7825
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 status = psa_driver_wrapper_generate_key(attributes,
7827 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007828
Gilles Peskine449bd832023-01-11 14:50:10 +01007829 if (status != PSA_SUCCESS) {
7830 psa_remove_key_data_from_memory(slot);
7831 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007832
Gilles Peskine11792082019-08-06 18:36:36 +02007833exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007834 if (status == PSA_SUCCESS) {
7835 status = psa_finish_key_creation(slot, driver, key);
7836 }
7837 if (status != PSA_SUCCESS) {
7838 psa_fail_key_creation(slot, driver);
7839 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007840
Gilles Peskine449bd832023-01-11 14:50:10 +01007841 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007842}
7843
Gilles Peskinee59236f2018-01-27 23:32:46 +01007844/****************************************************************/
7845/* Module setup */
7846/****************************************************************/
7847
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007848#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007849psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007850 void (* entropy_init)(mbedtls_entropy_context *ctx),
7851 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007852{
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7854 return PSA_ERROR_BAD_STATE;
7855 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007856 global_data.rng.entropy_init = entropy_init;
7857 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007859}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007860#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007861
Gilles Peskine449bd832023-01-11 14:50:10 +01007862void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007863{
Gilles Peskine449bd832023-01-11 14:50:10 +01007864 psa_wipe_all_key_slots();
7865 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7866 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007867 }
7868 /* Wipe all remaining data, including configuration.
7869 * In particular, this sets all state indicator to the value
7870 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007872
7873 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007875}
7876
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007877#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7878/** Recover a transaction that was interrupted by a power failure.
7879 *
7880 * This function is called during initialization, before psa_crypto_init()
7881 * returns. If this function returns a failure status, the initialization
7882 * fails.
7883 */
7884static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007886{
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007888 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7889 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 /* TODO - fall through to the failure case until this
7891 * is implemented.
7892 * https://github.com/ARMmbed/mbed-crypto/issues/218
7893 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007894 default:
7895 /* We found an unsupported transaction in the storage.
7896 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007898 }
7899}
7900#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7901
Gilles Peskine449bd832023-01-11 14:50:10 +01007902psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007903{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007904 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007905
Gilles Peskinec6b69072018-11-20 21:42:52 +01007906 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 if (global_data.initialized != 0) {
7908 return PSA_SUCCESS;
7909 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007910
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007911 /* Init drivers */
7912 status = psa_driver_wrapper_init();
7913 if (status != PSA_SUCCESS) {
7914 goto exit;
7915 }
7916 global_data.drivers_initialized = 1;
7917
Gilles Peskine30524eb2020-11-13 17:02:26 +01007918 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007919 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007920 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 status = mbedtls_psa_random_seed(&global_data.rng);
7922 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007923 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007925 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007926
Gilles Peskine449bd832023-01-11 14:50:10 +01007927 status = psa_initialize_key_slots();
7928 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01007929 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007931
Gilles Peskine4b734222019-07-24 15:56:31 +02007932#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 status = psa_crypto_load_transaction();
7934 if (status == PSA_SUCCESS) {
7935 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7936 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007937 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 }
7939 status = psa_crypto_stop_transaction();
7940 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007941 /* There's no transaction to complete. It's all good. */
7942 status = PSA_SUCCESS;
7943 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007944#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007945
Gilles Peskinec6b69072018-11-20 21:42:52 +01007946 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007947 global_data.initialized = 1;
7948
7949exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007950 if (status != PSA_SUCCESS) {
7951 mbedtls_psa_crypto_free();
7952 }
7953 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007954}
7955
Yanray Wangffc3c482023-07-11 12:01:04 +08007956#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007957psa_status_t psa_crypto_driver_pake_get_password_len(
7958 const psa_crypto_driver_pake_inputs_t *inputs,
7959 size_t *password_len)
7960{
7961 if (inputs->password_len == 0) {
7962 return PSA_ERROR_BAD_STATE;
7963 }
7964
7965 *password_len = inputs->password_len;
7966
7967 return PSA_SUCCESS;
7968}
7969
7970psa_status_t psa_crypto_driver_pake_get_password(
7971 const psa_crypto_driver_pake_inputs_t *inputs,
7972 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7973{
7974 if (inputs->password_len == 0) {
7975 return PSA_ERROR_BAD_STATE;
7976 }
7977
7978 if (buffer_size < inputs->password_len) {
7979 return PSA_ERROR_BUFFER_TOO_SMALL;
7980 }
7981
7982 memcpy(buffer, inputs->password, inputs->password_len);
7983 *buffer_length = inputs->password_len;
7984
7985 return PSA_SUCCESS;
7986}
7987
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007988psa_status_t psa_crypto_driver_pake_get_user_len(
7989 const psa_crypto_driver_pake_inputs_t *inputs,
7990 size_t *user_len)
7991{
7992 if (inputs->user_len == 0) {
7993 return PSA_ERROR_BAD_STATE;
7994 }
7995
7996 *user_len = inputs->user_len;
7997
7998 return PSA_SUCCESS;
7999}
8000
8001psa_status_t psa_crypto_driver_pake_get_user(
8002 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008003 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008004{
8005 if (inputs->user_len == 0) {
8006 return PSA_ERROR_BAD_STATE;
8007 }
8008
Przemek Stekielc0e62502023-03-14 11:49:36 +01008009 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008010 return PSA_ERROR_BUFFER_TOO_SMALL;
8011 }
8012
Przemek Stekielc0e62502023-03-14 11:49:36 +01008013 memcpy(user_id, inputs->user, inputs->user_len);
8014 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008015
8016 return PSA_SUCCESS;
8017}
8018
8019psa_status_t psa_crypto_driver_pake_get_peer_len(
8020 const psa_crypto_driver_pake_inputs_t *inputs,
8021 size_t *peer_len)
8022{
8023 if (inputs->peer_len == 0) {
8024 return PSA_ERROR_BAD_STATE;
8025 }
8026
8027 *peer_len = inputs->peer_len;
8028
8029 return PSA_SUCCESS;
8030}
8031
8032psa_status_t psa_crypto_driver_pake_get_peer(
8033 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008034 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008035{
8036 if (inputs->peer_len == 0) {
8037 return PSA_ERROR_BAD_STATE;
8038 }
8039
Przemek Stekielc0e62502023-03-14 11:49:36 +01008040 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008041 return PSA_ERROR_BUFFER_TOO_SMALL;
8042 }
8043
Przemek Stekielc0e62502023-03-14 11:49:36 +01008044 memcpy(peer_id, inputs->peer, inputs->peer_len);
8045 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008046
8047 return PSA_SUCCESS;
8048}
8049
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008050psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8051 const psa_crypto_driver_pake_inputs_t *inputs,
8052 psa_pake_cipher_suite_t *cipher_suite)
8053{
8054 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8055 return PSA_ERROR_BAD_STATE;
8056 }
8057
8058 *cipher_suite = inputs->cipher_suite;
8059
8060 return PSA_SUCCESS;
8061}
8062
Neil Armstronga7d08c32022-06-01 18:21:20 +02008063psa_status_t psa_pake_setup(
8064 psa_pake_operation_t *operation,
8065 const psa_pake_cipher_suite_t *cipher_suite)
8066{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008067 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008068
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008069 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008070 status = PSA_ERROR_BAD_STATE;
8071 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008072 }
8073
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008074 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008075 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008076 status = PSA_ERROR_INVALID_ARGUMENT;
8077 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008078 }
8079
Przemek Stekiel51eac532022-12-07 11:04:51 +01008080 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8081
Przemek Stekiele12ed362022-12-21 12:54:46 +01008082 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008083 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8084 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008085 operation->data.inputs.cipher_suite = *cipher_suite;
8086
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008087#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008088 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008089 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008090 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008091
David Horstmann16f01512023-06-14 17:21:07 +01008092 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008093 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008094 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008095#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008096 {
8097 status = PSA_ERROR_NOT_SUPPORTED;
8098 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008099 }
8100
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008101 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8102
Przemek Stekiel51eac532022-12-07 11:04:51 +01008103 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008104exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008105 psa_pake_abort(operation);
8106 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008107}
8108
8109psa_status_t psa_pake_set_password_key(
8110 psa_pake_operation_t *operation,
8111 mbedtls_svc_key_id_t password)
8112{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008113 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008114 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8115 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008116 psa_key_attributes_t attributes;
8117 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008118
Przemek Stekiel51eac532022-12-07 11:04:51 +01008119 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008120 status = PSA_ERROR_BAD_STATE;
8121 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008122 }
8123
Przemek Stekiel6c764412022-11-22 14:05:12 +01008124 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8125 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008126 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008127 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008128 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008129 }
8130
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008131 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008132 .core = slot->attr
8133 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008134
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008135 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008136
Przemek Stekiel51eac532022-12-07 11:04:51 +01008137 if (type != PSA_KEY_TYPE_PASSWORD &&
8138 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8139 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008140 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008141 }
8142
Przemek Stekiel51eac532022-12-07 11:04:51 +01008143 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8144 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008145 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008146 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008147 }
8148
8149 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8150 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008151 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008152exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008153 if (status != PSA_SUCCESS) {
8154 psa_pake_abort(operation);
8155 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008156 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008157 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008158}
8159
8160psa_status_t psa_pake_set_user(
8161 psa_pake_operation_t *operation,
8162 const uint8_t *user_id,
8163 size_t user_id_len)
8164{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008165 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008166
8167 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008168 status = PSA_ERROR_BAD_STATE;
8169 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008170 }
8171
Przemek Stekiel51eac532022-12-07 11:04:51 +01008172 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008173 status = PSA_ERROR_INVALID_ARGUMENT;
8174 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008175 }
8176
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008177 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008178 status = PSA_ERROR_BAD_STATE;
8179 goto exit;
8180 }
8181
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008182 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8183 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008184 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8185 goto exit;
8186 }
8187
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008188 memcpy(operation->data.inputs.user, user_id, user_id_len);
8189 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008190
8191 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008192exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008193 psa_pake_abort(operation);
8194 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008195}
8196
8197psa_status_t psa_pake_set_peer(
8198 psa_pake_operation_t *operation,
8199 const uint8_t *peer_id,
8200 size_t peer_id_len)
8201{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008202 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008203
8204 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008205 status = PSA_ERROR_BAD_STATE;
8206 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008207 }
8208
Przemek Stekiel51eac532022-12-07 11:04:51 +01008209 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008210 status = PSA_ERROR_INVALID_ARGUMENT;
8211 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008212 }
8213
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008214 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008215 status = PSA_ERROR_BAD_STATE;
8216 goto exit;
8217 }
8218
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008219 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8220 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008221 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8222 goto exit;
8223 }
8224
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008225 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8226 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008227
8228 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008229exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008230 psa_pake_abort(operation);
8231 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008232}
8233
8234psa_status_t psa_pake_set_role(
8235 psa_pake_operation_t *operation,
8236 psa_pake_role_t role)
8237{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008238 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008239
Przemek Stekiel51eac532022-12-07 11:04:51 +01008240 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008241 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008242 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008243 }
8244
Przemek Stekiel09104b82023-03-06 14:11:51 +01008245 switch (operation->alg) {
8246#if defined(PSA_WANT_ALG_JPAKE)
8247 case PSA_ALG_JPAKE:
8248 if (role == PSA_PAKE_ROLE_NONE) {
8249 return PSA_SUCCESS;
8250 }
8251 status = PSA_ERROR_INVALID_ARGUMENT;
8252 break;
8253#endif
8254 default:
8255 (void) role;
8256 status = PSA_ERROR_NOT_SUPPORTED;
8257 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008258 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008259exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008260 psa_pake_abort(operation);
8261 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008262}
8263
David Horstmanne7f21e62023-05-12 18:17:21 +01008264/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008265#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008266static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008267 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008268{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008269 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008270 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008271 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008272
David Horstmann024e5c52023-06-14 15:48:21 +01008273 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008274 is_x1 = (stage->outputs < 1);
8275 } else {
8276 is_x1 = (stage->inputs < 1);
8277 }
8278
David Horstmann74a3d8c2023-06-14 18:28:19 +01008279 key_share_step = is_x1 ?
8280 PSA_JPAKE_X1_STEP_KEY_SHARE :
8281 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008282 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008283 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8284 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8285 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8286 } else {
8287 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008288 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008289 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008290}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008291#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008292
Przemek Stekiel2797d372022-12-22 11:19:22 +01008293static psa_status_t psa_pake_complete_inputs(
8294 psa_pake_operation_t *operation)
8295{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008296 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008297 /* Create copy of the inputs on stack as inputs share memory
8298 with the driver context which will be setup by the driver. */
8299 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008300
Przemek Stekielfde11282023-03-13 16:06:09 +01008301 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008302 return PSA_ERROR_BAD_STATE;
8303 }
8304
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008305 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008306 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8307 return PSA_ERROR_BAD_STATE;
8308 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008309 }
8310
Przemek Stekiel18620a32023-01-17 16:34:52 +01008311 /* Clear driver context */
8312 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8313
8314 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008315
8316 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008317 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008318
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008319 /* User and peer are translated to role. */
8320 mbedtls_free(inputs.user);
8321 mbedtls_free(inputs.peer);
8322
Przemek Stekiel2797d372022-12-22 11:19:22 +01008323 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008324#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008325 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008326 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008327 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008328#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008329 {
8330 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008331 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008332 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008333 return status;
8334}
8335
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008336#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008337static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008338 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008339 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008340 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008341{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008342 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8343 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8344 step != PSA_PAKE_STEP_ZK_PROOF) {
8345 return PSA_ERROR_INVALID_ARGUMENT;
8346 }
8347
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008348 psa_jpake_computation_stage_t *computation_stage =
8349 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008350
David Horstmann5da95602023-06-08 15:37:12 +01008351 if (computation_stage->round != PSA_JPAKE_FIRST &&
8352 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008353 return PSA_ERROR_BAD_STATE;
8354 }
8355
David Horstmanne7f21e62023-05-12 18:17:21 +01008356 /* Check that the step we are given is the one we were expecting */
8357 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008358 return PSA_ERROR_BAD_STATE;
8359 }
8360
David Horstmanne7f21e62023-05-12 18:17:21 +01008361 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8362 computation_stage->inputs == 0 &&
8363 computation_stage->outputs == 0) {
8364 /* Start of the round, so function decides whether we are inputting
8365 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008366 computation_stage->io_mode = io_mode;
8367 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008368 /* Middle of the round so the mode we are in must match the function
8369 * called by the user */
8370 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008371 }
8372
8373 return PSA_SUCCESS;
8374}
8375
David Horstmanne7f21e62023-05-12 18:17:21 +01008376static psa_status_t psa_jpake_epilogue(
8377 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008378 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008379{
David Horstmanne7f21e62023-05-12 18:17:21 +01008380 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008381 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008382
David Horstmanne7f21e62023-05-12 18:17:21 +01008383 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8384 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008385 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008386 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008387 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008388 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008389 }
8390 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008391 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008392 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008393 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008394 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008395 }
8396 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008397 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8398 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008399 /* End of a round, move to the next round */
8400 stage->inputs = 0;
8401 stage->outputs = 0;
8402 stage->round++;
8403 }
8404 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008405 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008406 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008407 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008408 return PSA_SUCCESS;
8409}
David Horstmanne7f21e62023-05-12 18:17:21 +01008410
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008411#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008412
Neil Armstronga7d08c32022-06-01 18:21:20 +02008413psa_status_t psa_pake_output(
8414 psa_pake_operation_t *operation,
8415 psa_pake_step_t step,
8416 uint8_t *output,
8417 size_t output_size,
8418 size_t *output_length)
8419{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008420 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008421 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008422 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008423
8424 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008425 status = psa_pake_complete_inputs(operation);
8426 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008427 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008428 }
8429 }
8430
8431 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008432 status = PSA_ERROR_BAD_STATE;
8433 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008434 }
8435
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008436 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008437 status = PSA_ERROR_INVALID_ARGUMENT;
8438 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008439 }
8440
Przemek Stekiele12ed362022-12-21 12:54:46 +01008441 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008442#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008443 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008444 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008445 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008446 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008447 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008448 driver_step = convert_jpake_computation_stage_to_driver_step(
8449 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008450 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008451#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008452 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008453 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008454 status = PSA_ERROR_NOT_SUPPORTED;
8455 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008456 }
8457
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008458 status = psa_driver_wrapper_pake_output(operation, driver_step,
8459 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008460
8461 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008462 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008463 }
8464
8465 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008466#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008467 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008468 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008469 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008470 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008471 }
8472 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008473#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008474 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008475 status = PSA_ERROR_NOT_SUPPORTED;
8476 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008477 }
8478
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008479 return PSA_SUCCESS;
8480exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008481 psa_pake_abort(operation);
8482 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008483}
8484
8485psa_status_t psa_pake_input(
8486 psa_pake_operation_t *operation,
8487 psa_pake_step_t step,
8488 const uint8_t *input,
8489 size_t input_length)
8490{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008491 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008492 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008493 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8494 operation->primitive,
8495 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008496
8497 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008498 status = psa_pake_complete_inputs(operation);
8499 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008500 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008501 }
8502 }
8503
8504 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008505 status = PSA_ERROR_BAD_STATE;
8506 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008507 }
8508
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008509 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008510 status = PSA_ERROR_INVALID_ARGUMENT;
8511 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008512 }
8513
Przemek Stekiele12ed362022-12-21 12:54:46 +01008514 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008515#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008516 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008517 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008518 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008519 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008520 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008521 driver_step = convert_jpake_computation_stage_to_driver_step(
8522 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008523 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008524#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008525 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008526 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008527 status = PSA_ERROR_NOT_SUPPORTED;
8528 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008529 }
8530
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008531 status = psa_driver_wrapper_pake_input(operation, driver_step,
8532 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008533
8534 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008535 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008536 }
8537
8538 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008539#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008540 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008541 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008542 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008543 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008544 }
8545 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008546#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008547 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008548 status = PSA_ERROR_NOT_SUPPORTED;
8549 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008550 }
8551
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008552 return PSA_SUCCESS;
8553exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008554 psa_pake_abort(operation);
8555 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008556}
8557
8558psa_status_t psa_pake_get_implicit_key(
8559 psa_pake_operation_t *operation,
8560 psa_key_derivation_operation_t *output)
8561{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008562 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008563 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008564 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008565 size_t shared_key_len = 0;
8566
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008567 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008568 status = PSA_ERROR_BAD_STATE;
8569 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008570 }
8571
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008572#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008573 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008574 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008575 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008576 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008577 status = PSA_ERROR_BAD_STATE;
8578 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008579 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008580 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008581#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008582 {
8583 status = PSA_ERROR_NOT_SUPPORTED;
8584 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008585 }
8586
Przemek Stekiel0c781802022-11-29 14:53:13 +01008587 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8588 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008589 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008590 &shared_key_len);
8591
8592 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008593 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008594 }
8595
8596 status = psa_key_derivation_input_bytes(output,
8597 PSA_KEY_DERIVATION_INPUT_SECRET,
8598 shared_key,
8599 shared_key_len);
8600
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008601 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008602exit:
8603 abort_status = psa_pake_abort(operation);
8604 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008605}
8606
8607psa_status_t psa_pake_abort(
8608 psa_pake_operation_t *operation)
8609{
Przemek Stekield69dca92023-01-31 19:59:20 +01008610 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008611
Przemek Stekield69dca92023-01-31 19:59:20 +01008612 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008613 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008614 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008615
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008616 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8617 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008618 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008619 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008620 }
8621 if (operation->data.inputs.user != NULL) {
8622 mbedtls_free(operation->data.inputs.user);
8623 }
8624 if (operation->data.inputs.peer != NULL) {
8625 mbedtls_free(operation->data.inputs.peer);
8626 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008627 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008628 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008629
Przemek Stekield69dca92023-01-31 19:59:20 +01008630 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008631}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008632#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008633
David Horstmann00d7a042023-12-07 18:39:17 +00008634/* Memory copying test hooks. These are called before input copy, after input
8635 * copy, before output copy and after output copy, respectively.
8636 * They are used by memory-poisoning tests to temporarily unpoison buffers
8637 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008638#if defined(MBEDTLS_TEST_HOOKS)
8639void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8640void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8641void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8642void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8643#endif
David Horstmannfde97392023-10-30 20:29:43 +00008644
David Horstmann1b7279a2023-11-15 15:18:30 +00008645/** Copy from an input buffer to a local copy.
8646 *
8647 * \param[in] input Pointer to input buffer.
8648 * \param[in] input_len Length of the input buffer.
8649 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8650 * \param[out] input_copy_len Length of the local copy buffer.
8651 * \return #PSA_SUCCESS, if the buffer was successfully
8652 * copied.
8653 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8654 * copy is too small to hold contents of the
8655 * input buffer.
8656 */
8657MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008658psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8659 uint8_t *input_copy, size_t input_copy_len)
8660{
8661 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008662 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008663 }
8664
David Horstmann372b8bb2023-11-24 16:21:04 +00008665#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008666 if (psa_input_pre_copy_hook != NULL) {
8667 psa_input_pre_copy_hook(input, input_len);
8668 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008669#endif
8670
David Horstmann777e7412023-11-15 17:33:47 +00008671 if (input_len > 0) {
8672 memcpy(input_copy, input, input_len);
8673 }
David Horstmannfde97392023-10-30 20:29:43 +00008674
David Horstmann372b8bb2023-11-24 16:21:04 +00008675#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008676 if (psa_input_post_copy_hook != NULL) {
8677 psa_input_post_copy_hook(input, input_len);
8678 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008679#endif
8680
David Horstmannfde97392023-10-30 20:29:43 +00008681 return PSA_SUCCESS;
8682}
8683
David Horstmann1b7279a2023-11-15 15:18:30 +00008684/** Copy from a local output buffer into a user-supplied one.
8685 *
8686 * \param[in] output_copy Pointer to a local buffer containing the output.
8687 * \param[in] output_copy_len Length of the local buffer.
8688 * \param[out] output Pointer to user-supplied output buffer.
8689 * \param[out] output_len Length of the user-supplied output buffer.
8690 * \return #PSA_SUCCESS, if the buffer was successfully
8691 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008692 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008693 * user-supplied output buffer is too small to
8694 * hold the contents of the local buffer.
8695 */
8696MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008697psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8698 uint8_t *output, size_t output_len)
8699{
8700 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008701 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008702 }
David Horstmann777e7412023-11-15 17:33:47 +00008703
David Horstmann372b8bb2023-11-24 16:21:04 +00008704#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008705 if (psa_output_pre_copy_hook != NULL) {
8706 psa_output_pre_copy_hook(output, output_len);
8707 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008708#endif
8709
David Horstmann777e7412023-11-15 17:33:47 +00008710 if (output_copy_len > 0) {
8711 memcpy(output, output_copy, output_copy_len);
8712 }
8713
David Horstmann372b8bb2023-11-24 16:21:04 +00008714#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008715 if (psa_output_post_copy_hook != NULL) {
8716 psa_output_post_copy_hook(output, output_len);
8717 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008718#endif
8719
David Horstmann8978f5c2023-10-30 20:37:12 +00008720 return PSA_SUCCESS;
8721}
8722
David Horstmannf1734052023-11-20 17:15:32 +00008723psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8724 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008725{
8726 psa_status_t status;
8727
David Horstmann9db14482023-11-23 15:50:37 +00008728 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008729
David Horstmannc5cc1c32023-11-15 18:11:26 +00008730 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008731 return PSA_SUCCESS;
8732 }
8733
David Horstmannf1734052023-11-20 17:15:32 +00008734 local_input->buffer = mbedtls_calloc(input_len, 1);
8735 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008736 /* Since we dealt with the zero-length case above, we know that
8737 * a NULL return value means a failure of allocation. */
8738 return PSA_ERROR_INSUFFICIENT_MEMORY;
8739 }
David Horstmannf1734052023-11-20 17:15:32 +00008740 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008741
David Horstmannf1734052023-11-20 17:15:32 +00008742 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008743
8744 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008745 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008746 if (status != PSA_SUCCESS) {
8747 goto error;
8748 }
8749
8750 return PSA_SUCCESS;
8751
8752error:
David Horstmannf1734052023-11-20 17:15:32 +00008753 mbedtls_free(local_input->buffer);
8754 local_input->buffer = NULL;
8755 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008756 return status;
8757}
8758
David Horstmannf1734052023-11-20 17:15:32 +00008759void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008760{
David Horstmannf1734052023-11-20 17:15:32 +00008761 mbedtls_free(local_input->buffer);
8762 local_input->buffer = NULL;
8763 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008764}
8765
David Horstmann89875a42023-11-20 12:54:09 +00008766psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8767 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008768{
David Horstmann9db14482023-11-23 15:50:37 +00008769 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008770
David Horstmannc5cc1c32023-11-15 18:11:26 +00008771 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008772 return PSA_SUCCESS;
8773 }
David Horstmann89875a42023-11-20 12:54:09 +00008774 local_output->buffer = mbedtls_calloc(output_len, 1);
8775 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008776 /* Since we dealt with the zero-length case above, we know that
8777 * a NULL return value means a failure of allocation. */
8778 return PSA_ERROR_INSUFFICIENT_MEMORY;
8779 }
David Horstmann89875a42023-11-20 12:54:09 +00008780 local_output->length = output_len;
8781 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008782
8783 return PSA_SUCCESS;
8784}
8785
Gabor Mezei1882c512024-01-24 13:07:17 +01008786psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8787 psa_crypto_local_output_t *local_output)
8788{
8789 psa_status_t status;
8790 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8791
8792 if (output_len == 0) {
8793 return PSA_SUCCESS;
8794 }
8795 local_output->buffer = mbedtls_calloc(output_len, 1);
8796 if (local_output->buffer == NULL) {
8797 /* Since we dealt with the zero-length case above, we know that
8798 * a NULL return value means a failure of allocation. */
8799 return PSA_ERROR_INSUFFICIENT_MEMORY;
8800 }
8801 local_output->length = output_len;
8802 local_output->original = output;
8803
8804 status = psa_crypto_copy_input(output, output_len,
8805 local_output->buffer, local_output->length);
8806 if (status != PSA_SUCCESS) {
8807 goto error;
8808 }
8809
8810 return PSA_SUCCESS;
8811
8812error:
8813 mbedtls_free(local_output->buffer);
8814 local_output->buffer = NULL;
8815 local_output->length = 0;
8816 return status;
8817}
8818
David Horstmann89875a42023-11-20 12:54:09 +00008819psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008820{
David Horstmannc335a4e2023-11-15 15:57:32 +00008821 psa_status_t status;
8822
David Horstmann89875a42023-11-20 12:54:09 +00008823 if (local_output->buffer == NULL) {
8824 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008825 return PSA_SUCCESS;
8826 }
David Horstmann89875a42023-11-20 12:54:09 +00008827 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008828 /* We have an internal copy but nothing to copy back to. */
8829 return PSA_ERROR_CORRUPTION_DETECTED;
8830 }
8831
David Horstmann89875a42023-11-20 12:54:09 +00008832 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8833 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008834 if (status != PSA_SUCCESS) {
8835 return status;
8836 }
David Horstmann9467ea32023-11-08 17:44:18 +00008837
David Horstmann89875a42023-11-20 12:54:09 +00008838 mbedtls_free(local_output->buffer);
8839 local_output->buffer = NULL;
8840 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008841
8842 return PSA_SUCCESS;
8843}
8844
Gilles Peskinee59236f2018-01-27 23:32:46 +01008845#endif /* MBEDTLS_PSA_CRYPTO_C */