blob: 5621cec98091298f899090a5e191a0db373e5b21 [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"
Valerio Setti384fbde2024-01-02 13:26:40 +010073#include "mbedtls/psa_util.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 Settic6f004f2023-12-12 11:27:36 +0100247
Valerio Setti1fff4f22023-12-28 14:19:34 +0100248int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg)
Valerio Settic6f004f2023-12-12 11:27:36 +0100249{
Valerio Setti1fff4f22023-12-28 14:19:34 +0100250 (void) key_type;
Valerio Settic6f004f2023-12-12 11:27:36 +0100251 (void) cipher_alg;
252 return global_data.drivers_initialized;
253}
254
255
Valerio Settia55f0422023-07-10 15:34:41 +0200256#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200257 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200258 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200259static int psa_is_dh_key_size_valid(size_t bits)
260{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200261 if (bits != 2048 && bits != 3072 && bits != 4096 &&
262 bits != 6144 && bits != 8192) {
263 return 0;
264 }
265
266 return 1;
267}
Valerio Settia55f0422023-07-10 15:34:41 +0200268#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200269 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200270 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100271
Gilles Peskine449bd832023-01-11 14:50:10 +0100272psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100273{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100274 /* Mbed TLS error codes can combine a high-level error code and a
275 * low-level error code. The low-level error usually reflects the
276 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100277 int low_level_ret = -(-ret & 0x007f);
278 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100279 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100280 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100281
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100282#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100283 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
284 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100286 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
287 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100288#endif
289
290#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200291 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
292 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
293 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
294 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
295 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200297 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200299 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100301#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200302
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100303#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000304 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100305 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100307#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100308
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100309#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100310 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100312 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100313 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100314#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100315
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100316#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200317 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100319#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200320
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100321#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200322 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200324 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100326#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200327
Dave Rodgman509b5672023-08-16 19:26:23 +0100328#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100329 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100331 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100333 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100335 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100336 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100337 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100339 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100341 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100343#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100344
Gilles Peskine449bd832023-01-11 14:50:10 +0100345#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
346 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100347 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
348 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100349 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100351 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
352 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100354 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100356#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100357
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100358#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100359 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100361#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100362
Gilles Peskinee59236f2018-01-27 23:32:46 +0100363 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
364 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
365 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100367
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100368#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100369 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200371 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100373 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100375#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100376
Gilles Peskine82e57d12020-11-13 21:31:17 +0100377#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100379 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
380 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100381 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100383 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
384 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100386 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100388#endif
389
Dave Rodgmandea266f2023-08-31 11:52:43 +0100390#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100391 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100393 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100394 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100395 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100396 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100397#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100398 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100400#endif
401#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100402
Dave Rodgman509b5672023-08-16 19:26:23 +0100403#if defined(MBEDTLS_BIGNUM_C)
404#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100405 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100407#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100408 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100410 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100412 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100414 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100416 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100418 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100420 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100422#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100423
Dave Rodgman509b5672023-08-16 19:26:23 +0100424#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100425 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100427 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
428 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100429 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100430#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
431 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100432 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100434#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100435 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
436 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100438 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
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_PASSWORD_REQUIRED:
441 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100443 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100444 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100445 case MBEDTLS_ERR_PK_INVALID_ALG:
446 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
447 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100448 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100449 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200451 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100453#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100454
Gilles Peskineff2d2002019-05-06 15:26:23 +0200455 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200457 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200459
Dave Rodgman509b5672023-08-16 19:26:23 +0100460#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100461 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100463 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100465 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100466 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100467 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100469 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
470 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100471 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100472 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100474 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100476 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100478#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200479
Dave Rodgman1dab4452023-09-01 09:59:51 +0100480#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300481 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300482 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300484 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300486 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300488 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
489 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100490 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300491 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100493 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100495
Dave Rodgman509b5672023-08-16 19:26:23 +0100496#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000497 case MBEDTLS_ERR_ECP_IN_PROGRESS:
498 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100499#endif
500#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000501
Janos Follatha13b9052019-11-22 12:48:59 +0000502 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300504
Gilles Peskinee59236f2018-01-27 23:32:46 +0100505 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100507 }
508}
509
Paul Elliottdc42ca82023-02-24 18:11:59 +0000510/**
511 * \brief For output buffers which contain "tags"
512 * (outputs that may be checked for validity like
513 * hashes, MACs and signatures), fill the unused
514 * part of the output buffer (the whole buffer on
515 * error, the trailing part on success) with
516 * something that isn't a valid tag (barring an
517 * attack on the tag and deliberately-crafted
518 * input), in case the caller doesn't check the
519 * return status properly.
520 *
521 * \param output_buffer Pointer to buffer to wipe. May not be NULL
522 * unless \p output_buffer_size is zero.
523 * \param status Status of function called to generate
524 * output_buffer originally
525 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
526 * could be NULL.
527 * \param output_buffer_length Length of data written to output_buffer, must be
528 * less than \p output_buffer_size
529 */
530static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000531 size_t output_buffer_size, size_t output_buffer_length)
532{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000533 size_t offset = 0;
534
535 if (output_buffer_size == 0) {
536 /* If output_buffer_size is 0 then we have nothing to do. We must not
537 call memset because output_buffer may be NULL in this case */
538 return;
539 }
540
541 if (status == PSA_SUCCESS) {
542 offset = output_buffer_length;
543 }
544
545 memset(output_buffer + offset, '!', output_buffer_size - offset);
546}
547
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200548
Gilles Peskine449bd832023-01-11 14:50:10 +0100549psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
550 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200551{
552 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200554 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200555 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200556 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200557 case PSA_KEY_TYPE_PASSWORD:
558 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200559 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100560#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200561 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 if (bits != 128 && bits != 192 && bits != 256) {
563 return PSA_ERROR_INVALID_ARGUMENT;
564 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200565 break;
566#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200567#if defined(PSA_WANT_KEY_TYPE_ARIA)
568 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 if (bits != 128 && bits != 192 && bits != 256) {
570 return PSA_ERROR_INVALID_ARGUMENT;
571 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200572 break;
573#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100574#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200575 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 if (bits != 128 && bits != 192 && bits != 256) {
577 return PSA_ERROR_INVALID_ARGUMENT;
578 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200579 break;
580#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100581#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200582 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 if (bits != 64 && bits != 128 && bits != 192) {
584 return PSA_ERROR_INVALID_ARGUMENT;
585 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200586 break;
587#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100588#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200589 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 if (bits != 256) {
591 return PSA_ERROR_INVALID_ARGUMENT;
592 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200593 break;
594#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200595 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100596 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200597 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 if (bits % 8 != 0) {
599 return PSA_ERROR_INVALID_ARGUMENT;
600 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200601
Gilles Peskine449bd832023-01-11 14:50:10 +0100602 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200603}
604
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100605/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100606 *
Steven Cooremancd640932021-03-08 12:00:27 +0100607 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
608 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100609 *
610 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100611 * \param[in] key_type The key type of the key to be used with the
612 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100613 *
614 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100615 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100616 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100617 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100618 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100619MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100620 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100622{
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 if (PSA_ALG_IS_HMAC(algorithm)) {
624 if (key_type == PSA_KEY_TYPE_HMAC) {
625 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100626 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100627 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100628
Gilles Peskine449bd832023-01-11 14:50:10 +0100629 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
630 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
631 * key. */
632 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
633 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
634 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
635 * the block length (larger than 1) for block ciphers. */
636 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
637 return PSA_SUCCESS;
638 }
639 }
640 }
641
642 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100643}
644
Gilles Peskine449bd832023-01-11 14:50:10 +0100645psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
646 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200647{
Gilles Peskine449bd832023-01-11 14:50:10 +0100648 if (slot->key.data != NULL) {
649 return PSA_ERROR_ALREADY_EXISTS;
650 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200651
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 slot->key.data = mbedtls_calloc(1, buffer_length);
653 if (slot->key.data == NULL) {
654 return PSA_ERROR_INSUFFICIENT_MEMORY;
655 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200656
Ronald Cronea0f8a62020-11-25 17:52:23 +0100657 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100658 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200659}
660
Gilles Peskine449bd832023-01-11 14:50:10 +0100661psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
662 const uint8_t *data,
663 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200664{
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 psa_status_t status = psa_allocate_buffer_to_slot(slot,
666 data_length);
667 if (status != PSA_SUCCESS) {
668 return status;
669 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 memcpy(slot->key.data, data, data_length);
672 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200673}
674
Ronald Crona0fe59f2020-11-29 11:14:53 +0100675psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100676 const psa_key_attributes_t *attributes,
677 const uint8_t *data, size_t data_length,
678 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100680{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100681 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
682 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100683
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200684 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 if (data_length == 0) {
686 return PSA_ERROR_NOT_SUPPORTED;
687 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200688
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 if (key_type_is_raw_bytes(type)) {
690 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
693 *bits);
694 if (status != PSA_SUCCESS) {
695 return status;
696 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200697
Ronald Crondd04d422020-11-28 15:14:42 +0100698 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100700 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200702
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 return PSA_SUCCESS;
704 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200705#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200706 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100707 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200708 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100709 return PSA_ERROR_INVALID_ARGUMENT;
710 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200711 return mbedtls_psa_ffdh_import_key(attributes,
712 data, data_length,
713 key_buffer, key_buffer_size,
714 key_buffer_length,
715 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100716 }
Valerio Settia55f0422023-07-10 15:34:41 +0200717#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200718 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200719#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
721 if (PSA_KEY_TYPE_IS_ECC(type)) {
722 return mbedtls_psa_ecp_import_key(attributes,
723 data, data_length,
724 key_buffer, key_buffer_size,
725 key_buffer_length,
726 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100727 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200728#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800729 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200730#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
731 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
733 if (PSA_KEY_TYPE_IS_RSA(type)) {
734 return mbedtls_psa_rsa_import_key(attributes,
735 data, data_length,
736 key_buffer, key_buffer_size,
737 key_buffer_length,
738 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200739 }
Valerio Settife478902023-07-25 12:27:19 +0200740#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
741 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800742 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100743 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100744
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100746}
747
Gilles Peskinef603c712019-01-19 13:40:11 +0100748/** Calculate the intersection of two algorithm usage policies.
749 *
750 * Return 0 (which allows no operation) on incompatibility.
751 */
752static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100753 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100754 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100756{
Gilles Peskine549ea862019-05-22 11:45:59 +0200757 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 if (alg1 == alg2) {
759 return alg1;
760 }
Steven Cooreman03488022021-02-18 12:07:20 +0100761 /* If the policies are from the same hash-and-sign family, check
762 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100763 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
764 PSA_ALG_IS_SIGN_HASH(alg2) &&
765 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
766 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
767 return alg2;
768 }
769 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
770 return alg1;
771 }
Steven Cooreman03488022021-02-18 12:07:20 +0100772 }
773 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100774 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100775 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
777 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
778 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
779 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
780 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100781 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100782
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100783 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
785 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
786 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
787 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100788 }
789 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
791 (alg1_len <= alg2_len)) {
792 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100793 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
795 (alg2_len <= alg1_len)) {
796 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100797 }
798 }
799 /* If the policies are from the same MAC family, check whether one
800 * of them is a minimum-MAC-length policy. Calculate the most
801 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
803 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
804 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100805 /* Validate the combination of key type and algorithm. Since the base
806 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
808 return 0;
809 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100810
Steven Cooreman31a876d2021-03-03 20:47:40 +0100811 /* Get the (exact or at-least) output lengths for both sides of the
812 * requested intersection. None of the currently supported algorithms
813 * have an output length dependent on the actual key size, so setting it
814 * to a bogus value of 0 is currently OK.
815 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100816 * Note that for at-least-this-length wildcard algorithms, the output
817 * length is set to the shortest allowed length, which allows us to
818 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100819 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
820 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100821 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100822
Steven Cooremana1d83222021-02-25 10:20:29 +0100823 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100824 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
825 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
826 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100827 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100828
829 /* If only one is an at-least-this-length policy, the intersection would
830 * be the other (fixed-length) policy as long as said fixed length is
831 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
833 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100834 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100835 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
836 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100837 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100838
Steven Cooremancd640932021-03-08 12:00:27 +0100839 /* If none of them are wildcards, check whether they define the same tag
840 * length. This is still possible here when one is default-length and
841 * the other specific-length. Ensure to always return the
842 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100843 if (alg1_len == alg2_len) {
844 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
845 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100846 }
847 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100848 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100849}
850
Gilles Peskine449bd832023-01-11 14:50:10 +0100851static int psa_key_algorithm_permits(psa_key_type_t key_type,
852 psa_algorithm_t policy_alg,
853 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200854{
Gilles Peskine549ea862019-05-22 11:45:59 +0200855 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100856 if (requested_alg == policy_alg) {
857 return 1;
858 }
Steven Cooreman03488022021-02-18 12:07:20 +0100859 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
860 * and requested_alg is the same hash-and-sign family with any hash,
861 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100862 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
863 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
864 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
865 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100866 }
867 /* If policy_alg is a wildcard AEAD algorithm of the same base as
868 * the requested algorithm, check the requested tag length to be
869 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100870 if (PSA_ALG_IS_AEAD(policy_alg) &&
871 PSA_ALG_IS_AEAD(requested_alg) &&
872 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
873 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
874 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
875 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
876 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100877 }
Steven Cooremancd640932021-03-08 12:00:27 +0100878 /* If policy_alg is a MAC algorithm of the same base as the requested
879 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100880 if (PSA_ALG_IS_MAC(policy_alg) &&
881 PSA_ALG_IS_MAC(requested_alg) &&
882 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
883 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100884 /* Validate the combination of key type and algorithm. Since the policy
885 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100886 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
887 return 0;
888 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100889
Steven Cooreman31a876d2021-03-03 20:47:40 +0100890 /* Get both the requested output length for the algorithm which is to be
891 * verified, and the default output length for the base algorithm.
892 * Note that none of the currently supported algorithms have an output
893 * length dependent on actual key size, so setting it to a bogus value
894 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100895 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100896 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100897 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 key_type, 0,
899 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100900
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100901 /* If the policy is default-length, only allow an algorithm with
902 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
904 return requested_output_length == default_output_length;
905 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100906
907 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100908 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
910 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
911 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100912 }
913
Steven Cooremancd640932021-03-08 12:00:27 +0100914 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
915 * check for the requested MAC length to be equal to or longer than the
916 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
918 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
919 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100920 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200921 }
Steven Cooremance48e852020-10-05 16:02:45 +0200922 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200923 * a key derivation with that key agreement should also be allowed. This
924 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
926 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
927 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
928 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200929 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100930 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200932}
933
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100934/** Test whether a policy permits an algorithm.
935 *
936 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100937 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100938 * \note This function requires providing the key type for which the policy is
939 * being validated, since some algorithm policy definitions (e.g. MAC)
940 * have different properties depending on what kind of cipher it is
941 * combined with.
942 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100943 * \retval PSA_SUCCESS When \p alg is a specific algorithm
944 * allowed by the \p policy.
945 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
946 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
947 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100948 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100949static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
950 psa_key_type_t key_type,
951 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100952{
Steven Cooremand788fab2021-02-25 11:29:17 +0100953 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100954 if (alg == 0) {
955 return PSA_ERROR_INVALID_ARGUMENT;
956 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100957
Steven Cooreman7e39f052021-02-23 14:18:32 +0100958 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 if (PSA_ALG_IS_WILDCARD(alg)) {
960 return PSA_ERROR_INVALID_ARGUMENT;
961 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100962
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
964 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
965 return PSA_SUCCESS;
966 } else {
967 return PSA_ERROR_NOT_PERMITTED;
968 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100969}
970
Gilles Peskinef603c712019-01-19 13:40:11 +0100971/** Restrict a key policy based on a constraint.
972 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100973 * \note This function requires providing the key type for which the policy is
974 * being restricted, since some algorithm policy definitions (e.g. MAC)
975 * have different properties depending on what kind of cipher it is
976 * combined with.
977 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100978 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100979 * \param[in,out] policy The policy to restrict.
980 * \param[in] constraint The policy constraint to apply.
981 *
982 * \retval #PSA_SUCCESS
983 * \c *policy contains the intersection of the original value of
984 * \c *policy and \c *constraint.
985 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100986 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100987 * \c *policy is unchanged.
988 */
989static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100990 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100991 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100993{
994 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 psa_key_policy_algorithm_intersection(key_type, policy->alg,
996 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200997 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
999 constraint->alg2);
1000 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1001 return PSA_ERROR_INVALID_ARGUMENT;
1002 }
1003 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1004 return PSA_ERROR_INVALID_ARGUMENT;
1005 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001006 policy->usage &= constraint->usage;
1007 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001008 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001010}
1011
Przemek Stekiel061f6942022-11-30 10:51:35 +01001012/** Get the description of a key given its identifier and policy constraints
1013 * and lock it.
1014 *
1015 * The key must have allow all the usage flags set in \p usage. If \p alg is
1016 * nonzero, the key must allow operations with this algorithm. If \p alg is
1017 * zero, the algorithm is not checked.
1018 *
1019 * In case of a persistent key, the function loads the description of the key
1020 * into a key slot if not already done.
1021 *
Ryan Everett098c6652024-01-03 13:03:36 +00001022 * On success, the returned key slot has been registered for reading.
1023 * It is the responsibility of the caller to call psa_unregister_read(slot)
1024 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +01001025 */
1026static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001027 mbedtls_svc_key_id_t key,
1028 psa_key_slot_t **p_slot,
1029 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001031{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001032 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001033 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001034
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 status = psa_get_and_lock_key_slot(key, p_slot);
1036 if (status != PSA_SUCCESS) {
1037 return status;
1038 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001039 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001040
1041 /* Enforce that usage policy for the key slot contains all the flags
1042 * required by the usage parameter. There is one exception: public
1043 * keys can always be exported, so we treat public key objects as
1044 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001046 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001048
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001050 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001051 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001052 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001053
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001054 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (alg != 0) {
1056 status = psa_key_policy_permits(&slot->attr.policy,
1057 slot->attr.type,
1058 alg);
1059 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001060 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001062 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001065
1066error:
1067 *p_slot = NULL;
Ryan Everett098c6652024-01-03 13:03:36 +00001068 psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001069
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001071}
Darryl Green940d72c2018-07-13 13:18:51 +01001072
Ronald Cron5c522922020-11-14 16:35:34 +01001073/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001074 *
1075 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001076 * available, as opposed to a key in a secure element and/or to be used
1077 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001078 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001079 * This is a temporary function that may be used instead of
1080 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1081 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001082 *
Ryan Everett098c6652024-01-03 13:03:36 +00001083 * On success, the returned key slot has been registered for reading.
1084 * It is the responsibility of the caller to call psa_unregister_read(slot)
1085 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001086 */
Ronald Cron5c522922020-11-14 16:35:34 +01001087static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1088 mbedtls_svc_key_id_t key,
1089 psa_key_slot_t **p_slot,
1090 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001092{
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1094 usage, alg);
1095 if (status != PSA_SUCCESS) {
1096 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001097 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001098
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everett098c6652024-01-03 13:03:36 +00001100 psa_unregister_read(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 *p_slot = NULL;
1102 return PSA_ERROR_NOT_SUPPORTED;
1103 }
1104
1105 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001106}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001107
Gilles Peskine449bd832023-01-11 14:50:10 +01001108psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001109{
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001111 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001113
Ronald Cronea0f8a62020-11-25 17:52:23 +01001114 slot->key.data = NULL;
1115 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001116
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001118}
1119
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001120/** Completely wipe a slot in memory, including its policy.
1121 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001122psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001123{
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001125
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 /*
1127 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001128 * do our best to report an unexpected amount of registered readers or
1129 * an unexpected state.
1130 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1131 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1133 * function is called as part of the execution of a test suite, the
1134 * execution of the test suite is stopped in error if the assertion fails.
1135 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001136 switch (slot->state) {
1137 case PSA_SLOT_FULL:
1138 /* In this state psa_wipe_key_slot() must only be called if the
1139 * caller is the last reader. */
1140 case PSA_SLOT_PENDING_DELETION:
1141 /* In this state psa_wipe_key_slot() must only be called if the
1142 * caller is the last reader. */
1143 if (slot->registered_readers != 1) {
1144 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1145 status = PSA_ERROR_CORRUPTION_DETECTED;
1146 }
1147 break;
1148 case PSA_SLOT_FILLING:
1149 /* In this state registered_readers must be 0. */
1150 if (slot->registered_readers != 0) {
1151 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1152 status = PSA_ERROR_CORRUPTION_DETECTED;
1153 }
1154 break;
1155 case PSA_SLOT_EMPTY:
1156 /* The slot is already empty, it cannot be wiped. */
1157 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1158 status = PSA_ERROR_CORRUPTION_DETECTED;
1159 break;
1160 default:
1161 /* The slot's state is invalid. */
1162 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001163 }
1164
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001165 /* Multipart operations may still be using the key. This is safe
1166 * because all multipart operation objects are independent from
1167 * the key slot: if they need to access the key after the setup
1168 * phase, they have a copy of the key. Note that this means that
1169 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001170 /* At this point, key material and other type-specific content has
1171 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001172 * zeroize because the metadata is not particularly sensitive.
1173 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 memset(slot, 0, sizeof(*slot));
1175 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001176}
1177
Gilles Peskine449bd832023-01-11 14:50:10 +01001178psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001179{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001180 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001181 psa_status_t status; /* status of the last operation */
1182 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001183#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1184 psa_se_drv_table_entry_t *driver;
1185#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001186
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 if (mbedtls_svc_key_id_is_null(key)) {
1188 return PSA_SUCCESS;
1189 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001190
Ronald Cronf2911112020-10-29 17:51:10 +01001191 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001192 * Get the description of the key in a key slot, and register to read it.
1193 * In the case of a persistent key, this will load the key description
1194 * from persistent memory if not done yet.
1195 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001196 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001197 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 status = psa_get_and_lock_key_slot(key, &slot);
1199 if (status != PSA_SUCCESS) {
1200 return status;
1201 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001202
Ryan Everett7ed542e2024-01-17 11:39:09 +00001203 /* Set the key slot containing the key description's state to
1204 * PENDING_DELETION. This stops new operations from registering
1205 * to read the slot. Current readers can safely continue to access
1206 * the key within the slot; the last registered reader will
1207 * automatically wipe the slot when they call psa_unregister_read().
1208 * If the key is persistent, we can now delete the copy of the key
1209 * from memory. If the key is opaque, we require the driver to
1210 * deal with the deletion. */
Ryan Everettc70ce572024-01-03 16:04:33 +00001211 slot->state = PSA_SLOT_PENDING_DELETION;
Ronald Cronf2911112020-10-29 17:51:10 +01001212
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001214 /* Refuse the destruction of a read-only key (which may or may not work
1215 * if we attempt it, depending on whether the key is merely read-only
1216 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001217 * Just do the best we can, which is to wipe the copy in memory
1218 * (done in this function's cleanup code). */
1219 overall_status = PSA_ERROR_NOT_PERMITTED;
1220 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001221 }
1222
Gilles Peskine354f7672019-07-12 23:46:38 +02001223#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1225 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001226 /* For a key in a secure element, we need to do three things:
1227 * remove the key file in internal storage, destroy the
1228 * key inside the secure element, and update the driver's
1229 * persistent data. Start a transaction that will encompass these
1230 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001232 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001234 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 status = psa_crypto_save_transaction();
1236 if (status != PSA_SUCCESS) {
1237 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001238 /* We should still try to destroy the key in the secure
1239 * element and the key metadata in storage. This is especially
1240 * important if the error is that the storage is full.
1241 * But how to do it exactly without risking an inconsistent
1242 * state after a reset?
1243 * https://github.com/ARMmbed/mbed-crypto/issues/215
1244 */
1245 overall_status = status;
1246 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001247 }
1248
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 status = psa_destroy_se_key(driver,
1250 psa_key_slot_get_slot_number(slot));
1251 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001252 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001253 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001254 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001255#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1256
Darryl Greend49a4992018-06-18 17:27:26 +01001257#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001258 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001259 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001260 * The slot will still hold a copy of the key until the last reader
1261 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001262 status = psa_destroy_persistent_key(slot->attr.id);
1263 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001264 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001265 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001266
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001267 /* TODO: other slots may have a copy of the same key. We should
1268 * invalidate them.
1269 * https://github.com/ARMmbed/mbed-crypto/issues/214
1270 */
Darryl Greend49a4992018-06-18 17:27:26 +01001271 }
1272#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001273
Gilles Peskinefc762652019-07-22 19:30:34 +02001274#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001275 if (driver != NULL) {
1276 status = psa_save_se_persistent_data(driver);
1277 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001278 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001279 }
1280 status = psa_crypto_stop_transaction();
1281 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001282 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001284 }
1285#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1286
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001287exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001288 /* Unregister from reading the slot. If we are the last active reader
1289 * then this will wipe the slot. */
1290 status = psa_unregister_read(slot);
1291 /* Prioritize CORRUPTION_DETECTED from unregistering over
1292 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001294 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 }
1296 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001297}
1298
Valerio Settib2bcedb2023-07-10 11:24:00 +02001299#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001300 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001301static psa_status_t psa_get_rsa_public_exponent(
1302 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001304{
1305 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001307 uint8_t *buffer = NULL;
1308 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001309 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001310
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1312 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001313 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 }
1315 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001316 /* It's the default value, which is reported as an empty string,
1317 * so there's nothing to do. */
1318 goto exit;
1319 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001320
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 buflen = mbedtls_mpi_size(&mpi);
1322 buffer = mbedtls_calloc(1, buflen);
1323 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001324 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1325 goto exit;
1326 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1328 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001329 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001331 attributes->domain_parameters = buffer;
1332 attributes->domain_parameters_size = buflen;
1333
1334exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 mbedtls_mpi_free(&mpi);
1336 if (ret != 0) {
1337 mbedtls_free(buffer);
1338 }
1339 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001340}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001341#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001342 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001343
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001344/** Retrieve all the publicly-accessible attributes of a key.
1345 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001346psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1347 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001348{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001349 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001350 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001351 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001352
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001354
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1356 if (status != PSA_SUCCESS) {
1357 return status;
1358 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001359
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001360 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1362 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001363
1364#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1366 psa_set_key_slot_number(attributes,
1367 psa_key_slot_get_slot_number(slot));
1368 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001369#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001372#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1373 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001374 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001375 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001376 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001377 /* TODO: This is a temporary situation where domain parameters are deprecated,
1378 * but we need it for namely generating an RSA key with a non-default exponent.
1379 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001381 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001382 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001383
Ronald Cron90857082020-11-25 14:58:33 +01001384 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001385 slot->attr.type,
1386 slot->key.data,
1387 slot->key.bytes,
1388 &rsa);
1389 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001390 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001392
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 status = psa_get_rsa_public_exponent(rsa,
1394 attributes);
1395 mbedtls_rsa_free(rsa);
1396 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001397 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001398 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001399#else
1400 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1401 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1402 attributes->domain_parameters = NULL;
1403 attributes->domain_parameters_size = SIZE_MAX;
1404 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001405#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1406 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001407 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001408 default:
1409 /* Nothing else to do. */
1410 break;
1411 }
1412
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 if (status != PSA_SUCCESS) {
1414 psa_reset_key_attributes(attributes);
1415 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001416
Ryan Everett1b70a072024-01-04 10:32:49 +00001417 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001420}
1421
Gilles Peskinec8000c02019-08-02 20:15:51 +02001422#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1423psa_status_t psa_get_key_slot_number(
1424 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001426{
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001428 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 return PSA_SUCCESS;
1430 } else {
1431 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001432 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001433}
1434#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1435
Gilles Peskine449bd832023-01-11 14:50:10 +01001436static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1437 size_t key_buffer_size,
1438 uint8_t *data,
1439 size_t data_size,
1440 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001441{
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 if (key_buffer_size > data_size) {
1443 return PSA_ERROR_BUFFER_TOO_SMALL;
1444 }
1445 memcpy(data, key_buffer, key_buffer_size);
1446 memset(data + key_buffer_size, 0,
1447 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001448 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001450}
1451
Ronald Cron7285cda2020-11-26 14:46:37 +01001452psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001453 const psa_key_attributes_t *attributes,
1454 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001455 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001456{
Ronald Crond18b5f82020-11-25 16:46:05 +01001457 psa_key_type_t type = attributes->core.type;
1458
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 if (key_type_is_raw_bytes(type) ||
1460 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001461 PSA_KEY_TYPE_IS_ECC(type) ||
1462 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 return psa_export_key_buffer_internal(
1464 key_buffer, key_buffer_size,
1465 data, data_size, data_length);
1466 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001467 /* This shouldn't happen in the reference implementation, but
1468 it is valid for a special-purpose implementation to omit
1469 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001470 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001471 }
1472}
1473
Gilles Peskine449bd832023-01-11 14:50:10 +01001474psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
Ryan Everett45ac5262024-01-08 17:15:19 +00001475 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 size_t data_size,
1477 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001478{
1479 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1480 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1481 psa_key_slot_t *slot;
Ryan Everett45ac5262024-01-08 17:15:19 +00001482 LOCAL_OUTPUT_DECLARE(data_external, data);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001483
Ronald Crone907e552021-01-18 13:22:38 +01001484 /* Reject a zero-length output buffer now, since this can never be a
1485 * valid key representation. This way we know that data must be a valid
1486 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 if (data_size == 0) {
1488 return PSA_ERROR_BUFFER_TOO_SMALL;
1489 }
Ronald Crone907e552021-01-18 13:22:38 +01001490
Ronald Cron9486f9d2020-11-26 13:36:23 +01001491 /* Set the key to empty now, so that even when there are errors, we always
1492 * set data_length to a value between 0 and data_size. On error, setting
1493 * the key to empty is a good choice because an empty key representation is
1494 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001495 *data_length = 0;
1496
Ronald Cron9486f9d2020-11-26 13:36:23 +01001497 /* Export requires the EXPORT flag. There is an exception for public keys,
1498 * which don't require any flag, but
1499 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1500 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1502 PSA_KEY_USAGE_EXPORT, 0);
1503 if (status != PSA_SUCCESS) {
1504 return status;
1505 }
mohammad160306e79202018-03-28 13:17:44 +03001506
Ryan Everett45ac5262024-01-08 17:15:19 +00001507 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1508
Ronald Crond18b5f82020-11-25 16:46:05 +01001509 psa_key_attributes_t attributes = {
1510 .core = slot->attr
1511 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 status = psa_driver_wrapper_export_key(&attributes,
1513 slot->key.data, slot->key.bytes,
1514 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001515
Ryan Everett35f68532024-01-25 12:02:03 +00001516#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everett45ac5262024-01-08 17:15:19 +00001517exit:
Ryan Everett35f68532024-01-25 12:02:03 +00001518#endif
Ryan Everett1b70a072024-01-04 10:32:49 +00001519 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001520
Ryan Everett45ac5262024-01-08 17:15:19 +00001521 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001523}
1524
Ronald Cron7285cda2020-11-26 14:46:37 +01001525psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001526 const psa_key_attributes_t *attributes,
1527 const uint8_t *key_buffer,
1528 size_t key_buffer_size,
1529 uint8_t *data,
1530 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001532{
Ronald Crond18b5f82020-11-25 16:46:05 +01001533 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001534
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001535 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001536 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1537 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001538 /* Exporting public -> public */
1539 return psa_export_key_buffer_internal(
1540 key_buffer, key_buffer_size,
1541 data, data_size, data_length);
1542 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001543#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001544 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1545 return mbedtls_psa_rsa_export_public_key(attributes,
1546 key_buffer,
1547 key_buffer_size,
1548 data,
1549 data_size,
1550 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001551#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001552 /* We don't know how to convert a private RSA key to public. */
1553 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001554#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001555 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001556 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001557#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001558 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1559 return mbedtls_psa_ecp_export_public_key(attributes,
1560 key_buffer,
1561 key_buffer_size,
1562 data,
1563 data_size,
1564 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001565#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001566 /* We don't know how to convert a private ECC key to public */
1567 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001568#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001569 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001570 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001571#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001572 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001573 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001574 key_buffer,
1575 key_buffer_size,
1576 data, data_size,
1577 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001578#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001579 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001580#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001581 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001583 (void) key_buffer;
1584 (void) key_buffer_size;
1585 (void) data;
1586 (void) data_size;
1587 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001589 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001590}
Ronald Crond18b5f82020-11-25 16:46:05 +01001591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
Ryan Everettb1d2c672024-01-08 17:19:30 +00001593 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 size_t data_size,
1595 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001596{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001597 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001598 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001599 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001600 psa_key_attributes_t attributes;
Ryan Everettb1d2c672024-01-08 17:19:30 +00001601 LOCAL_OUTPUT_DECLARE(data_external, data);
Darryl Greendd8fb772018-11-07 16:00:44 +00001602
Ronald Crone907e552021-01-18 13:22:38 +01001603 /* Reject a zero-length output buffer now, since this can never be a
1604 * valid key representation. This way we know that data must be a valid
1605 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 if (data_size == 0) {
1607 return PSA_ERROR_BUFFER_TOO_SMALL;
1608 }
Ronald Crone907e552021-01-18 13:22:38 +01001609
Darryl Greendd8fb772018-11-07 16:00:44 +00001610 /* Set the key to empty now, so that even when there are errors, we always
1611 * set data_length to a value between 0 and data_size. On error, setting
1612 * the key to empty is a good choice because an empty key representation is
1613 * unlikely to be accepted anywhere. */
1614 *data_length = 0;
1615
1616 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1618 if (status != PSA_SUCCESS) {
1619 return status;
1620 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001621
Ryan Everettb1d2c672024-01-08 17:19:30 +00001622 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1623
Gilles Peskine449bd832023-01-11 14:50:10 +01001624 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1625 status = PSA_ERROR_INVALID_ARGUMENT;
1626 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001627 }
1628
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001629 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001630 .core = slot->attr
1631 };
Ronald Cron67227982020-11-26 15:16:05 +01001632 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001633 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001635
1636exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001637 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001638
Ryan Everettb1d2c672024-01-08 17:19:30 +00001639 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001640 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001641}
1642
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001643MBEDTLS_STATIC_ASSERT(
1644 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1645 "One or more key attribute flag is listed as both external-only and dual-use")
1646MBEDTLS_STATIC_ASSERT(
1647 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1648 "One or more key attribute flag is listed as both internal-only and dual-use")
1649MBEDTLS_STATIC_ASSERT(
1650 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1651 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001652
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001653/** Validate that a key policy is internally well-formed.
1654 *
1655 * This function only rejects invalid policies. It does not validate the
1656 * consistency of the policy with respect to other attributes of the key
1657 * such as the key type.
1658 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001659static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001660{
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1662 PSA_KEY_USAGE_COPY |
1663 PSA_KEY_USAGE_ENCRYPT |
1664 PSA_KEY_USAGE_DECRYPT |
1665 PSA_KEY_USAGE_SIGN_MESSAGE |
1666 PSA_KEY_USAGE_VERIFY_MESSAGE |
1667 PSA_KEY_USAGE_SIGN_HASH |
1668 PSA_KEY_USAGE_VERIFY_HASH |
1669 PSA_KEY_USAGE_VERIFY_DERIVATION |
1670 PSA_KEY_USAGE_DERIVE)) != 0) {
1671 return PSA_ERROR_INVALID_ARGUMENT;
1672 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001673
Gilles Peskine449bd832023-01-11 14:50:10 +01001674 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001675}
1676
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001677/** Validate the internal consistency of key attributes.
1678 *
1679 * This function only rejects invalid attribute values. If does not
1680 * validate the consistency of the attributes with any key data that may
1681 * be involved in the creation of the key.
1682 *
1683 * Call this function early in the key creation process.
1684 *
1685 * \param[in] attributes Key attributes for the new key.
1686 * \param[out] p_drv On any return, the driver for the key, if any.
1687 * NULL for a transparent key.
1688 *
1689 */
1690static psa_status_t psa_validate_key_attributes(
1691 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001693{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001694 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1696 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698 status = psa_validate_key_location(lifetime, p_drv);
1699 if (status != PSA_SUCCESS) {
1700 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001701 }
1702
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 status = psa_validate_key_persistence(lifetime);
1704 if (status != PSA_SUCCESS) {
1705 return status;
1706 }
1707
1708 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1709 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1710 return PSA_ERROR_INVALID_ARGUMENT;
1711 }
1712 } else {
1713 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1714 return PSA_ERROR_INVALID_ARGUMENT;
1715 }
1716 }
1717
1718 status = psa_validate_key_policy(&attributes->core.policy);
1719 if (status != PSA_SUCCESS) {
1720 return status;
1721 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001722
1723 /* Refuse to create overly large keys.
1724 * Note that this doesn't trigger on import if the attributes don't
1725 * explicitly specify a size (so psa_get_key_bits returns 0), so
1726 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1728 return PSA_ERROR_NOT_SUPPORTED;
1729 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001730
Gilles Peskine91e8c332019-08-02 19:19:39 +02001731 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1733 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1734 return PSA_ERROR_INVALID_ARGUMENT;
1735 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001736
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001738}
1739
Gilles Peskine4747d192019-04-17 15:05:45 +02001740/** Prepare a key slot to receive key material.
1741 *
1742 * This function allocates a key slot and sets its metadata.
1743 *
1744 * If this function fails, call psa_fail_key_creation().
1745 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001746 * This function is intended to be used as follows:
1747 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001748 * it with the specified attributes, and in case of a volatile key assign it
1749 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001750 * -# Populate the slot with the key material.
1751 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1752 * In case of failure at any step, stop the sequence and call
1753 * psa_fail_key_creation().
1754 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001755 * On success, the key slot's state is PSA_SLOT_FILLING.
1756 * It is the responsibility of the caller to change the slot's state to
1757 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001758 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001759 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001760 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001761 * \param[out] p_slot On success, a pointer to the prepared slot.
1762 * \param[out] p_drv On any return, the driver for the key, if any.
1763 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001764 *
1765 * \retval #PSA_SUCCESS
1766 * The key slot is ready to receive key material.
1767 * \return If this function fails, the key slot is an invalid state.
1768 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001769 */
1770static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001771 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001772 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001773 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001775{
1776 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001777 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001778 psa_key_slot_t *slot;
1779
Gilles Peskinedf179142019-07-15 22:02:14 +02001780 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001781 *p_drv = NULL;
1782
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 status = psa_validate_key_attributes(attributes, p_drv);
1784 if (status != PSA_SUCCESS) {
1785 return status;
1786 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001787
Ryan Everettb69118e2024-01-02 15:54:32 +00001788 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 if (status != PSA_SUCCESS) {
1790 return status;
1791 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001792 slot = *p_slot;
1793
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001794 /* We're storing the declared bit-size of the key. It's up to each
1795 * creation mechanism to verify that this information is correct.
1796 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001797 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001798 * is optional (import, copy). In case of a volatile key, assign it the
1799 * volatile key identifier associated to the slot returned to contain its
1800 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001801
1802 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001804#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1805 slot->attr.id = volatile_key_id;
1806#else
1807 slot->attr.id.key_id = volatile_key_id;
1808#endif
1809 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001810
Gilles Peskine91e8c332019-08-02 19:19:39 +02001811 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001812 * external-only flags, query `attributes`. Thanks to the check
1813 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001814 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001815 * may have set. */
1816 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001817
Gilles Peskinecbaff462019-07-12 23:46:04 +02001818#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001819 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001820 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001821 * create the key file in internal storage, create the
1822 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001823 * persistent data. This is done by starting a transaction that will
1824 * encompass these three actions.
1825 * For registering a volatile key, we just need to find an appropriate
1826 * slot number inside the SE. Since the key is designated volatile, creating
1827 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001828 /* The first thing to do is to find a slot number for the new key.
1829 * We save the slot number in persistent storage as part of the
1830 * transaction data. It will be needed to recover if the power
1831 * fails during the key creation process, to clean up on the secure
1832 * element side after restarting. Obtaining a slot number from the
1833 * secure element driver updates its persistent state, but we do not yet
1834 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001835 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001837 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1839 &slot_number);
1840 if (status != PSA_SUCCESS) {
1841 return status;
1842 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001843
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1845 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001846 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001847 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001848 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 status = psa_crypto_save_transaction();
1850 if (status != PSA_SUCCESS) {
1851 (void) psa_crypto_stop_transaction();
1852 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001853 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001854 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001855
1856 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001858 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001859
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001861 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001863 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001864#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1865
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001867}
Gilles Peskine4747d192019-04-17 15:05:45 +02001868
1869/** Finalize the creation of a key once its key material has been set.
1870 *
1871 * This entails writing the key to persistent storage.
1872 *
1873 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001874 * See the documentation of psa_start_key_creation() for the intended use
1875 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001876 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001877 * If the finalization succeeds, the function sets the key slot's state to
1878 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1879 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001880 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001881 * \param[in,out] slot Pointer to the slot with key material.
1882 * \param[in] driver The secure element driver for the key,
1883 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001884 * \param[out] key On success, identifier of the key. Note that the
1885 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001886 *
1887 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001888 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001889 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1890 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1891 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1892 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1893 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1894 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001895 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001896 * \return If this function fails, the key slot is an invalid state.
1897 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001898 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001899static psa_status_t psa_finish_key_creation(
1900 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001901 psa_se_drv_table_entry_t *driver,
1902 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001903{
1904 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001905 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001906 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001907
1908#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001910#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001912 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001913 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001915
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001916 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1917 sizeof(data.slot_number),
1918 "Slot number size does not match psa_se_key_data_storage_t");
1919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1921 status = psa_save_persistent_key(&slot->attr,
1922 (uint8_t *) &data,
1923 sizeof(data));
1924 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001925#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1926 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001927 /* Key material is saved in export representation in the slot, so
1928 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 status = psa_save_persistent_key(&slot->attr,
1930 slot->key.data,
1931 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001932 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001933 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001934#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1935
Gilles Peskinecbaff462019-07-12 23:46:04 +02001936#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001937 /* Finish the transaction for a key creation. This does not
1938 * happen when registering an existing key. Detect this case
1939 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001940 * creation of a persistent key in a secure element requires a transaction,
1941 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 if (driver != NULL &&
1943 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1944 status = psa_save_se_persistent_data(driver);
1945 if (status != PSA_SUCCESS) {
1946 psa_destroy_persistent_key(slot->attr.id);
1947 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001948 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001950 }
1951#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1952
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001954 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001955 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1956 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001958 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001960 }
Ronald Cron50972942020-11-14 11:28:25 +01001961
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001963}
1964
1965/** Abort the creation of a key.
1966 *
1967 * You may call this function after calling psa_start_key_creation(),
1968 * or after psa_finish_key_creation() fails. In other circumstances, this
1969 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001970 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001971 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001972 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001973 * \param[in,out] slot Pointer to the slot with key material.
1974 * \param[in] driver The secure element driver for the key,
1975 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001976 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001977static void psa_fail_key_creation(psa_key_slot_t *slot,
1978 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001979{
Gilles Peskine011e4282019-06-26 18:34:38 +02001980 (void) driver;
1981
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001983 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001985
1986#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001987 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001988 * element, and the failure happened later (when saving metadata
1989 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001990 * element.
1991 * https://github.com/ARMmbed/mbed-crypto/issues/217
1992 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001993
Gilles Peskined7729582019-08-05 15:55:54 +02001994 /* Abort the ongoing transaction if any (there may not be one if
1995 * the creation process failed before starting one, or if the
1996 * key creation is a registration of a key in a secure element).
1997 * Earlier functions must already have done what it takes to undo any
1998 * partial creation. All that's left is to update the transaction data
1999 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002001#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02002004}
2005
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002006/** Validate optional attributes during key creation.
2007 *
2008 * Some key attributes are optional during key creation. If they are
2009 * specified in the attributes structure, check that they are consistent
2010 * with the data in the slot.
2011 *
2012 * This function should be called near the end of key creation, after
2013 * the slot in memory is fully populated but before saving persistent data.
2014 */
2015static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002016 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002018{
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 if (attributes->core.type != 0) {
2020 if (attributes->core.type != slot->attr.type) {
2021 return PSA_ERROR_INVALID_ARGUMENT;
2022 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002023 }
2024
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002026#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2027 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2029 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002030 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002031 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002032 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002033
Ronald Cron90857082020-11-25 14:58:33 +01002034 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 slot->attr.type,
2036 slot->key.data,
2037 slot->key.bytes,
2038 &rsa);
2039 if (status != PSA_SUCCESS) {
2040 return status;
2041 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002042
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 mbedtls_mpi_init(&actual);
2044 mbedtls_mpi_init(&required);
2045 ret = mbedtls_rsa_export(rsa,
2046 NULL, NULL, NULL, NULL, &actual);
2047 mbedtls_rsa_free(rsa);
2048 mbedtls_free(rsa);
2049 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002050 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 }
2052 ret = mbedtls_mpi_read_binary(&required,
2053 attributes->domain_parameters,
2054 attributes->domain_parameters_size);
2055 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002056 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 }
2058 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002059 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 }
2061rsa_exit:
2062 mbedtls_mpi_free(&actual);
2063 mbedtls_mpi_free(&required);
2064 if (ret != 0) {
2065 return mbedtls_to_psa_error(ret);
2066 }
2067 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002068#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2069 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002070 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002071 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002073 }
2074 }
2075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if (attributes->core.bits != 0) {
2077 if (attributes->core.bits != slot->attr.bits) {
2078 return PSA_ERROR_INVALID_ARGUMENT;
2079 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002080 }
2081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002083}
2084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everettf028fe12024-01-08 17:14:44 +00002086 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 size_t data_length,
2088 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002089{
2090 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002091 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002092 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002093 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002094 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302095 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002096
Ronald Cron81709fc2020-11-14 12:10:32 +01002097 *key = MBEDTLS_SVC_KEY_ID_INIT;
2098
Gilles Peskine0f84d622019-09-12 19:03:13 +02002099 /* Reject zero-length symmetric keys (including raw data key objects).
2100 * This also rejects any key which might be encoded as an empty string,
2101 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 if (data_length == 0) {
2103 return PSA_ERROR_INVALID_ARGUMENT;
2104 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002105
Archana449608b2021-09-08 15:36:05 +05302106 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (data_length > SIZE_MAX / 8) {
2108 return PSA_ERROR_NOT_SUPPORTED;
2109 }
Archana6ed4bda2021-08-04 10:47:15 +05302110
Ryan Everettf028fe12024-01-08 17:14:44 +00002111 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2112
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2114 &slot, &driver);
2115 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002116 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002118
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002119 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302120 * storage ( thus not in the case of importing a key in a secure element
2121 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2122 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 if (slot->key.data == NULL) {
2124 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302125 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 attributes, data, data_length, &storage_size);
2127 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302128 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 }
Archanad8a83dc2021-06-14 10:04:16 +05302130 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 status = psa_allocate_buffer_to_slot(slot, storage_size);
2132 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002133 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002135 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002136
2137 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 status = psa_driver_wrapper_import_key(attributes,
2139 data, data_length,
2140 slot->key.data,
2141 slot->key.bytes,
2142 &slot->key.bytes, &bits);
2143 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002144 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002146
Gilles Peskine449bd832023-01-11 14:50:10 +01002147 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002148 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002150 status = PSA_ERROR_INVALID_ARGUMENT;
2151 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002152 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002153
Archana6ed4bda2021-08-04 10:47:15 +05302154 /* Enforce a size limit, and in particular ensure that the bit
2155 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302157 status = PSA_ERROR_NOT_SUPPORTED;
2158 goto exit;
2159 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 status = psa_validate_optional_attributes(slot, attributes);
2161 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002162 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002164
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002166exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002167 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (status != PSA_SUCCESS) {
2169 psa_fail_key_creation(slot, driver);
2170 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002171
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002173}
2174
Gilles Peskined7729582019-08-05 15:55:54 +02002175#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2176psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002178{
2179 psa_status_t status;
2180 psa_key_slot_t *slot = NULL;
2181 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002182 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002183
2184 /* Leaving attributes unspecified is not currently supported.
2185 * It could make sense to query the key type and size from the
2186 * secure element, but not all secure elements support this
2187 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2189 return PSA_ERROR_NOT_SUPPORTED;
2190 }
2191 if (psa_get_key_bits(attributes) == 0) {
2192 return PSA_ERROR_NOT_SUPPORTED;
2193 }
Gilles Peskined7729582019-08-05 15:55:54 +02002194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2196 &slot, &driver);
2197 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002198 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 }
Gilles Peskined7729582019-08-05 15:55:54 +02002200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002202
2203exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if (status != PSA_SUCCESS) {
2205 psa_fail_key_creation(slot, driver);
2206 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002207
Gilles Peskined7729582019-08-05 15:55:54 +02002208 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 psa_close_key(key);
2210 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002211}
2212#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2215 const psa_key_attributes_t *specified_attributes,
2216 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002217{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002218 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002219 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002220 psa_key_slot_t *source_slot = NULL;
2221 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002222 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002223 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302224 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002225
Ronald Cron81709fc2020-11-14 12:10:32 +01002226 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2227
Archana8a180362021-07-05 02:18:48 +05302228 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2230 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002231 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002233
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 status = psa_validate_optional_attributes(source_slot,
2235 specified_attributes);
2236 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002237 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002239
Archana9d17bf42021-09-10 06:22:44 +05302240 /* The target key type and number of bits have been validated by
2241 * psa_validate_optional_attributes() to be either equal to zero or
2242 * equal to the ones of the source key. So it is safe to inherit
2243 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302244 * */
Archana9d17bf42021-09-10 06:22:44 +05302245 actual_attributes.core.bits = source_slot->attr.bits;
2246 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302247
2248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 status = psa_restrict_key_policy(source_slot->attr.type,
2250 &actual_attributes.core.policy,
2251 &source_slot->attr.policy);
2252 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002253 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2257 &target_slot, &driver);
2258 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002259 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 }
2261 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2262 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302263 /*
Archana9d17bf42021-09-10 06:22:44 +05302264 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302265 * the source key would need to be exported as plaintext and re-imported
2266 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302267 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302268 * appropriate API invocations from the application, if needed.
2269 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002270 status = PSA_ERROR_NOT_SUPPORTED;
2271 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002272 }
Archana8a180362021-07-05 02:18:48 +05302273 /*
2274 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302275 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302276 * - For opaque keys this translates to an invocation of the drivers'
2277 * copy_key entry point through the dispatch layer.
2278 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2280 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2281 &storage_size);
2282 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302283 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 }
Archana374fe5b2021-09-08 15:50:28 +05302285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2287 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302288 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 }
Archana374fe5b2021-09-08 15:50:28 +05302290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 status = psa_driver_wrapper_copy_key(&actual_attributes,
2292 source_slot->key.data,
2293 source_slot->key.bytes,
2294 target_slot->key.data,
2295 target_slot->key.bytes,
2296 &target_slot->key.bytes);
2297 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302298 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 }
2300 } else {
2301 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302302 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 source_slot->key.bytes);
2304 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302305 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 }
Archana8a180362021-07-05 02:18:48 +05302307 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002309exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 if (status != PSA_SUCCESS) {
2311 psa_fail_key_creation(target_slot, driver);
2312 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002313
Ryan Everett1b70a072024-01-04 10:32:49 +00002314 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002317}
2318
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002319
2320
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002321/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002322/* Message digests */
2323/****************************************************************/
2324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002326{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002327 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 if (operation->id == 0) {
2329 return PSA_SUCCESS;
2330 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002333 operation->id = 0;
2334
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002336}
2337
Gilles Peskine449bd832023-01-11 14:50:10 +01002338psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2339 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002340{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002341 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002342
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002343 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002345 status = PSA_ERROR_BAD_STATE;
2346 goto exit;
2347 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002348
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002350 status = PSA_ERROR_INVALID_ARGUMENT;
2351 goto exit;
2352 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002353
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002354 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2355 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002359
2360exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (status != PSA_SUCCESS) {
2362 psa_hash_abort(operation);
2363 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002364
2365 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002366}
2367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2369 const uint8_t *input,
2370 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002371{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002372 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002375 status = PSA_ERROR_BAD_STATE;
2376 goto exit;
2377 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002378
Steven Cooremanc8288352021-03-04 14:02:19 +01002379 /* Don't require hash implementations to behave correctly on a
2380 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 if (input_length == 0) {
2382 return PSA_SUCCESS;
2383 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002384
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002386
2387exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 if (status != PSA_SUCCESS) {
2389 psa_hash_abort(operation);
2390 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002391
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002393}
2394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2396 uint8_t *hash,
2397 size_t hash_size,
2398 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002399{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002400 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 if (operation->id == 0) {
2402 return PSA_ERROR_BAD_STATE;
2403 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002404
Steven Cooreman1e582352021-02-18 17:24:37 +01002405 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 operation, hash, hash_size, hash_length);
2407 psa_hash_abort(operation);
2408 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002409}
2410
Gilles Peskine449bd832023-01-11 14:50:10 +01002411psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2412 const uint8_t *hash,
2413 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002414{
Ronald Cron69a63422021-10-18 09:47:58 +02002415 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002416 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002417 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 operation,
2419 actual_hash, sizeof(actual_hash),
2420 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002421
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002423 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002427 status = PSA_ERROR_INVALID_SIGNATURE;
2428 goto exit;
2429 }
2430
Dave Rodgman78701152023-08-29 14:20:18 +01002431 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002432 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002434
2435exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2437 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002438 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002440
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002442}
2443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444psa_status_t psa_hash_compute(psa_algorithm_t alg,
2445 const uint8_t *input, size_t input_length,
2446 uint8_t *hash, size_t hash_size,
2447 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002448{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002449 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 if (!PSA_ALG_IS_HASH(alg)) {
2451 return PSA_ERROR_INVALID_ARGUMENT;
2452 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2455 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002456}
2457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458psa_status_t psa_hash_compare(psa_algorithm_t alg,
2459 const uint8_t *input, size_t input_length,
2460 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002461{
Ronald Cron69a63422021-10-18 09:47:58 +02002462 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002463 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 if (!PSA_ALG_IS_HASH(alg)) {
2466 return PSA_ERROR_INVALID_ARGUMENT;
2467 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002468
Steven Cooreman1e582352021-02-18 17:24:37 +01002469 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 alg, input, input_length,
2471 actual_hash, sizeof(actual_hash),
2472 &actual_hash_length);
2473 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002474 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 }
2476 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002477 status = PSA_ERROR_INVALID_SIGNATURE;
2478 goto exit;
2479 }
Dave Rodgman78701152023-08-29 14:20:18 +01002480 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002481 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002483
2484exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2486 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002487}
2488
Gilles Peskine449bd832023-01-11 14:50:10 +01002489psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2490 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002491{
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 if (source_operation->id == 0 ||
2493 target_operation->id != 0) {
2494 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002495 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002496
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2498 target_operation);
2499 if (status != PSA_SUCCESS) {
2500 psa_hash_abort(target_operation);
2501 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002502
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002504}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002505
2506
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002507/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002508/* MAC */
2509/****************************************************************/
2510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002512{
Steven Cooremane6804192021-03-19 18:28:56 +01002513 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 if (operation->id == 0) {
2515 return PSA_SUCCESS;
2516 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002517
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002519 operation->mac_size = 0;
2520 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002521 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002522
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002524}
2525
Ronald Cron2dff3b22021-06-17 16:33:22 +02002526static psa_status_t psa_mac_finalize_alg_and_key_validation(
2527 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002528 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002530{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002531 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 psa_key_type_t key_type = psa_get_key_type(attributes);
2533 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 if (!PSA_ALG_IS_MAC(alg)) {
2536 return PSA_ERROR_INVALID_ARGUMENT;
2537 }
Steven Cooremane6804192021-03-19 18:28:56 +01002538
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002539 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 status = psa_mac_key_can_do(alg, key_type);
2541 if (status != PSA_SUCCESS) {
2542 return status;
2543 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002544
Steven Cooremand1a68f12021-05-10 11:13:41 +02002545 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002549 /* A very short MAC is too short for security since it can be
2550 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2551 * so we make this our minimum, even though 32 bits is still
2552 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002554 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2557 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002558 /* It's impossible to "truncate" to a larger length than the full length
2559 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002561 }
2562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002564 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2565 * that is disabled in the compile-time configuration. The result can
2566 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2567 * configuration into account. In this case, force a return of
2568 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2569 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2570 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2571 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2572 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002574 }
2575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002577}
2578
Gilles Peskine449bd832023-01-11 14:50:10 +01002579static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2580 mbedtls_svc_key_id_t key,
2581 psa_algorithm_t alg,
2582 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002583{
2584 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2585 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002586 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002587 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002588
2589 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002591 status = PSA_ERROR_BAD_STATE;
2592 goto exit;
2593 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002594
2595 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 key,
2597 &slot,
2598 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2599 alg);
2600 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002601 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002603
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002604 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002605 .core = slot->attr
2606 };
2607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2609 &operation->mac_size);
2610 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002611 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002613
2614 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002615 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (is_sign) {
2617 status = psa_driver_wrapper_mac_sign_setup(operation,
2618 &attributes,
2619 slot->key.data,
2620 slot->key.bytes,
2621 alg);
2622 } else {
2623 status = psa_driver_wrapper_mac_verify_setup(operation,
2624 &attributes,
2625 slot->key.data,
2626 slot->key.bytes,
2627 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002628 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002629
Gilles Peskinefbfac682018-07-08 20:51:54 +02002630exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 if (status != PSA_SUCCESS) {
2632 psa_mac_abort(operation);
2633 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002634
Ryan Everett1b70a072024-01-04 10:32:49 +00002635 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002638}
2639
Gilles Peskine449bd832023-01-11 14:50:10 +01002640psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2641 mbedtls_svc_key_id_t key,
2642 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002643{
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002645}
2646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2648 mbedtls_svc_key_id_t key,
2649 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002650{
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002652}
2653
Gilles Peskine449bd832023-01-11 14:50:10 +01002654psa_status_t psa_mac_update(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002655 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002657{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002658 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2659 LOCAL_INPUT_DECLARE(input_external, input);
2660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if (operation->id == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002662 status = PSA_ERROR_BAD_STATE;
2663 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002665
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002666 /* Don't require hash implementations to behave correctly on a
2667 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 if (input_length == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002669 status = PSA_SUCCESS;
2670 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002672
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002673 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2674 status = psa_driver_wrapper_mac_update(operation, input, input_length);
2675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 if (status != PSA_SUCCESS) {
2677 psa_mac_abort(operation);
2678 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002679
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002680#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002681exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002682#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002683 LOCAL_INPUT_FREE(input_external, input);
2684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002686}
2687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002689 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 size_t mac_size,
2691 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002692{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002693 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2694 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002695 LOCAL_OUTPUT_DECLARE(mac_external, mac);
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002696 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002697
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002699 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002700 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002701 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002702
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002704 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002705 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002706 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002707
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002708 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2709 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002711 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002712 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002713 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002714
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002716 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002717 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002718 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002719
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002720
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 status = psa_driver_wrapper_mac_sign_finish(operation,
2722 mac, operation->mac_size,
2723 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002724
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002725exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002726 /* In case of success, set the potential excess room in the output buffer
2727 * to an invalid value, to avoid potentially leaking a longer MAC.
2728 * In case of error, set the output length and content to a safe default,
2729 * such that in case the caller misses an error check, the output would be
2730 * an unachievable MAC.
2731 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002733 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002734 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002735 }
mohammad16036df908f2018-04-02 08:34:15 -07002736
Thomas Daubney03f1ea32024-02-01 16:16:27 +00002737 if (mac != NULL) {
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002738 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
2739 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002740
Gilles Peskine449bd832023-01-11 14:50:10 +01002741 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002742 LOCAL_OUTPUT_FREE(mac_external, mac);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002743
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002745}
2746
Gilles Peskine449bd832023-01-11 14:50:10 +01002747psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002748 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002750{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002751 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2752 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002753 LOCAL_INPUT_DECLARE(mac_external, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002754
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002756 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002757 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002758 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002759
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002761 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002762 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002763 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002764
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002766 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002767 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002768 }
2769
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002770 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 status = psa_driver_wrapper_mac_verify_finish(operation,
2772 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002773
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002774exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002776 LOCAL_INPUT_FREE(mac_external, mac);
mohammad16036df908f2018-04-02 08:34:15 -07002777
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002779}
2780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2782 psa_algorithm_t alg,
2783 const uint8_t *input,
2784 size_t input_length,
2785 uint8_t *mac,
2786 size_t mac_size,
2787 size_t *mac_length,
2788 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002789{
2790 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002791 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2792 psa_key_slot_t *slot;
2793 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002794 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002795
Ronald Cron51131b52021-06-17 17:17:20 +02002796 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 key,
2798 &slot,
2799 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2800 alg);
2801 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002802 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002804
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002805 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002806 .core = slot->attr
2807 };
2808
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2810 &operation_mac_size);
2811 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002812 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002816 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002817 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002818 }
2819
2820 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 &attributes,
2822 slot->key.data, slot->key.bytes,
2823 alg,
2824 input, input_length,
2825 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002826
2827exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002828 /* In case of success, set the potential excess room in the output buffer
2829 * to an invalid value, to avoid potentially leaking a longer MAC.
2830 * In case of error, set the output length and content to a safe default,
2831 * such that in case the caller misses an error check, the output would be
2832 * an unachievable MAC.
2833 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002835 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002836 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002837 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002838
2839 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002840
Ryan Everett1b70a072024-01-04 10:32:49 +00002841 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002842
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002844}
2845
Gilles Peskine449bd832023-01-11 14:50:10 +01002846psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002847 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002848 const uint8_t *input_external,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002849 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002850 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 size_t mac_size,
2852 size_t *mac_length)
2853{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002854 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2855 LOCAL_INPUT_DECLARE(input_external, input);
2856 LOCAL_OUTPUT_DECLARE(mac_external, mac);
2857
2858 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2859 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
2860 status = psa_mac_compute_internal(key, alg,
Thomas Daubney7480a742024-01-30 11:29:47 +00002861 input, input_length,
2862 mac, mac_size, mac_length, 1);
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002863
2864#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002865exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002866#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002867 LOCAL_INPUT_FREE(input_external, input);
2868 LOCAL_OUTPUT_FREE(mac_external, mac);
2869
2870 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002871}
2872
2873psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2874 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002875 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002877 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002879{
2880 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002881 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2882 size_t actual_mac_length;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002883 LOCAL_INPUT_DECLARE(input_external, input);
2884 LOCAL_INPUT_DECLARE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002885
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002886 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 status = psa_mac_compute_internal(key, alg,
2888 input, input_length,
2889 actual_mac, sizeof(actual_mac),
2890 &actual_mac_length, 0);
2891 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002892 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002894
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002896 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002897 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002898 }
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002899
2900 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Dave Rodgman78701152023-08-29 14:20:18 +01002901 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002902 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002903 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002904 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002905
2906exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002908 LOCAL_INPUT_FREE(input_external, input);
2909 LOCAL_INPUT_FREE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002912}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002913
Gilles Peskinee59236f2018-01-27 23:32:46 +01002914/****************************************************************/
2915/* Asymmetric cryptography */
2916/****************************************************************/
2917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2919 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002920{
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 if (input_is_message) {
2922 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2923 return PSA_ERROR_INVALID_ARGUMENT;
2924 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2927 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2928 return PSA_ERROR_INVALID_ARGUMENT;
2929 }
2930 }
2931 } else {
2932 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2933 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002934 }
2935 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002938}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002939
Gilles Peskine449bd832023-01-11 14:50:10 +01002940static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2941 int input_is_message,
2942 psa_algorithm_t alg,
2943 const uint8_t *input,
2944 size_t input_length,
2945 uint8_t *signature,
2946 size_t signature_size,
2947 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002948{
2949 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2950 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2951 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002952 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002953
2954 *signature_length = 0;
2955
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 status = psa_sign_verify_check_alg(input_is_message, alg);
2957 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002958 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002960
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002961 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002962 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002963 * buffer can in principle be empty since it doesn't actually have
2964 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 if (signature_size == 0) {
2966 return PSA_ERROR_BUFFER_TOO_SMALL;
2967 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002968
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002969 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 key, &slot,
2971 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2972 PSA_KEY_USAGE_SIGN_HASH,
2973 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002974
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002976 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002978
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002980 status = PSA_ERROR_INVALID_ARGUMENT;
2981 goto exit;
2982 }
2983
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002984 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002986 };
2987
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002989 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002990 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002991 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 signature, signature_size, signature_length);
2993 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002994
2995 status = psa_driver_wrapper_sign_hash(
2996 &attributes, slot->key.data, slot->key.bytes,
2997 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002999 }
3000
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003001
3002exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003003 psa_wipe_tag_output_buffer(signature, status, signature_size,
3004 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003005
Ryan Everett1b70a072024-01-04 10:32:49 +00003006 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003009}
3010
Gilles Peskine449bd832023-01-11 14:50:10 +01003011static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3012 int input_is_message,
3013 psa_algorithm_t alg,
3014 const uint8_t *input,
3015 size_t input_length,
3016 const uint8_t *signature,
3017 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003018{
3019 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3020 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3021 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003022
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 status = psa_sign_verify_check_alg(input_is_message, alg);
3024 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003025 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003027
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003028 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 key, &slot,
3030 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3031 PSA_KEY_USAGE_VERIFY_HASH,
3032 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003033
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 if (status != PSA_SUCCESS) {
3035 return status;
3036 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003037
3038 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003040 };
3041
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003043 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003044 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003045 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 signature, signature_length);
3047 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003048 status = psa_driver_wrapper_verify_hash(
3049 &attributes, slot->key.data, slot->key.bytes,
3050 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003052 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003053
Ryan Everett1b70a072024-01-04 10:32:49 +00003054 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003055
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003057
3058}
3059
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003060psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003061 const psa_key_attributes_t *attributes,
3062 const uint8_t *key_buffer,
3063 size_t key_buffer_size,
3064 psa_algorithm_t alg,
3065 const uint8_t *input,
3066 size_t input_length,
3067 uint8_t *signature,
3068 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003070{
3071 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003074 size_t hash_length;
3075 uint8_t hash[PSA_HASH_MAX_SIZE];
3076
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003077 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 PSA_ALG_SIGN_GET_HASH(alg),
3079 input, input_length,
3080 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003083 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003085
3086 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 attributes, key_buffer, key_buffer_size,
3088 alg, hash, hash_length,
3089 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003090 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003091
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003093}
3094
Gilles Peskine449bd832023-01-11 14:50:10 +01003095psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3096 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003097 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003099 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 size_t signature_size,
3101 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003102{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003103 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3104 LOCAL_INPUT_DECLARE(input_external, input);
3105 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3106
3107 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3108 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3109 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3110 signature_size, signature_length);
3111
Thomas Daubney3e65f522024-01-30 12:37:25 +00003112#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003113exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003114#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003115 LOCAL_INPUT_FREE(input_external, input);
3116 LOCAL_OUTPUT_FREE(signature_external, signature);
3117 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003118}
3119
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003120psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003121 const psa_key_attributes_t *attributes,
3122 const uint8_t *key_buffer,
3123 size_t key_buffer_size,
3124 psa_algorithm_t alg,
3125 const uint8_t *input,
3126 size_t input_length,
3127 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003129{
3130 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003131
Gilles Peskine449bd832023-01-11 14:50:10 +01003132 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003133 size_t hash_length;
3134 uint8_t hash[PSA_HASH_MAX_SIZE];
3135
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003136 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 PSA_ALG_SIGN_GET_HASH(alg),
3138 input, input_length,
3139 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003140
Gilles Peskine449bd832023-01-11 14:50:10 +01003141 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003142 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003143 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003144
3145 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 attributes, key_buffer, key_buffer_size,
3147 alg, hash, hash_length,
3148 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003149 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003150
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003152}
3153
Gilles Peskine449bd832023-01-11 14:50:10 +01003154psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3155 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003156 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003157 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003158 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003160{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003161 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3162 LOCAL_INPUT_DECLARE(input_external, input);
3163 LOCAL_INPUT_DECLARE(signature_external, signature);
3164
3165 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3166 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3167 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3168 signature_length);
3169
Thomas Daubney3e65f522024-01-30 12:37:25 +00003170#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003171exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003172#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003173 LOCAL_INPUT_FREE(input_external, input);
3174 LOCAL_INPUT_FREE(signature_external, signature);
3175
3176 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003177}
3178
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003179psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003180 const psa_key_attributes_t *attributes,
3181 const uint8_t *key_buffer, size_t key_buffer_size,
3182 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003184{
Gilles Peskine449bd832023-01-11 14:50:10 +01003185 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3186 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3187 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003188#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003189 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3190 return mbedtls_psa_rsa_sign_hash(
3191 attributes,
3192 key_buffer, key_buffer_size,
3193 alg, hash, hash_length,
3194 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003195#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3196 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 } else {
3198 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003199 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003200 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3201 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003202#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003203 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3204 return mbedtls_psa_ecdsa_sign_hash(
3205 attributes,
3206 key_buffer, key_buffer_size,
3207 alg, hash, hash_length,
3208 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003209#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3210 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003211 } else {
3212 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003213 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003214 }
Ronald Cron4501c982021-03-19 20:09:32 +01003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 (void) key_buffer;
3217 (void) key_buffer_size;
3218 (void) hash;
3219 (void) hash_length;
3220 (void) signature;
3221 (void) signature_size;
3222 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003223
Gilles Peskine449bd832023-01-11 14:50:10 +01003224 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003225}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003226
Gilles Peskine449bd832023-01-11 14:50:10 +01003227psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3228 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003229 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003231 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 size_t signature_size,
3233 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003234{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003235 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3236 LOCAL_INPUT_DECLARE(hash_external, hash);
3237 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3238
3239 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3240 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3241 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3242 signature_size, signature_length);
3243
Thomas Daubney3e65f522024-01-30 12:37:25 +00003244#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003245exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003246#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003247 LOCAL_INPUT_FREE(hash_external, hash);
3248 LOCAL_OUTPUT_FREE(signature_external, signature);
3249
3250 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003251}
3252
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003253psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003254 const psa_key_attributes_t *attributes,
3255 const uint8_t *key_buffer, size_t key_buffer_size,
3256 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003257 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003258{
Gilles Peskine449bd832023-01-11 14:50:10 +01003259 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3260 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3261 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003262#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3264 return mbedtls_psa_rsa_verify_hash(
3265 attributes,
3266 key_buffer, key_buffer_size,
3267 alg, hash, hash_length,
3268 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003269#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3270 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003271 } else {
3272 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003273 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3275 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003276#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003277 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3278 return mbedtls_psa_ecdsa_verify_hash(
3279 attributes,
3280 key_buffer, key_buffer_size,
3281 alg, hash, hash_length,
3282 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003283#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3284 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 } else {
3286 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003287 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003288 }
Ronald Cron4501c982021-03-19 20:09:32 +01003289
Gilles Peskine449bd832023-01-11 14:50:10 +01003290 (void) key_buffer;
3291 (void) key_buffer_size;
3292 (void) hash;
3293 (void) hash_length;
3294 (void) signature;
3295 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003296
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003298}
3299
Gilles Peskine449bd832023-01-11 14:50:10 +01003300psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3301 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003302 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003304 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003306{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003307 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3308 LOCAL_INPUT_DECLARE(hash_external, hash);
3309 LOCAL_INPUT_DECLARE(signature_external, signature);
3310
3311 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3312 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3313 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3314 signature_length);
3315
Thomas Daubney3e65f522024-01-30 12:37:25 +00003316#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003317exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003318#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003319 LOCAL_INPUT_FREE(hash_external, hash);
3320 LOCAL_INPUT_FREE(signature_external, signature);
3321
3322 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003323}
3324
Gilles Peskine449bd832023-01-11 14:50:10 +01003325psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3326 psa_algorithm_t alg,
3327 const uint8_t *input,
3328 size_t input_length,
3329 const uint8_t *salt,
3330 size_t salt_length,
3331 uint8_t *output,
3332 size_t output_size,
3333 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003334{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003335 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003336 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003337 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003338 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003339
Darryl Green5cc689a2018-07-24 15:34:10 +01003340 (void) input;
3341 (void) input_length;
3342 (void) salt;
3343 (void) output;
3344 (void) output_size;
3345
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003346 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003347
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3349 return PSA_ERROR_INVALID_ARGUMENT;
3350 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003351
Valerio Setti5bb454a2024-01-15 10:43:16 +01003352 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003353 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3354 if (status != PSA_SUCCESS) {
3355 return status;
3356 }
3357 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3358 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003359 status = PSA_ERROR_INVALID_ARGUMENT;
3360 goto exit;
3361 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003362
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003363 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003365 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003366
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003367 status = psa_driver_wrapper_asymmetric_encrypt(
3368 &attributes, slot->key.data, slot->key.bytes,
3369 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003371exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003372 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003373
Gilles Peskine449bd832023-01-11 14:50:10 +01003374 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003375}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003376
Gilles Peskine449bd832023-01-11 14:50:10 +01003377psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3378 psa_algorithm_t alg,
3379 const uint8_t *input,
3380 size_t input_length,
3381 const uint8_t *salt,
3382 size_t salt_length,
3383 uint8_t *output,
3384 size_t output_size,
3385 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003386{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003387 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003388 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003389 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003390 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003391
Darryl Green5cc689a2018-07-24 15:34:10 +01003392 (void) input;
3393 (void) input_length;
3394 (void) salt;
3395 (void) output;
3396 (void) output_size;
3397
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003398 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003399
Gilles Peskine449bd832023-01-11 14:50:10 +01003400 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3401 return PSA_ERROR_INVALID_ARGUMENT;
3402 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003403
Valerio Setti5bb454a2024-01-15 10:43:16 +01003404 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3406 if (status != PSA_SUCCESS) {
3407 return status;
3408 }
3409 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003410 status = PSA_ERROR_INVALID_ARGUMENT;
3411 goto exit;
3412 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003413
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003414 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003415 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003416 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003417
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003418 status = psa_driver_wrapper_asymmetric_decrypt(
3419 &attributes, slot->key.data, slot->key.bytes,
3420 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003421 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003422
3423exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003424 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003425
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003427}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003428
Paul Elliott9fe12f62022-11-30 19:16:02 +00003429/****************************************************************/
3430/* Asymmetric interruptible cryptography */
3431/****************************************************************/
3432
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003433static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3434
Paul Elliott9fe12f62022-11-30 19:16:02 +00003435void psa_interruptible_set_max_ops(uint32_t max_ops)
3436{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003437 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003438}
3439
3440uint32_t psa_interruptible_get_max_ops(void)
3441{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003442 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003443}
3444
Paul Elliott9fe12f62022-11-30 19:16:02 +00003445uint32_t psa_sign_hash_get_num_ops(
3446 const psa_sign_hash_interruptible_operation_t *operation)
3447{
Paul Elliott296ede92022-12-15 17:00:30 +00003448 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003449}
3450
3451uint32_t psa_verify_hash_get_num_ops(
3452 const psa_verify_hash_interruptible_operation_t *operation)
3453{
Paul Elliott296ede92022-12-15 17:00:30 +00003454 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003455}
3456
Paul Elliott59ad9452022-12-18 15:09:02 +00003457static psa_status_t psa_sign_hash_abort_internal(
3458 psa_sign_hash_interruptible_operation_t *operation)
3459{
3460 if (operation->id == 0) {
3461 /* The object has (apparently) been initialized but it is not (yet)
3462 * in use. It's ok to call abort on such an object, and there's
3463 * nothing to do. */
3464 return PSA_SUCCESS;
3465 }
3466
3467 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3468
3469 status = psa_driver_wrapper_sign_hash_abort(operation);
3470
3471 operation->id = 0;
3472
Paul Elliotte6145dc2023-02-07 12:51:21 +00003473 /* Do not clear either the error_occurred or num_ops elements here as they
3474 * only want to be cleared by the application calling abort, not by abort
3475 * being called at completion of an operation. */
3476
Paul Elliott59ad9452022-12-18 15:09:02 +00003477 return status;
3478}
3479
Paul Elliott9fe12f62022-11-30 19:16:02 +00003480psa_status_t psa_sign_hash_start(
3481 psa_sign_hash_interruptible_operation_t *operation,
3482 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3483 const uint8_t *hash, size_t hash_length)
3484{
3485 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3486 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3487 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003488 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003489
Paul Elliottc9774412023-02-06 15:14:07 +00003490 /* Check that start has not been previously called, or operation has not
3491 * previously errored. */
3492 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003493 return PSA_ERROR_BAD_STATE;
3494 }
3495
Paul Elliott9fe12f62022-11-30 19:16:02 +00003496 status = psa_sign_verify_check_alg(0, alg);
3497 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003498 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003499 return status;
3500 }
3501
3502 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3503 PSA_KEY_USAGE_SIGN_HASH,
3504 alg);
3505
3506 if (status != PSA_SUCCESS) {
3507 goto exit;
3508 }
3509
3510 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3511 status = PSA_ERROR_INVALID_ARGUMENT;
3512 goto exit;
3513 }
3514
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003515 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003516 .core = slot->attr
3517 };
3518
Paul Elliott296ede92022-12-15 17:00:30 +00003519 /* Ensure ops count gets reset, in case of operation re-use. */
3520 operation->num_ops = 0;
3521
Paul Elliott9fe12f62022-11-30 19:16:02 +00003522 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3523 slot->key.data,
3524 slot->key.bytes, alg,
3525 hash, hash_length);
3526exit:
3527
3528 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003529 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003530 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003531 }
3532
Ryan Everett1b70a072024-01-04 10:32:49 +00003533 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003534
Paul Elliottc9774412023-02-06 15:14:07 +00003535 if (unlock_status != PSA_SUCCESS) {
3536 operation->error_occurred = 1;
3537 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003538
Paul Elliottc9774412023-02-06 15:14:07 +00003539 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003540}
3541
3542
3543psa_status_t psa_sign_hash_complete(
3544 psa_sign_hash_interruptible_operation_t *operation,
3545 uint8_t *signature, size_t signature_size,
3546 size_t *signature_length)
3547{
3548 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3549
3550 *signature_length = 0;
3551
Paul Elliottc9774412023-02-06 15:14:07 +00003552 /* Check that start has been called first, and that operation has not
3553 * previously errored. */
3554 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003555 status = PSA_ERROR_BAD_STATE;
3556 goto exit;
3557 }
3558
Paul Elliott096abc42023-02-03 18:33:23 +00003559 /* Immediately reject a zero-length signature buffer. This guarantees that
3560 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003561 if (signature_size == 0) {
3562 status = PSA_ERROR_BUFFER_TOO_SMALL;
3563 goto exit;
3564 }
3565
3566 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3567 signature_size,
3568 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003569
Paul Elliott296ede92022-12-15 17:00:30 +00003570 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003571 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003572
Paul Elliottebe225c2023-02-10 14:32:53 +00003573exit:
3574
Paul Elliott59200a22023-02-21 15:07:40 +00003575 psa_wipe_tag_output_buffer(signature, status, signature_size,
3576 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003577
Paul Elliott53bb3122023-02-10 14:22:22 +00003578 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003579 if (status != PSA_SUCCESS) {
3580 operation->error_occurred = 1;
3581 }
3582
Paul Elliott59ad9452022-12-18 15:09:02 +00003583 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003584 }
3585
3586 return status;
3587}
3588
3589psa_status_t psa_sign_hash_abort(
3590 psa_sign_hash_interruptible_operation_t *operation)
3591{
Paul Elliott59ad9452022-12-18 15:09:02 +00003592 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3593
3594 status = psa_sign_hash_abort_internal(operation);
3595
3596 /* We clear the number of ops done here, so that it is not cleared when
3597 * the operation fails or succeeds, only on manual abort. */
3598 operation->num_ops = 0;
3599
Paul Elliottc9774412023-02-06 15:14:07 +00003600 /* Likewise, failure state. */
3601 operation->error_occurred = 0;
3602
Paul Elliott59ad9452022-12-18 15:09:02 +00003603 return status;
3604}
3605
3606static psa_status_t psa_verify_hash_abort_internal(
3607 psa_verify_hash_interruptible_operation_t *operation)
3608{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003609 if (operation->id == 0) {
3610 /* The object has (apparently) been initialized but it is not (yet)
3611 * in use. It's ok to call abort on such an object, and there's
3612 * nothing to do. */
3613 return PSA_SUCCESS;
3614 }
3615
Paul Elliott59ad9452022-12-18 15:09:02 +00003616 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3617
3618 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003619
3620 operation->id = 0;
3621
Paul Elliotte6145dc2023-02-07 12:51:21 +00003622 /* Do not clear either the error_occurred or num_ops elements here as they
3623 * only want to be cleared by the application calling abort, not by abort
3624 * being called at completion of an operation. */
3625
Paul Elliott59ad9452022-12-18 15:09:02 +00003626 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003627}
3628
3629psa_status_t psa_verify_hash_start(
3630 psa_verify_hash_interruptible_operation_t *operation,
3631 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3632 const uint8_t *hash, size_t hash_length,
3633 const uint8_t *signature, size_t signature_length)
3634{
3635 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3636 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3637 psa_key_slot_t *slot;
3638
Paul Elliottc9774412023-02-06 15:14:07 +00003639 /* Check that start has not been previously called, or operation has not
3640 * previously errored. */
3641 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003642 return PSA_ERROR_BAD_STATE;
3643 }
3644
3645 status = psa_sign_verify_check_alg(0, alg);
3646 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003647 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003648 return status;
3649 }
3650
3651 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3652 PSA_KEY_USAGE_VERIFY_HASH,
3653 alg);
3654
3655 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003656 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003657 return status;
3658 }
3659
3660 psa_key_attributes_t attributes = {
3661 .core = slot->attr
3662 };
3663
Paul Elliott296ede92022-12-15 17:00:30 +00003664 /* Ensure ops count gets reset, in case of operation re-use. */
3665 operation->num_ops = 0;
3666
Paul Elliott9fe12f62022-11-30 19:16:02 +00003667 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3668 slot->key.data,
3669 slot->key.bytes,
3670 alg, hash, hash_length,
3671 signature, signature_length);
3672
3673 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003674 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003675 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003676 }
3677
Ryan Everett1b70a072024-01-04 10:32:49 +00003678 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003679
Paul Elliottc9774412023-02-06 15:14:07 +00003680 if (unlock_status != PSA_SUCCESS) {
3681 operation->error_occurred = 1;
3682 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003683
Paul Elliottc9774412023-02-06 15:14:07 +00003684 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003685}
3686
3687psa_status_t psa_verify_hash_complete(
3688 psa_verify_hash_interruptible_operation_t *operation)
3689{
3690 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3691
Paul Elliottc9774412023-02-06 15:14:07 +00003692 /* Check that start has been called first, and that operation has not
3693 * previously errored. */
3694 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003695 status = PSA_ERROR_BAD_STATE;
3696 goto exit;
3697 }
3698
3699 status = psa_driver_wrapper_verify_hash_complete(operation);
3700
Paul Elliott296ede92022-12-15 17:00:30 +00003701 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003702 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003703 operation);
3704
Paul Elliottebe225c2023-02-10 14:32:53 +00003705exit:
3706
Paul Elliott9fe12f62022-11-30 19:16:02 +00003707 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003708 if (status != PSA_SUCCESS) {
3709 operation->error_occurred = 1;
3710 }
3711
Paul Elliott59ad9452022-12-18 15:09:02 +00003712 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003713 }
3714
3715 return status;
3716}
3717
3718psa_status_t psa_verify_hash_abort(
3719 psa_verify_hash_interruptible_operation_t *operation)
3720{
Paul Elliott59ad9452022-12-18 15:09:02 +00003721 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003722
Paul Elliott59ad9452022-12-18 15:09:02 +00003723 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003724
Paul Elliott59ad9452022-12-18 15:09:02 +00003725 /* We clear the number of ops done here, so that it is not cleared when
3726 * the operation fails or succeeds, only on manual abort. */
3727 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003728
Paul Elliottc9774412023-02-06 15:14:07 +00003729 /* Likewise, failure state. */
3730 operation->error_occurred = 0;
3731
Paul Elliott59ad9452022-12-18 15:09:02 +00003732 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003733}
3734
Paul Elliott588f8ed2022-12-02 18:10:26 +00003735/****************************************************************/
3736/* Asymmetric interruptible cryptography internal */
3737/* implementations */
3738/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003739
Paul Elliott588f8ed2022-12-02 18:10:26 +00003740void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3741{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003742
Paul Elliott588f8ed2022-12-02 18:10:26 +00003743#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3744 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3745 defined(MBEDTLS_ECP_RESTARTABLE)
3746
3747 /* Internal implementation uses zero to indicate infinite number max ops,
3748 * therefore avoid this value, and set to minimum possible. */
3749 if (max_ops == 0) {
3750 max_ops = 1;
3751 }
3752
Paul Elliott588f8ed2022-12-02 18:10:26 +00003753 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003754#else
3755 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003756#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3757 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3758 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3759}
3760
Paul Elliott588f8ed2022-12-02 18:10:26 +00003761uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003762 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003763{
3764#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3765 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3766 defined(MBEDTLS_ECP_RESTARTABLE)
3767
Paul Elliott93d9ca82023-02-15 18:14:21 +00003768 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003769#else
3770 (void) operation;
3771 return 0;
3772#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3773 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3774 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3775}
3776
3777uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003778 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003779{
3780 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3781 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3782 defined(MBEDTLS_ECP_RESTARTABLE)
3783
Paul Elliott93d9ca82023-02-15 18:14:21 +00003784 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003785#else
3786 (void) operation;
3787 return 0;
3788#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3789 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3790 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3791}
3792
3793psa_status_t mbedtls_psa_sign_hash_start(
3794 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3795 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3796 size_t key_buffer_size, psa_algorithm_t alg,
3797 const uint8_t *hash, size_t hash_length)
3798{
3799 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003800 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003801
Paul Elliott068fe072023-01-16 13:59:15 +00003802 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3803 return PSA_ERROR_NOT_SUPPORTED;
3804 }
3805
3806 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003807 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003808 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003809
3810#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003811 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3812 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003813
Paul Elliotta1c94092023-02-15 16:38:04 +00003814 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3815
Paul Elliott93d9ca82023-02-15 18:14:21 +00003816 /* Ensure num_ops is zero'ed in case of context re-use. */
3817 operation->num_ops = 0;
3818
Paul Elliott068fe072023-01-16 13:59:15 +00003819 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3820 attributes->core.bits,
3821 key_buffer,
3822 key_buffer_size,
3823 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003824
Paul Elliott068fe072023-01-16 13:59:15 +00003825 if (status != PSA_SUCCESS) {
3826 return status;
3827 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003828
Paul Elliott1bc59df2023-02-05 13:41:57 +00003829 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003830 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003831
Paul Elliott068fe072023-01-16 13:59:15 +00003832 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003833 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003834 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003835
Paul Elliott0290a762023-02-09 14:30:24 +00003836 /* We only need to store the same length of hash as the private key size
3837 * here, it would be truncated by the internal implementation anyway. */
3838 required_hash_length = (hash_length < operation->coordinate_bytes ?
3839 hash_length : operation->coordinate_bytes);
3840
Paul Elliottba70ad42023-02-15 18:23:53 +00003841 if (required_hash_length > sizeof(operation->hash)) {
3842 /* Shouldn't happen, but better safe than sorry. */
3843 return PSA_ERROR_CORRUPTION_DETECTED;
3844 }
3845
Paul Elliott0290a762023-02-09 14:30:24 +00003846 memcpy(operation->hash, hash, required_hash_length);
3847 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003848
3849 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003850
3851#else
Paul Elliott068fe072023-01-16 13:59:15 +00003852 (void) operation;
3853 (void) key_buffer;
3854 (void) key_buffer_size;
3855 (void) alg;
3856 (void) hash;
3857 (void) hash_length;
3858 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003859 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003860
Paul Elliott068fe072023-01-16 13:59:15 +00003861 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003862#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3863 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3864 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003865}
3866
3867psa_status_t mbedtls_psa_sign_hash_complete(
3868 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3869 uint8_t *signature, size_t signature_size,
3870 size_t *signature_length)
3871{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003872#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3873 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3874 defined(MBEDTLS_ECP_RESTARTABLE)
3875
Paul Elliotta1c94092023-02-15 16:38:04 +00003876 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003877 mbedtls_mpi r;
3878 mbedtls_mpi s;
3879
Paul Elliott46845252023-02-03 14:59:11 +00003880 mbedtls_mpi_init(&r);
3881 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003882
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003883 /* Ensure max_ops is set to the current value (or default). */
3884 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3885
Paul Elliotta1c94092023-02-15 16:38:04 +00003886 if (signature_size < 2 * operation->coordinate_bytes) {
3887 status = PSA_ERROR_BUFFER_TOO_SMALL;
3888 goto exit;
3889 }
3890
Paul Elliott588f8ed2022-12-02 18:10:26 +00003891 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003892
Paul Elliott588f8ed2022-12-02 18:10:26 +00003893#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3894 status = mbedtls_to_psa_error(
3895 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003896 &r,
3897 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003898 &operation->ctx->d,
3899 operation->hash,
3900 operation->hash_length,
3901 operation->md_alg,
3902 mbedtls_psa_get_random,
3903 MBEDTLS_PSA_RANDOM_STATE,
3904 &operation->restart_ctx));
3905#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003906 status = PSA_ERROR_NOT_SUPPORTED;
3907 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003908#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3909 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003910 status = mbedtls_to_psa_error(
3911 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003912 &r,
3913 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003914 &operation->ctx->d,
3915 operation->hash,
3916 operation->hash_length,
3917 mbedtls_psa_get_random,
3918 MBEDTLS_PSA_RANDOM_STATE,
3919 mbedtls_psa_get_random,
3920 MBEDTLS_PSA_RANDOM_STATE,
3921 &operation->restart_ctx));
3922 }
3923
Paul Elliottf8e5b562023-02-19 18:43:45 +00003924 /* Hide the fact that the restart context only holds a delta of number of
3925 * ops done during the last operation, not an absolute value. */
3926 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3927
Paul Elliott724bd252023-02-08 12:35:08 +00003928 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003929 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003930 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003931 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003932 operation->coordinate_bytes)
3933 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003934
3935 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003936 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003937 }
3938
3939 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003940 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003941 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003942 operation->coordinate_bytes,
3943 operation->coordinate_bytes)
3944 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003945
3946 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003947 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003948 }
3949
Paul Elliott1bc59df2023-02-05 13:41:57 +00003950 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003951
Paul Elliott724bd252023-02-08 12:35:08 +00003952 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003953 }
Paul Elliott724bd252023-02-08 12:35:08 +00003954
3955exit:
3956
3957 mbedtls_mpi_free(&r);
3958 mbedtls_mpi_free(&s);
3959 return status;
3960
Paul Elliott588f8ed2022-12-02 18:10:26 +00003961 #else
3962
3963 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003964 (void) signature;
3965 (void) signature_size;
3966 (void) signature_length;
3967
3968 return PSA_ERROR_NOT_SUPPORTED;
3969
3970#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3971 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3972 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3973}
3974
3975psa_status_t mbedtls_psa_sign_hash_abort(
3976 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3977{
3978
3979#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3980 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3981 defined(MBEDTLS_ECP_RESTARTABLE)
3982
3983 if (operation->ctx) {
3984 mbedtls_ecdsa_free(operation->ctx);
3985 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003986 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003987 }
3988
3989 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3990
Paul Elliott93d9ca82023-02-15 18:14:21 +00003991 operation->num_ops = 0;
3992
Paul Elliott588f8ed2022-12-02 18:10:26 +00003993 return PSA_SUCCESS;
3994
3995#else
3996
3997 (void) operation;
3998
3999 return PSA_ERROR_NOT_SUPPORTED;
4000
4001#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4002 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4003 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4004}
4005
4006psa_status_t mbedtls_psa_verify_hash_start(
4007 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4008 const psa_key_attributes_t *attributes,
4009 const uint8_t *key_buffer, size_t key_buffer_size,
4010 psa_algorithm_t alg,
4011 const uint8_t *hash, size_t hash_length,
4012 const uint8_t *signature, size_t signature_length)
4013{
4014 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004015 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004016 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004017
Paul Elliott068fe072023-01-16 13:59:15 +00004018 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4019 return PSA_ERROR_NOT_SUPPORTED;
4020 }
4021
4022 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004023 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004024 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004025
4026#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004027 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4028 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004029
Paul Elliotta1c94092023-02-15 16:38:04 +00004030 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4031 mbedtls_mpi_init(&operation->r);
4032 mbedtls_mpi_init(&operation->s);
4033
Paul Elliott93d9ca82023-02-15 18:14:21 +00004034 /* Ensure num_ops is zero'ed in case of context re-use. */
4035 operation->num_ops = 0;
4036
Paul Elliott068fe072023-01-16 13:59:15 +00004037 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4038 attributes->core.bits,
4039 key_buffer,
4040 key_buffer_size,
4041 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004042
Paul Elliott068fe072023-01-16 13:59:15 +00004043 if (status != PSA_SUCCESS) {
4044 return status;
4045 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004046
Paul Elliottc569fc22023-02-10 13:02:54 +00004047 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004048
Paul Elliott1bc59df2023-02-05 13:41:57 +00004049 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004050 return PSA_ERROR_INVALID_SIGNATURE;
4051 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004052
Paul Elliott068fe072023-01-16 13:59:15 +00004053 status = mbedtls_to_psa_error(
4054 mbedtls_mpi_read_binary(&operation->r,
4055 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004056 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004057
Paul Elliott068fe072023-01-16 13:59:15 +00004058 if (status != PSA_SUCCESS) {
4059 return status;
4060 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004061
Paul Elliott068fe072023-01-16 13:59:15 +00004062 status = mbedtls_to_psa_error(
4063 mbedtls_mpi_read_binary(&operation->s,
4064 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004065 coordinate_bytes,
4066 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004067
Paul Elliott068fe072023-01-16 13:59:15 +00004068 if (status != PSA_SUCCESS) {
4069 return status;
4070 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004071
Paul Elliott2c9843f2023-02-15 17:32:42 +00004072 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004073
Paul Elliott2c9843f2023-02-15 17:32:42 +00004074 if (status != PSA_SUCCESS) {
4075 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004076 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004077
Paul Elliott0290a762023-02-09 14:30:24 +00004078 /* We only need to store the same length of hash as the private key size
4079 * here, it would be truncated by the internal implementation anyway. */
4080 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4081 coordinate_bytes);
4082
Paul Elliottba70ad42023-02-15 18:23:53 +00004083 if (required_hash_length > sizeof(operation->hash)) {
4084 /* Shouldn't happen, but better safe than sorry. */
4085 return PSA_ERROR_CORRUPTION_DETECTED;
4086 }
4087
Paul Elliott0290a762023-02-09 14:30:24 +00004088 memcpy(operation->hash, hash, required_hash_length);
4089 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004090
4091 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004092#else
Paul Elliott068fe072023-01-16 13:59:15 +00004093 (void) operation;
4094 (void) key_buffer;
4095 (void) key_buffer_size;
4096 (void) alg;
4097 (void) hash;
4098 (void) hash_length;
4099 (void) signature;
4100 (void) signature_length;
4101 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004102 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004103 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004104
Paul Elliott068fe072023-01-16 13:59:15 +00004105 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004106#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4107 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4108 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004109}
4110
4111psa_status_t mbedtls_psa_verify_hash_complete(
4112 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4113{
4114
4115#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4116 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4117 defined(MBEDTLS_ECP_RESTARTABLE)
4118
Paul Elliottf8e5b562023-02-19 18:43:45 +00004119 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4120
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004121 /* Ensure max_ops is set to the current value (or default). */
4122 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4123
Paul Elliottf8e5b562023-02-19 18:43:45 +00004124 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004125 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4126 operation->hash,
4127 operation->hash_length,
4128 &operation->ctx->Q,
4129 &operation->r,
4130 &operation->s,
4131 &operation->restart_ctx));
4132
Paul Elliottf8e5b562023-02-19 18:43:45 +00004133 /* Hide the fact that the restart context only holds a delta of number of
4134 * ops done during the last operation, not an absolute value. */
4135 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4136
4137 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004138#else
4139 (void) operation;
4140
4141 return PSA_ERROR_NOT_SUPPORTED;
4142
4143#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4144 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4145 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4146}
4147
4148psa_status_t mbedtls_psa_verify_hash_abort(
4149 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4150{
4151
4152#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4153 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4154 defined(MBEDTLS_ECP_RESTARTABLE)
4155
4156 if (operation->ctx) {
4157 mbedtls_ecdsa_free(operation->ctx);
4158 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004159 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004160 }
4161
4162 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4163
Paul Elliott93d9ca82023-02-15 18:14:21 +00004164 operation->num_ops = 0;
4165
Paul Elliott588f8ed2022-12-02 18:10:26 +00004166 mbedtls_mpi_free(&operation->r);
4167 mbedtls_mpi_free(&operation->s);
4168
4169 return PSA_SUCCESS;
4170
4171#else
4172 (void) operation;
4173
4174 return PSA_ERROR_NOT_SUPPORTED;
4175
4176#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4177 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4178 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4179}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004180
mohammad1603503973b2018-03-12 15:59:30 +02004181/****************************************************************/
4182/* Symmetric cryptography */
4183/****************************************************************/
4184
Gilles Peskine449bd832023-01-11 14:50:10 +01004185static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4186 mbedtls_svc_key_id_t key,
4187 psa_algorithm_t alg,
4188 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004189{
4190 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4191 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004192 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4194 PSA_KEY_USAGE_ENCRYPT :
4195 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004196 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004197
4198 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004200 status = PSA_ERROR_BAD_STATE;
4201 goto exit;
4202 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004203
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004205 status = PSA_ERROR_INVALID_ARGUMENT;
4206 goto exit;
4207 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004208
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4210 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004211 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004213
Ronald Cron49fafa92021-03-10 08:34:23 +01004214 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004215 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004216 * so we only set it (in the driver wrapper) after resources have been
4217 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004218 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004220 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004222 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 }
4224 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004225
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004226 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004228 };
4229
Ronald Cronab99ac22020-10-01 16:38:28 +02004230 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 if (cipher_operation == MBEDTLS_ENCRYPT) {
4232 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4233 &attributes,
4234 slot->key.data,
4235 slot->key.bytes,
4236 alg);
4237 } else {
4238 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4239 &attributes,
4240 slot->key.data,
4241 slot->key.bytes,
4242 alg);
4243 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004244
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004245exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 if (status != PSA_SUCCESS) {
4247 psa_cipher_abort(operation);
4248 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004249
Ryan Everett1b70a072024-01-04 10:32:49 +00004250 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004251
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004253}
4254
Gilles Peskine449bd832023-01-11 14:50:10 +01004255psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4256 mbedtls_svc_key_id_t key,
4257 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004258{
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004260}
4261
Gilles Peskine449bd832023-01-11 14:50:10 +01004262psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4263 mbedtls_svc_key_id_t key,
4264 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004265{
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004267}
4268
Gilles Peskine449bd832023-01-11 14:50:10 +01004269psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4270 uint8_t *iv,
4271 size_t iv_size,
4272 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004273{
Ronald Cron6d051732020-10-01 14:10:20 +02004274 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004275 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004276 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004277
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004279 status = PSA_ERROR_BAD_STATE;
4280 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004281 }
4282
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004284 status = PSA_ERROR_BAD_STATE;
4285 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004286 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004287
Ronald Cron2fb90522021-07-05 12:31:44 +02004288 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004290 status = PSA_ERROR_BUFFER_TOO_SMALL;
4291 goto exit;
4292 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004293
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004295 status = PSA_ERROR_GENERIC_ERROR;
4296 goto exit;
4297 }
4298
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 status = psa_generate_random(local_iv, default_iv_length);
4300 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004301 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 }
Ronald Cron5618a392021-03-26 09:52:26 +01004303
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 status = psa_driver_wrapper_cipher_set_iv(operation,
4305 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004306
4307exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 if (status == PSA_SUCCESS) {
4309 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004310 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004311 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004313 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004315 }
Ronald Cron6d051732020-10-01 14:10:20 +02004316
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004318}
4319
Gilles Peskine449bd832023-01-11 14:50:10 +01004320psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4321 const uint8_t *iv,
4322 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004323{
Ronald Cron6d051732020-10-01 14:10:20 +02004324 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004325
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004327 status = PSA_ERROR_BAD_STATE;
4328 goto exit;
4329 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004330
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004332 status = PSA_ERROR_BAD_STATE;
4333 goto exit;
4334 }
Ronald Crona0d68172021-03-26 10:15:08 +01004335
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004337 status = PSA_ERROR_INVALID_ARGUMENT;
4338 goto exit;
4339 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 status = psa_driver_wrapper_cipher_set_iv(operation,
4342 iv,
4343 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004344
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004345exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004347 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 } else {
4349 psa_cipher_abort(operation);
4350 }
4351 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004352}
4353
Gilles Peskine449bd832023-01-11 14:50:10 +01004354psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4355 const uint8_t *input,
4356 size_t input_length,
4357 uint8_t *output,
4358 size_t output_size,
4359 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004360{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004361 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004362
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004364 status = PSA_ERROR_BAD_STATE;
4365 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004366 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004367
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004369 status = PSA_ERROR_BAD_STATE;
4370 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004371 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004372
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 status = psa_driver_wrapper_cipher_update(operation,
4374 input,
4375 input_length,
4376 output,
4377 output_size,
4378 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004379
4380exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 if (status != PSA_SUCCESS) {
4382 psa_cipher_abort(operation);
4383 }
Ronald Cron6d051732020-10-01 14:10:20 +02004384
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004386}
4387
Gilles Peskine449bd832023-01-11 14:50:10 +01004388psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4389 uint8_t *output,
4390 size_t output_size,
4391 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004392{
David Saadab4ecc272019-02-14 13:48:10 +02004393 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004394
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004396 status = PSA_ERROR_BAD_STATE;
4397 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004398 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004401 status = PSA_ERROR_BAD_STATE;
4402 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004403 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004404
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 status = psa_driver_wrapper_cipher_finish(operation,
4406 output,
4407 output_size,
4408 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004409
4410exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if (status == PSA_SUCCESS) {
4412 return psa_cipher_abort(operation);
4413 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004414 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004416
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004418 }
mohammad1603503973b2018-03-12 15:59:30 +02004419}
4420
Gilles Peskine449bd832023-01-11 14:50:10 +01004421psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004422{
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004424 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004425 * in use. It's ok to call abort on such an object, and there's
4426 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004428 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004429
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004431
Ronald Cron49fafa92021-03-10 08:34:23 +01004432 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004433 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004434 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004435
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004437}
4438
Gilles Peskine449bd832023-01-11 14:50:10 +01004439psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4440 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004441 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004443 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 size_t output_size,
4445 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004446{
4447 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004448 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004449 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004450 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4451 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004452 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004453
David Horstmann62a56d92023-12-14 18:12:47 +00004454 LOCAL_INPUT_DECLARE(input_external, input);
4455 LOCAL_OUTPUT_DECLARE(output_external, output);
4456
David Horstmann36df4b22023-12-13 15:55:25 +00004457 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004458 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004461 status = PSA_ERROR_INVALID_ARGUMENT;
4462 goto exit;
4463 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004464
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4466 PSA_KEY_USAGE_ENCRYPT,
4467 alg);
4468 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004469 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004471
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004472 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004474 };
4475
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4477 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004478 status = PSA_ERROR_GENERIC_ERROR;
4479 goto exit;
4480 }
4481
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 if (default_iv_length > 0) {
4483 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004484 status = PSA_ERROR_BUFFER_TOO_SMALL;
4485 goto exit;
4486 }
4487
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 status = psa_generate_random(local_iv, default_iv_length);
4489 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004490 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004492 }
4493
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004494 status = psa_driver_wrapper_cipher_encrypt(
4495 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004496 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004497 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004499
4500exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004501 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004503 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004504 }
Ronald Cron23919522021-07-08 19:00:07 +02004505
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 if (status == PSA_SUCCESS) {
4507 if (default_iv_length > 0) {
4508 memcpy(output, local_iv, default_iv_length);
4509 }
4510 *output_length += default_iv_length;
4511 } else {
4512 *output_length = 0;
4513 }
4514
David Horstmann62a56d92023-12-14 18:12:47 +00004515 LOCAL_INPUT_FREE(input_external, input);
4516 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004517
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004519}
4520
Gilles Peskine449bd832023-01-11 14:50:10 +01004521psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4522 psa_algorithm_t alg,
4523 const uint8_t *input,
4524 size_t input_length,
4525 uint8_t *output,
4526 size_t output_size,
4527 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004528{
4529 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004530 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004531 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004532 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004533
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004535 status = PSA_ERROR_INVALID_ARGUMENT;
4536 goto exit;
4537 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004538
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4540 PSA_KEY_USAGE_DECRYPT,
4541 alg);
4542 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004543 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004545
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004546 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004548 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004549
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4551 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004552 status = PSA_ERROR_INVALID_ARGUMENT;
4553 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004555 status = PSA_ERROR_INVALID_ARGUMENT;
4556 goto exit;
4557 }
4558
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004559 status = psa_driver_wrapper_cipher_decrypt(
4560 &attributes, slot->key.data, slot->key.bytes,
4561 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004563
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004564exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004565 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004567 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004569
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004571 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 }
Ronald Cron23919522021-07-08 19:00:07 +02004573
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004575}
4576
4577
mohammad16035955c982018-04-26 00:53:03 +03004578/****************************************************************/
4579/* AEAD */
4580/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004581
Paul Elliottbaff51c2021-09-28 17:44:45 +01004582/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004583static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004584{
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004586}
4587
4588/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004589static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4590 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004591{
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004593
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004595#if defined(PSA_WANT_ALG_GCM)
4596 case PSA_ALG_GCM:
4597 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 * arbitrarily large nonces. Please note that we do not generally
4599 * recommend the usage of nonces of greater length than
4600 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4601 * size, which can then lead to collisions if you encrypt a very
4602 * large number of messages.*/
4603 if (nonce_length != 0) {
4604 return PSA_SUCCESS;
4605 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004606 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004607#endif /* PSA_WANT_ALG_GCM */
4608#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004609 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 if (nonce_length >= 7 && nonce_length <= 13) {
4611 return PSA_SUCCESS;
4612 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004613 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004614#endif /* PSA_WANT_ALG_CCM */
4615#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004616 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 if (nonce_length == 12) {
4618 return PSA_SUCCESS;
4619 } else if (nonce_length == 8) {
4620 return PSA_ERROR_NOT_SUPPORTED;
4621 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004622 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004623#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004624 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004625 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004627 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004630}
4631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004633{
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4635 return PSA_ERROR_INVALID_ARGUMENT;
4636 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004637
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004639}
4640
Gilles Peskine449bd832023-01-11 14:50:10 +01004641psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4642 psa_algorithm_t alg,
4643 const uint8_t *nonce,
4644 size_t nonce_length,
4645 const uint8_t *additional_data,
4646 size_t additional_data_length,
4647 const uint8_t *plaintext,
4648 size_t plaintext_length,
4649 uint8_t *ciphertext,
4650 size_t ciphertext_size,
4651 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004652{
Ronald Cron215633c2021-03-16 17:15:37 +01004653 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4654 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004655
mohammad1603f08a5502018-06-03 15:05:47 +03004656 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004657
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 status = psa_aead_check_algorithm(alg);
4659 if (status != PSA_SUCCESS) {
4660 return status;
4661 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004662
Ronald Cron9a986162021-03-26 12:40:07 +01004663 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4665 if (status != PSA_SUCCESS) {
4666 return status;
4667 }
mohammad16035955c982018-04-26 00:53:03 +03004668
Ronald Cron215633c2021-03-16 17:15:37 +01004669 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004671 };
mohammad16035955c982018-04-26 00:53:03 +03004672
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 status = psa_aead_check_nonce_length(alg, nonce_length);
4674 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004675 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004677
Ronald Cronde822812021-03-17 16:08:20 +01004678 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004679 &attributes, slot->key.data, slot->key.bytes,
4680 alg,
4681 nonce, nonce_length,
4682 additional_data, additional_data_length,
4683 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4687 memset(ciphertext, 0, ciphertext_size);
4688 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004689
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004690exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004691 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004694}
4695
Gilles Peskine449bd832023-01-11 14:50:10 +01004696psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4697 psa_algorithm_t alg,
4698 const uint8_t *nonce,
4699 size_t nonce_length,
4700 const uint8_t *additional_data,
4701 size_t additional_data_length,
4702 const uint8_t *ciphertext,
4703 size_t ciphertext_length,
4704 uint8_t *plaintext,
4705 size_t plaintext_size,
4706 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004707{
Ronald Cron215633c2021-03-16 17:15:37 +01004708 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4709 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004710
Gilles Peskineee652a32018-06-01 19:23:52 +02004711 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004712
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 status = psa_aead_check_algorithm(alg);
4714 if (status != PSA_SUCCESS) {
4715 return status;
4716 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004717
Ronald Cron9a986162021-03-26 12:40:07 +01004718 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4720 if (status != PSA_SUCCESS) {
4721 return status;
4722 }
mohammad16035955c982018-04-26 00:53:03 +03004723
Ronald Cron215633c2021-03-16 17:15:37 +01004724 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004726 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004727
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 status = psa_aead_check_nonce_length(alg, nonce_length);
4729 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004730 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004732
Ronald Cronde822812021-03-17 16:08:20 +01004733 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004734 &attributes, slot->key.data, slot->key.bytes,
4735 alg,
4736 nonce, nonce_length,
4737 additional_data, additional_data_length,
4738 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004740
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if (status != PSA_SUCCESS && plaintext_size != 0) {
4742 memset(plaintext, 0, plaintext_size);
4743 }
mohammad160360a64d02018-06-03 17:20:42 +03004744
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004745exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004746 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004747
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 return status;
mohammad16035955c982018-04-26 00:53:03 +03004749}
4750
Gilles Peskine449bd832023-01-11 14:50:10 +01004751static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4752{
4753 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004754
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004756#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004758 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4760 return PSA_ERROR_INVALID_ARGUMENT;
4761 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004762 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004763#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004764
Przemek Stekiel86679c72022-10-06 17:06:56 +02004765#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004767 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4769 return PSA_ERROR_INVALID_ARGUMENT;
4770 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004771 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004772#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004773
Przemek Stekiel86679c72022-10-06 17:06:56 +02004774#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004776 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (tag_len != 16) {
4778 return PSA_ERROR_INVALID_ARGUMENT;
4779 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004780 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004781#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004782
4783 default:
4784 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004786 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004788}
4789
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004790/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004791static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4792 int is_encrypt,
4793 mbedtls_svc_key_id_t key,
4794 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004795{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004796 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4797 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4798 psa_key_slot_t *slot = NULL;
4799 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004800 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004801
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 status = psa_aead_check_algorithm(alg);
4803 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004804 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004806
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004808 status = PSA_ERROR_BAD_STATE;
4809 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004810 }
4811
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 if (operation->nonce_set || operation->lengths_set ||
4813 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004814 status = PSA_ERROR_BAD_STATE;
4815 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004816 }
4817
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004819 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004821 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004823
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4825 alg);
4826 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004827 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004829
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004830 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004831 .core = slot->attr
4832 };
4833
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004835 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004837
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 if (is_encrypt) {
4839 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4840 &attributes,
4841 slot->key.data,
4842 slot->key.bytes,
4843 alg);
4844 } else {
4845 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4846 &attributes,
4847 slot->key.data,
4848 slot->key.bytes,
4849 alg);
4850 }
4851 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004852 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004854
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004856
4857exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004858 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004859
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004861 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004863 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 } else {
4865 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004866 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004867
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004869}
4870
Paul Elliott302ff6b2021-04-20 18:10:30 +01004871/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004872psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4873 mbedtls_svc_key_id_t key,
4874 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004875{
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004877}
4878
4879/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004880psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4881 mbedtls_svc_key_id_t key,
4882 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004883{
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004885}
4886
4887/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004888psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4889 uint8_t *nonce,
4890 size_t nonce_size,
4891 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004892{
4893 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004894 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004895 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004896
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004897 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004898
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004900 status = PSA_ERROR_BAD_STATE;
4901 goto exit;
4902 }
4903
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004905 status = PSA_ERROR_BAD_STATE;
4906 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004907 }
4908
Paul Elliotte193ea82021-10-01 13:00:16 +01004909 /* For CCM, this size may not be correct according to the PSA
4910 * specification. The PSA Crypto 1.0.1 specification states:
4911 *
4912 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4913 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4914 *
4915 * However this restriction that L has to be the smallest integer is not
4916 * applied in practice, and it is not implementable here since the
4917 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4919 operation->alg);
4920 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004921 status = PSA_ERROR_BUFFER_TOO_SMALL;
4922 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004923 }
4924
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 status = psa_generate_random(local_nonce, required_nonce_size);
4926 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004927 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004931
Paul Elliott39dc6b82021-05-11 19:16:09 +01004932exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (status == PSA_SUCCESS) {
4934 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004935 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 } else {
4937 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004938 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004939
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004941}
4942
4943/* Set the nonce for a multipart authenticated encryption or decryption
4944 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004945psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4946 const uint8_t *nonce,
4947 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004948{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004949 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4950
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004952 status = PSA_ERROR_BAD_STATE;
4953 goto exit;
4954 }
4955
Gilles Peskine449bd832023-01-11 14:50:10 +01004956 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004957 status = PSA_ERROR_BAD_STATE;
4958 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004959 }
4960
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4962 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004963 status = PSA_ERROR_INVALID_ARGUMENT;
4964 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004965 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004966
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4968 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004969
Paul Elliott39dc6b82021-05-11 19:16:09 +01004970exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004972 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 } else {
4974 psa_aead_abort(operation);
4975 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004976
Gilles Peskine449bd832023-01-11 14:50:10 +01004977 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004978}
4979
4980/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004981psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4982 size_t ad_length,
4983 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004984{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004985 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4986
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004988 status = PSA_ERROR_BAD_STATE;
4989 goto exit;
4990 }
4991
Gilles Peskine449bd832023-01-11 14:50:10 +01004992 if (operation->lengths_set || operation->ad_started ||
4993 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004994 status = PSA_ERROR_BAD_STATE;
4995 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004996 }
4997
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004999#if defined(PSA_WANT_ALG_GCM)
5000 case PSA_ALG_GCM:
5001 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 * bits. Without the guard this code will generate warnings on 32bit
5003 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005004#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005005 if (((uint64_t) ad_length) >> 61 != 0 ||
5006 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005007 status = PSA_ERROR_INVALID_ARGUMENT;
5008 goto exit;
5009 }
Paul Elliott325d3742021-09-27 17:56:28 +01005010#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005011 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005012#endif /* PSA_WANT_ALG_GCM */
5013#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005014 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005016 status = PSA_ERROR_INVALID_ARGUMENT;
5017 goto exit;
5018 }
5019 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005020#endif /* PSA_WANT_ALG_CCM */
5021#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005022 case PSA_ALG_CHACHA20_POLY1305:
5023 /* No length restrictions for ChaChaPoly. */
5024 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005025#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005026 default:
5027 break;
5028 }
Paul Elliott325d3742021-09-27 17:56:28 +01005029
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5031 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005032
Paul Elliott39dc6b82021-05-11 19:16:09 +01005033exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005035 operation->ad_remaining = ad_length;
5036 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005037 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 } else {
5039 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005040 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005043}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005044
5045/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005046psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5047 const uint8_t *input,
5048 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005049{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005050 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5051
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005053 status = PSA_ERROR_BAD_STATE;
5054 goto exit;
5055 }
5056
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005058 status = PSA_ERROR_BAD_STATE;
5059 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005060 }
5061
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 if (operation->lengths_set) {
5063 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005064 status = PSA_ERROR_INVALID_ARGUMENT;
5065 goto exit;
5066 }
5067
5068 operation->ad_remaining -= input_length;
5069 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005070#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005072 status = PSA_ERROR_BAD_STATE;
5073 goto exit;
5074 }
5075#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005076
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 status = psa_driver_wrapper_aead_update_ad(operation, input,
5078 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005079
Paul Elliott39dc6b82021-05-11 19:16:09 +01005080exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005082 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 } else {
5084 psa_aead_abort(operation);
5085 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005086
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005088}
5089
5090/* Encrypt or decrypt a message fragment in an active multipart AEAD
5091 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005092psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5093 const uint8_t *input,
5094 size_t input_length,
5095 uint8_t *output,
5096 size_t output_size,
5097 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005098{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005099 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005100
5101 *output_length = 0;
5102
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005104 status = PSA_ERROR_BAD_STATE;
5105 goto exit;
5106 }
5107
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005109 status = PSA_ERROR_BAD_STATE;
5110 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005111 }
5112
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005114 /* Additional data length was supplied, but not all the additional
5115 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005117 status = PSA_ERROR_INVALID_ARGUMENT;
5118 goto exit;
5119 }
5120
5121 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005123 status = PSA_ERROR_INVALID_ARGUMENT;
5124 goto exit;
5125 }
5126
5127 operation->body_remaining -= input_length;
5128 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005129#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005131 status = PSA_ERROR_BAD_STATE;
5132 goto exit;
5133 }
5134#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005135
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5137 output, output_size,
5138 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005139
Paul Elliott39dc6b82021-05-11 19:16:09 +01005140exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005142 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 } else {
5144 psa_aead_abort(operation);
5145 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005146
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005148}
5149
Gilles Peskine449bd832023-01-11 14:50:10 +01005150static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005151{
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 if (operation->id == 0 || !operation->nonce_set) {
5153 return PSA_ERROR_BAD_STATE;
5154 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005155
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5157 operation->body_remaining != 0)) {
5158 return PSA_ERROR_INVALID_ARGUMENT;
5159 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005160
Gilles Peskine449bd832023-01-11 14:50:10 +01005161 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005162}
5163
Paul Elliott302ff6b2021-04-20 18:10:30 +01005164/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005165psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5166 uint8_t *ciphertext,
5167 size_t ciphertext_size,
5168 size_t *ciphertext_length,
5169 uint8_t *tag,
5170 size_t tag_size,
5171 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005172{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005173 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5174
Paul Elliott302ff6b2021-04-20 18:10:30 +01005175 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005176 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005177
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 status = psa_aead_final_checks(operation);
5179 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005180 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005182
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005184 status = PSA_ERROR_BAD_STATE;
5185 goto exit;
5186 }
5187
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5189 ciphertext_size,
5190 ciphertext_length,
5191 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005192
Paul Elliott39dc6b82021-05-11 19:16:09 +01005193exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005194
5195
Paul Elliottf47b0952021-05-21 18:02:33 +01005196 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005197 * the zero tag size, make sure the tag is set to something implausible.
5198 * Even if the operation succeeds, make sure we clear the rest of the
5199 * buffer to prevent potential leakage of anything previously placed in
5200 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005201 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005202
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005204
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005206}
5207
5208/* Finish authenticating and decrypting a message in a multipart AEAD
5209 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005210psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5211 uint8_t *plaintext,
5212 size_t plaintext_size,
5213 size_t *plaintext_length,
5214 const uint8_t *tag,
5215 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005216{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005217 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5218
Paul Elliott302ff6b2021-04-20 18:10:30 +01005219 *plaintext_length = 0;
5220
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 status = psa_aead_final_checks(operation);
5222 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005223 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005225
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005227 status = PSA_ERROR_BAD_STATE;
5228 goto exit;
5229 }
5230
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5232 plaintext_size,
5233 plaintext_length,
5234 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005235
5236exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005238
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005240}
5241
5242/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005243psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005244{
5245 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5246
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005248 /* The object has (apparently) been initialized but it is not (yet)
5249 * in use. It's ok to call abort on such an object, and there's
5250 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005252 }
5253
Gilles Peskine449bd832023-01-11 14:50:10 +01005254 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005255
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005257
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005259}
5260
Gilles Peskinee59236f2018-01-27 23:32:46 +01005261/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005262/* Generators */
5263/****************************************************************/
5264
Przemek Stekiel69c46792022-06-10 12:59:51 +02005265#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005266 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005267 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305268 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305269 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005270#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005271#endif /* At least one builtin KDF */
5272
Przemek Stekiel69c46792022-06-10 12:59:51 +02005273#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005274 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5275 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5276static psa_status_t psa_key_derivation_start_hmac(
5277 psa_mac_operation_t *operation,
5278 psa_algorithm_t hash_alg,
5279 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005281{
5282 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5283 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5285 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5286 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005287
Steven Cooreman72f736a2021-05-07 14:14:37 +02005288 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005290
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 status = psa_driver_wrapper_mac_sign_setup(operation,
5292 &attributes,
5293 hmac_key, hmac_key_length,
5294 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005295
Gilles Peskine449bd832023-01-11 14:50:10 +01005296 psa_reset_key_attributes(&attributes);
5297 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005298}
5299#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005300
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005301#define HKDF_STATE_INIT 0 /* no input yet */
5302#define HKDF_STATE_STARTED 1 /* got salt */
5303#define HKDF_STATE_KEYED 2 /* got key */
5304#define HKDF_STATE_OUTPUT 3 /* output started */
5305
Gilles Peskinecbe66502019-05-16 16:59:18 +02005306static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005308{
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5310 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5311 } else {
5312 return operation->alg;
5313 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005314}
5315
Gilles Peskine449bd832023-01-11 14:50:10 +01005316psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005317{
5318 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5320 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005321 /* The object has (apparently) been initialized but it is not
5322 * in use. It's ok to call abort on such an object, and there's
5323 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005325#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5327 mbedtls_free(operation->ctx.hkdf.info);
5328 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5329 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005330#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005331#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5332 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005333 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5334 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5335 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5336 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005337 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005339 }
5340
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005342 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005344 }
5345
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005347 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005349 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005350#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005352 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005354 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005355#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005356 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005357
5358 /* We leave the fields Ai and output_block to be erased safely by the
5359 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005361#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5362 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005363#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5365 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5366 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5367 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005368#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305369#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305370 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305371 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005372 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305373 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305374 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305375
5376 status = PSA_SUCCESS;
5377 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305378#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005379 {
5380 status = PSA_ERROR_BAD_STATE;
5381 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 mbedtls_platform_zeroize(operation, sizeof(*operation));
5383 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005384}
5385
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005386psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005388{
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005390 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005392 }
5393
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005394 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005396}
5397
Gilles Peskine449bd832023-01-11 14:50:10 +01005398psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5399 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005400{
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 if (operation->alg == 0) {
5402 return PSA_ERROR_BAD_STATE;
5403 }
5404 if (capacity > operation->capacity) {
5405 return PSA_ERROR_INVALID_ARGUMENT;
5406 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005407 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005409}
5410
Przemek Stekiel69c46792022-06-10 12:59:51 +02005411#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005412/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005413static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5414 psa_algorithm_t kdf_alg,
5415 uint8_t *output,
5416 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005417{
Gilles Peskine449bd832023-01-11 14:50:10 +01005418 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5419 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005420 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005421 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005422#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005424#else
5425 const uint8_t last_block = 0xff;
5426#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005427
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 if (hkdf->state < HKDF_STATE_KEYED ||
5429 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005430#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005432#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 )) {
5434 return PSA_ERROR_BAD_STATE;
5435 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005436 hkdf->state = HKDF_STATE_OUTPUT;
5437
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005439 /* Copy what remains of the current block */
5440 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005442 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 }
5444 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005445 output += n;
5446 output_length -= n;
5447 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005449 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005451 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005452 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005453 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005454 * object was corrupted or if this function is called directly
5455 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 if (hkdf->block_number == last_block) {
5457 return PSA_ERROR_BAD_STATE;
5458 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005459
5460 /* We need a new block */
5461 ++hkdf->block_number;
5462 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005463
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5465 hash_alg,
5466 hkdf->prk,
5467 hash_length);
5468 if (status != PSA_SUCCESS) {
5469 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005470 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005471
5472 if (hkdf->block_number != 1) {
5473 status = psa_mac_update(&hkdf->hmac,
5474 hkdf->output_block,
5475 hash_length);
5476 if (status != PSA_SUCCESS) {
5477 return status;
5478 }
5479 }
5480 status = psa_mac_update(&hkdf->hmac,
5481 hkdf->info,
5482 hkdf->info_length);
5483 if (status != PSA_SUCCESS) {
5484 return status;
5485 }
5486 status = psa_mac_update(&hkdf->hmac,
5487 &hkdf->block_number, 1);
5488 if (status != PSA_SUCCESS) {
5489 return status;
5490 }
5491 status = psa_mac_sign_finish(&hkdf->hmac,
5492 hkdf->output_block,
5493 sizeof(hkdf->output_block),
5494 &hmac_output_length);
5495 if (status != PSA_SUCCESS) {
5496 return status;
5497 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005498 }
5499
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005501}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005502#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005503
John Durkop07cc04a2020-11-16 22:08:34 -08005504#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5505 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005506static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5507 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005509{
Gilles Peskine449bd832023-01-11 14:50:10 +01005510 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5511 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005512 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5513 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005514 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005515
Janos Follath7742fee2019-06-17 12:58:10 +01005516 /* We can't be wanting more output after block 0xff, otherwise
5517 * the capacity check in psa_key_derivation_output_bytes() would have
5518 * prevented this call. It could happen only if the operation
5519 * object was corrupted or if this function is called directly
5520 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 if (tls12_prf->block_number == 0xff) {
5522 return PSA_ERROR_CORRUPTION_DETECTED;
5523 }
Janos Follath7742fee2019-06-17 12:58:10 +01005524
5525 /* We need a new block */
5526 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005527 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005528
5529 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5530 *
5531 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5532 *
5533 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5534 * HMAC_hash(secret, A(2) + seed) +
5535 * HMAC_hash(secret, A(3) + seed) + ...
5536 *
5537 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005538 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005539 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005540 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005541 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005542 * is currently extracted as `output_block` and where i is
5543 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005544 */
5545
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 status = psa_key_derivation_start_hmac(&hmac,
5547 hash_alg,
5548 tls12_prf->secret,
5549 tls12_prf->secret_length);
5550 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005551 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005553
5554 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005556 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5557 * the variable seed and in this instance means it in the context of the
5558 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 status = psa_mac_update(&hmac,
5560 tls12_prf->label,
5561 tls12_prf->label_length);
5562 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005563 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 }
5565 status = psa_mac_update(&hmac,
5566 tls12_prf->seed,
5567 tls12_prf->seed_length);
5568 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005569 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 }
5571 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005572 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5574 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005575 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005577 }
5578
Gilles Peskine449bd832023-01-11 14:50:10 +01005579 status = psa_mac_sign_finish(&hmac,
5580 tls12_prf->Ai, hash_length,
5581 &hmac_output_length);
5582 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005583 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 }
5585 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005586 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005588
5589 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 status = psa_key_derivation_start_hmac(&hmac,
5591 hash_alg,
5592 tls12_prf->secret,
5593 tls12_prf->secret_length);
5594 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005595 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 }
5597 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5598 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005599 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 }
5601 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5602 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005603 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 }
5605 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5606 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005607 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 }
5609 status = psa_mac_sign_finish(&hmac,
5610 tls12_prf->output_block, hash_length,
5611 &hmac_output_length);
5612 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005613 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005615
Janos Follath7742fee2019-06-17 12:58:10 +01005616
5617cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 cleanup_status = psa_mac_abort(&hmac);
5619 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005620 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005622
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005624}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005625
Janos Follath844eb0e2019-06-19 12:10:49 +01005626static psa_status_t psa_key_derivation_tls12_prf_read(
5627 psa_tls12_prf_key_derivation_t *tls12_prf,
5628 psa_algorithm_t alg,
5629 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005631{
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5633 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005634 psa_status_t status;
5635 uint8_t offset, length;
5636
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005638 case PSA_TLS12_PRF_STATE_LABEL_SET:
5639 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5640 break;
5641 case PSA_TLS12_PRF_STATE_OUTPUT:
5642 break;
5643 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005645 }
5646
Gilles Peskine449bd832023-01-11 14:50:10 +01005647 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005648 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 if (tls12_prf->left_in_block == 0) {
5650 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5651 alg);
5652 if (status != PSA_SUCCESS) {
5653 return status;
5654 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005655
5656 continue;
5657 }
5658
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005660 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005662 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005663 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005664
5665 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005667 output += length;
5668 output_length -= length;
5669 tls12_prf->left_in_block -= length;
5670 }
5671
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005673}
John Durkop07cc04a2020-11-16 22:08:34 -08005674#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5675 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005676
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005677#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5678static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5679 psa_tls12_ecjpake_to_pms_t *ecjpake,
5680 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005682{
5683 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005684 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005685
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 if (output_length != 32) {
5687 return PSA_ERROR_INVALID_ARGUMENT;
5688 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005689
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5691 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5692 &output_size);
5693 if (status != PSA_SUCCESS) {
5694 return status;
5695 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005696
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 if (output_size != output_length) {
5698 return PSA_ERROR_GENERIC_ERROR;
5699 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005700
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005702}
5703#endif
5704
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305705#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305706static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5707 psa_pbkdf2_key_derivation_t *pbkdf2,
5708 psa_algorithm_t prf_alg,
5709 uint8_t prf_output_length,
5710 psa_key_attributes_t *attributes)
5711{
5712 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305713 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305714 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305715 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305716 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305717 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305718 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305719
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305720 mac_operation.is_sign = 1;
5721 mac_operation.mac_size = prf_output_length;
5722 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305723
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305724 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5725 attributes,
5726 pbkdf2->password,
5727 pbkdf2->password_length,
5728 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305729 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305730 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305731 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305732 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5733 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305734 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305735 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305736 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305737 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305738 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305739 }
5740 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5741 &mac_output_length);
5742 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305743 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305744 }
5745
5746 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305747 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305748 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305749 }
5750
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305751 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305752
5753 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305754 /* We are passing prf_output_length as mac_size because the driver
5755 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305756 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305757 status = psa_driver_wrapper_mac_compute(attributes,
5758 pbkdf2->password,
5759 pbkdf2->password_length,
5760 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305761 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305762 &mac_output_length);
5763 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305764 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305765 }
5766
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305767 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305768 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305769
5770cleanup:
5771 /* Zeroise buffers to clear sensitive data from memory. */
5772 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5773 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305774}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305775
5776static psa_status_t psa_key_derivation_pbkdf2_read(
5777 psa_pbkdf2_key_derivation_t *pbkdf2,
5778 psa_algorithm_t kdf_alg,
5779 uint8_t *output,
5780 size_t output_length)
5781{
5782 psa_status_t status;
5783 psa_algorithm_t prf_alg;
5784 uint8_t prf_output_length;
5785 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5786 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5787 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5788
5789 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5790 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5791 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5792 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305793 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5794 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305795 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305796 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305797 } else {
5798 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305799 }
5800
5801 switch (pbkdf2->state) {
5802 case PSA_PBKDF2_STATE_PASSWORD_SET:
5803 /* Initially we need a new block so bytes_used is equal to block size*/
5804 pbkdf2->bytes_used = prf_output_length;
5805 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5806 break;
5807 case PSA_PBKDF2_STATE_OUTPUT:
5808 break;
5809 default:
5810 return PSA_ERROR_BAD_STATE;
5811 }
5812
5813 while (output_length != 0) {
5814 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5815 if (n > output_length) {
5816 n = (uint8_t) output_length;
5817 }
5818 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5819 output += n;
5820 output_length -= n;
5821 pbkdf2->bytes_used += n;
5822
5823 if (output_length == 0) {
5824 break;
5825 }
5826
5827 /* We need a new block */
5828 pbkdf2->bytes_used = 0;
5829 pbkdf2->block_number++;
5830
5831 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5832 prf_output_length,
5833 &attributes);
5834 if (status != PSA_SUCCESS) {
5835 return status;
5836 }
5837 }
5838
5839 return PSA_SUCCESS;
5840}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305841#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305842
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005843psa_status_t psa_key_derivation_output_bytes(
5844 psa_key_derivation_operation_t *operation,
5845 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005847{
5848 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005850
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005852 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005853 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005854 }
5855
Gilles Peskine449bd832023-01-11 14:50:10 +01005856 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005857 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005858 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005859 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005860 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005861 goto exit;
5862 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005864 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005865 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005866 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5867 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005868 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005869 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005871 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005872 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005873
Przemek Stekiel69c46792022-06-10 12:59:51 +02005874#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005875 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5876 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5877 output, output_length);
5878 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005879#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005880#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5881 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5883 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5884 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5885 kdf_alg, output,
5886 output_length);
5887 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005888#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5889 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005890#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005892 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5894 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005895#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305896#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305897 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305898 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5899 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305900 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305901#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005902
Gilles Peskineeab56e42018-07-12 17:12:33 +02005903 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005904 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005906 }
5907
5908exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005910 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005911 * This allows us to differentiate between exhausted operations and
5912 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5913 * operations. */
5914 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005916 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005917 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005918 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005920}
5921
David Brown7807bf72021-02-09 16:28:23 -07005922#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005923static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005924{
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 if (data_size >= 8) {
5926 mbedtls_des_key_set_parity(data);
5927 }
5928 if (data_size >= 16) {
5929 mbedtls_des_key_set_parity(data + 8);
5930 }
5931 if (data_size >= 24) {
5932 mbedtls_des_key_set_parity(data + 16);
5933 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005934}
David Brown7807bf72021-02-09 16:28:23 -07005935#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005936
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005937/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 * ECC keys on a Weierstrass elliptic curve require the generation
5939 * of a private key which is an integer
5940 * in the range [1, N - 1], where N is the boundary of the private key domain:
5941 * N is the prime p for Diffie-Hellman, or the order of the
5942 * curve’s base point for ECC.
5943 *
5944 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5945 * This function generates the private key using the following process:
5946 *
5947 * 1. Draw a byte string of length ceiling(m/8) bytes.
5948 * 2. If m is not a multiple of 8, set the most significant
5949 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5950 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5951 * 4. If k > N - 2, discard the result and return to step 1.
5952 * 5. Output k + 1 as the private key.
5953 *
5954 * This method allows compliance to NIST standards, specifically the methods titled
5955 * Key-Pair Generation by Testing Candidates in the following publications:
5956 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5957 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5958 * Diffie-Hellman keys.
5959 *
5960 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5961 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5962 *
5963 * Note: Function allocates memory for *data buffer, so given *data should be
5964 * always NULL.
5965 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005966#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5967#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005968static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005969 psa_key_slot_t *slot,
5970 size_t bits,
5971 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005972 uint8_t **data
5973 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005974{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005975 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005976 mbedtls_mpi k;
5977 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005978 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005979 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005980 size_t m;
5981 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005982
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 mbedtls_mpi_init(&k);
5984 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005985
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005986 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005988 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005989 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005990
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005992 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005993 goto cleanup;
5994 }
5995
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005996 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005998
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006000
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006001 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006002 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006003 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006004
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006005 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006006
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006007 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006009
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006010 /* Note: This function is always called with *data == NULL and it
6011 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 *data = mbedtls_calloc(1, m_bytes);
6013 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006014 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006015 goto cleanup;
6016 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006019 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006021 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006023
6024 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006026 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006027 * (8 * ceiling(m/8) - m) bits of the first byte in
6028 * the string to zero.
6029 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006031 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006032 }
6033
6034 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 * big-endian byte string.
6036 */
6037 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006038
6039 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 * Result of comparison is returned. When it indicates error
6041 * then this function is called again.
6042 */
6043 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006044 }
6045
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006046 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6048 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006049cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 if (ret != 0) {
6051 status = mbedtls_to_psa_error(ret);
6052 }
6053 if (status != PSA_SUCCESS) {
6054 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006055 *data = NULL;
6056 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 mbedtls_mpi_free(&k);
6058 mbedtls_mpi_free(&diff_N_2);
6059 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006060}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006061
6062/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6063 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6064 *
6065 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6066 * draw a 32-byte string and process it as specified in
6067 * Elliptic Curves for Security [RFC7748] §5.
6068 *
6069 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6070 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6071 *
6072 * Note: Function allocates memory for *data buffer, so given *data should be
6073 * always NULL.
6074 */
6075
6076static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6077 size_t bits,
6078 psa_key_derivation_operation_t *operation,
6079 uint8_t **data
6080 )
6081{
6082 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006083 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006084
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006086 case 255:
6087 output_length = 32;
6088 break;
6089 case 448:
6090 output_length = 56;
6091 break;
6092 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006094 break;
6095 }
6096
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006098
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 if (*data == NULL) {
6100 return PSA_ERROR_INSUFFICIENT_MEMORY;
6101 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006102
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006104
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006106 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006108
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006110 case 255:
6111 (*data)[0] &= 248;
6112 (*data)[31] &= 127;
6113 (*data)[31] |= 64;
6114 break;
6115 case 448:
6116 (*data)[0] &= 252;
6117 (*data)[55] |= 128;
6118 break;
6119 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006121 break;
6122 }
6123
6124 return status;
6125}
Valerio Setti86587ab2023-06-27 13:09:30 +02006126#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6127static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6128 psa_key_slot_t *slot, size_t bits,
6129 psa_key_derivation_operation_t *operation, uint8_t **data)
6130{
6131 (void) slot;
6132 (void) bits;
6133 (void) operation;
6134 (void) data;
6135 return PSA_ERROR_NOT_SUPPORTED;
6136}
6137
6138static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6139 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6140{
6141 (void) bits;
6142 (void) operation;
6143 (void) data;
6144 return PSA_ERROR_NOT_SUPPORTED;
6145}
6146#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6147#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006148
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006149static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006150 psa_key_slot_t *slot,
6151 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006153{
6154 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306156 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006157 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006158 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006159
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6161 return PSA_ERROR_INVALID_ARGUMENT;
6162 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006163
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006164#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006165 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6167 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6168 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006169 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6171 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006172 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 }
6174 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006175 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6177 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006178 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006180 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006181 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006182#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006183 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 if (key_type_is_raw_bytes(slot->attr.type)) {
6185 if (bits % 8 != 0) {
6186 return PSA_ERROR_INVALID_ARGUMENT;
6187 }
6188 data = mbedtls_calloc(1, bytes);
6189 if (data == NULL) {
6190 return PSA_ERROR_INSUFFICIENT_MEMORY;
6191 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006192
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 status = psa_key_derivation_output_bytes(operation, data, bytes);
6194 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006195 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 }
David Brown12ca5032021-02-11 11:02:00 -07006197#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6199 psa_des_set_key_parity(data, bytes);
6200 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006201#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 } else {
6203 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006204 }
Ronald Crondd04d422020-11-28 15:14:42 +01006205
Ronald Cronbf33c932020-11-28 18:06:53 +01006206 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006207 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006209 };
6210
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6212 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6213 &storage_size);
6214 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306215 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 }
Archanad8a83dc2021-06-14 10:04:16 +05306217 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 status = psa_allocate_buffer_to_slot(slot, storage_size);
6219 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306220 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006221 }
Archanad8a83dc2021-06-14 10:04:16 +05306222
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 status = psa_driver_wrapper_import_key(&attributes,
6224 data, bytes,
6225 slot->key.data,
6226 slot->key.bytes,
6227 &slot->key.bytes, &bits);
6228 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006229 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006231
6232exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 mbedtls_free(data);
6234 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006235}
6236
Gilles Peskine449bd832023-01-11 14:50:10 +01006237psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6238 psa_key_derivation_operation_t *operation,
6239 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006240{
6241 psa_status_t status;
6242 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006243 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006244
Ronald Cron81709fc2020-11-14 12:10:32 +01006245 *key = MBEDTLS_SVC_KEY_ID_INIT;
6246
Gilles Peskine0f84d622019-09-12 19:03:13 +02006247 /* Reject any attempt to create a zero-length key so that we don't
6248 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 if (psa_get_key_bits(attributes) == 0) {
6250 return PSA_ERROR_INVALID_ARGUMENT;
6251 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006252
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 if (operation->alg == PSA_ALG_NONE) {
6254 return PSA_ERROR_BAD_STATE;
6255 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006256
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 if (!operation->can_output_key) {
6258 return PSA_ERROR_NOT_PERMITTED;
6259 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006260
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6262 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006263#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006265 /* Deriving a key in a secure element is not implemented yet. */
6266 status = PSA_ERROR_NOT_SUPPORTED;
6267 }
6268#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 if (status == PSA_SUCCESS) {
6270 status = psa_generate_derived_key_internal(slot,
6271 attributes->core.bits,
6272 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006273 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 if (status == PSA_SUCCESS) {
6275 status = psa_finish_key_creation(slot, driver, key);
6276 }
6277 if (status != PSA_SUCCESS) {
6278 psa_fail_key_creation(slot, driver);
6279 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006280
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006282}
6283
Gilles Peskineeab56e42018-07-12 17:12:33 +02006284
6285
6286/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006287/* Key derivation */
6288/****************************************************************/
6289
Steven Cooreman932ffb72021-02-15 12:14:32 +01006290#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006291static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006292{
6293#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6295 return 1;
6296 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006297#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006298#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6300 return 1;
6301 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006302#endif
6303#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6305 return 1;
6306 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006307#endif
6308#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6310 return 1;
6311 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006312#endif
6313#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006314 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6315 return 1;
6316 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006317#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006318#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006319 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6320 return 1;
6321 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006322#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306323#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6324 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6325 return 1;
6326 }
6327#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306328#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6329 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6330 return 1;
6331 }
6332#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006334}
6335
Gilles Peskine449bd832023-01-11 14:50:10 +01006336static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006337{
6338 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 psa_status_t status = psa_hash_setup(&operation, alg);
6340 psa_hash_abort(&operation);
6341 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006342}
6343
Gilles Peskine969c5d62019-01-16 15:53:06 +01006344static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006345 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006347{
Janos Follath5fe19732019-06-20 15:09:30 +01006348 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6349 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006351
Gilles Peskine969c5d62019-01-16 15:53:06 +01006352 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006353 if (!is_kdf_alg_supported(kdf_alg)) {
6354 return PSA_ERROR_NOT_SUPPORTED;
6355 }
John Durkop07cc04a2020-11-16 22:08:34 -08006356
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006357 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306358 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6360 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306361 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6362 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6363 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306364 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306365 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 if (hash_size == 0) {
6367 return PSA_ERROR_NOT_SUPPORTED;
6368 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006369
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006370 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6371 * we might fail later, which is somewhat unfriendly and potentially
6372 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 psa_status_t status = psa_hash_try_support(hash_alg);
6374 if (status != PSA_SUCCESS) {
6375 return status;
6376 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006377 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006378
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6380 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6381 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6382 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006383 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006384#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006385 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6387 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006388 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006390#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6391 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 operation->capacity = 255 * hash_size;
6393 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006394}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006395
Gilles Peskine449bd832023-01-11 14:50:10 +01006396static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006397{
6398#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 if (alg == PSA_ALG_ECDH) {
6400 return PSA_SUCCESS;
6401 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006402#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006403#if defined(PSA_WANT_ALG_FFDH)
6404 if (alg == PSA_ALG_FFDH) {
6405 return PSA_SUCCESS;
6406 }
6407#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006408 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006410}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006411
6412static int psa_key_derivation_allows_free_form_secret_input(
6413 psa_algorithm_t kdf_alg)
6414{
6415#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6416 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6417 return 0;
6418 }
6419#endif
6420 (void) kdf_alg;
6421 return 1;
6422}
John Durkop07cc04a2020-11-16 22:08:34 -08006423#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006424
Gilles Peskine449bd832023-01-11 14:50:10 +01006425psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6426 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006427{
6428 psa_status_t status;
6429
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 if (operation->alg != 0) {
6431 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006432 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006433
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6435 return PSA_ERROR_INVALID_ARGUMENT;
6436 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6437#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6438 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6439 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6440 status = psa_key_agreement_try_support(ka_alg);
6441 if (status != PSA_SUCCESS) {
6442 return status;
6443 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006444 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6445 return PSA_ERROR_INVALID_ARGUMENT;
6446 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6448#else
6449 return PSA_ERROR_NOT_SUPPORTED;
6450#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6451 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6452#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6453 status = psa_key_derivation_setup_kdf(operation, alg);
6454#else
6455 return PSA_ERROR_NOT_SUPPORTED;
6456#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6457 } else {
6458 return PSA_ERROR_INVALID_ARGUMENT;
6459 }
6460
6461 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006462 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 }
6464 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006465}
6466
Przemek Stekiel69c46792022-06-10 12:59:51 +02006467#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006468static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6469 psa_algorithm_t kdf_alg,
6470 psa_key_derivation_step_t step,
6471 const uint8_t *data,
6472 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006473{
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006475 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006477 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006478#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6480 return PSA_ERROR_INVALID_ARGUMENT;
6481 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006482#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 if (hkdf->state != HKDF_STATE_INIT) {
6484 return PSA_ERROR_BAD_STATE;
6485 } else {
6486 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6487 hash_alg,
6488 data, data_length);
6489 if (status != PSA_SUCCESS) {
6490 return status;
6491 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006492 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006494 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006495 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006496#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006498 /* We shouldn't be in different state as HKDF_EXPAND only allows
6499 * two inputs: SECRET (this case) and INFO which does not modify
6500 * the state. It could happen only if the hkdf
6501 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006502 if (hkdf->state != HKDF_STATE_INIT) {
6503 return PSA_ERROR_BAD_STATE;
6504 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006505
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006506 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6508 return PSA_ERROR_INVALID_ARGUMENT;
6509 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006510
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 memcpy(hkdf->prk, data, data_length);
6512 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006513#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006514 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006515 /* HKDF: If no salt was provided, use an empty salt.
6516 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006518#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6520 return PSA_ERROR_BAD_STATE;
6521 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006522#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6524 hash_alg,
6525 NULL, 0);
6526 if (status != PSA_SUCCESS) {
6527 return status;
6528 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006529 hkdf->state = HKDF_STATE_STARTED;
6530 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 if (hkdf->state != HKDF_STATE_STARTED) {
6532 return PSA_ERROR_BAD_STATE;
6533 }
6534 status = psa_mac_update(&hkdf->hmac,
6535 data, data_length);
6536 if (status != PSA_SUCCESS) {
6537 return status;
6538 }
6539 status = psa_mac_sign_finish(&hkdf->hmac,
6540 hkdf->prk,
6541 sizeof(hkdf->prk),
6542 &data_length);
6543 if (status != PSA_SUCCESS) {
6544 return status;
6545 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006546 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006547
Gilles Peskine2b522db2019-04-12 15:11:49 +02006548 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006549 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006550#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006552 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006554 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006556#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006557 {
6558 /* Block 0 is empty, and the next block will be
6559 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006560 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006561 }
6562
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006564 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006565#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6567 return PSA_ERROR_INVALID_ARGUMENT;
6568 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006569#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006570#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6572 hkdf->state == HKDF_STATE_INIT) {
6573 return PSA_ERROR_BAD_STATE;
6574 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006575#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 if (hkdf->state == HKDF_STATE_OUTPUT) {
6577 return PSA_ERROR_BAD_STATE;
6578 }
6579 if (hkdf->info_set) {
6580 return PSA_ERROR_BAD_STATE;
6581 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006582 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006583 if (data_length != 0) {
6584 hkdf->info = mbedtls_calloc(1, data_length);
6585 if (hkdf->info == NULL) {
6586 return PSA_ERROR_INSUFFICIENT_MEMORY;
6587 }
6588 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006589 }
6590 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006592 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006594 }
6595}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006596#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006597
John Durkop07cc04a2020-11-16 22:08:34 -08006598#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6599 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006600static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6601 const uint8_t *data,
6602 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006603{
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6605 return PSA_ERROR_BAD_STATE;
6606 }
Janos Follathf08e2652019-06-13 09:05:41 +01006607
Gilles Peskine449bd832023-01-11 14:50:10 +01006608 if (data_length != 0) {
6609 prf->seed = mbedtls_calloc(1, data_length);
6610 if (prf->seed == NULL) {
6611 return PSA_ERROR_INSUFFICIENT_MEMORY;
6612 }
Janos Follathf08e2652019-06-13 09:05:41 +01006613
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006615 prf->seed_length = data_length;
6616 }
Janos Follathf08e2652019-06-13 09:05:41 +01006617
Gilles Peskine43f958b2020-12-13 14:55:14 +01006618 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006619
Gilles Peskine449bd832023-01-11 14:50:10 +01006620 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006621}
6622
Gilles Peskine449bd832023-01-11 14:50:10 +01006623static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6624 const uint8_t *data,
6625 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006626{
Gilles Peskine449bd832023-01-11 14:50:10 +01006627 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6628 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6629 return PSA_ERROR_BAD_STATE;
6630 }
Janos Follath81550542019-06-13 14:26:34 +01006631
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 if (data_length != 0) {
6633 prf->secret = mbedtls_calloc(1, data_length);
6634 if (prf->secret == NULL) {
6635 return PSA_ERROR_INSUFFICIENT_MEMORY;
6636 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006637
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006639 prf->secret_length = data_length;
6640 }
Janos Follath81550542019-06-13 14:26:34 +01006641
Gilles Peskine43f958b2020-12-13 14:55:14 +01006642 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006643
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006645}
6646
Gilles Peskine449bd832023-01-11 14:50:10 +01006647static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6648 const uint8_t *data,
6649 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006650{
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6652 return PSA_ERROR_BAD_STATE;
6653 }
Janos Follath63028dd2019-06-13 09:15:47 +01006654
Gilles Peskine449bd832023-01-11 14:50:10 +01006655 if (data_length != 0) {
6656 prf->label = mbedtls_calloc(1, data_length);
6657 if (prf->label == NULL) {
6658 return PSA_ERROR_INSUFFICIENT_MEMORY;
6659 }
Janos Follath63028dd2019-06-13 09:15:47 +01006660
Gilles Peskine449bd832023-01-11 14:50:10 +01006661 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006662 prf->label_length = data_length;
6663 }
Janos Follath63028dd2019-06-13 09:15:47 +01006664
Gilles Peskine43f958b2020-12-13 14:55:14 +01006665 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006666
Gilles Peskine449bd832023-01-11 14:50:10 +01006667 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006668}
6669
Gilles Peskine449bd832023-01-11 14:50:10 +01006670static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6671 psa_key_derivation_step_t step,
6672 const uint8_t *data,
6673 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006674{
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006676 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006677 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006678 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006680 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006681 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006682 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006684 }
6685}
John Durkop07cc04a2020-11-16 22:08:34 -08006686#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6687 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6688
6689#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6690static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6691 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006692 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006693 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006694{
6695 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006696 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6697 4 + data_length + prf->other_secret_length :
6698 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6701 return PSA_ERROR_INVALID_ARGUMENT;
6702 }
John Durkop07cc04a2020-11-16 22:08:34 -08006703
Gilles Peskine449bd832023-01-11 14:50:10 +01006704 uint8_t *pms = mbedtls_calloc(1, pms_len);
6705 if (pms == NULL) {
6706 return PSA_ERROR_INSUFFICIENT_MEMORY;
6707 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006708 uint8_t *cur = pms;
6709
6710 /* pure-PSK:
6711 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006712 *
6713 * The premaster secret is formed as follows: if the PSK is N octets
6714 * long, concatenate a uint16 with the value N, N zero octets, a second
6715 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006716 *
6717 * mixed-PSK:
6718 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6719 * follows: concatenate a uint16 with the length of the other secret,
6720 * the other secret itself, uint16 with the length of PSK, and the
6721 * PSK itself.
6722 * For details please check:
6723 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6724 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6725 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006726 */
6727
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6729 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6730 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6731 if (prf->other_secret_length != 0) {
6732 memcpy(cur, prf->other_secret, prf->other_secret_length);
6733 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006734 cur += prf->other_secret_length;
6735 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 } else {
6737 *cur++ = MBEDTLS_BYTE_1(data_length);
6738 *cur++ = MBEDTLS_BYTE_0(data_length);
6739 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006740 cur += data_length;
6741 }
6742
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 *cur++ = MBEDTLS_BYTE_1(data_length);
6744 *cur++ = MBEDTLS_BYTE_0(data_length);
6745 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006746 cur += data_length;
6747
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006748 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006749
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006750 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006752}
Janos Follath6660f0e2019-06-17 08:44:03 +01006753
Przemek Stekiele47201b2022-04-19 13:53:28 +02006754static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6755 psa_tls12_prf_key_derivation_t *prf,
6756 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006757 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006758{
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6760 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006761 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006762
6763 if (data_length != 0) {
6764 prf->other_secret = mbedtls_calloc(1, data_length);
6765 if (prf->other_secret == NULL) {
6766 return PSA_ERROR_INSUFFICIENT_MEMORY;
6767 }
6768
6769 memcpy(prf->other_secret, data, data_length);
6770 prf->other_secret_length = data_length;
6771 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006772 prf->other_secret_length = 0;
6773 }
6774
6775 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6776
Gilles Peskine449bd832023-01-11 14:50:10 +01006777 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006778}
6779
Janos Follath6660f0e2019-06-17 08:44:03 +01006780static psa_status_t psa_tls12_prf_psk_to_ms_input(
6781 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006782 psa_key_derivation_step_t step,
6783 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006785{
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006787 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 return psa_tls12_prf_psk_to_ms_set_key(prf,
6789 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006790 break;
6791 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6793 data,
6794 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006795 break;
6796 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006798 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006799
Przemek Stekiele47201b2022-04-19 13:53:28 +02006800 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006801}
John Durkop07cc04a2020-11-16 22:08:34 -08006802#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006803
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006804#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6805static psa_status_t psa_tls12_ecjpake_to_pms_input(
6806 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006807 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006808 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006810{
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6812 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6813 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006814 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006815
6816 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006817 if (data[0] != 0x04) {
6818 return PSA_ERROR_INVALID_ARGUMENT;
6819 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006820
6821 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006825}
6826#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306827
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306828#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306829static psa_status_t psa_pbkdf2_set_input_cost(
6830 psa_pbkdf2_key_derivation_t *pbkdf2,
6831 psa_key_derivation_step_t step,
6832 uint64_t data)
6833{
6834 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6835 return PSA_ERROR_INVALID_ARGUMENT;
6836 }
6837
6838 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6839 return PSA_ERROR_BAD_STATE;
6840 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306841
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306842 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306843 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306844 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306845
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306846 if (data == 0) {
6847 return PSA_ERROR_INVALID_ARGUMENT;
6848 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306849
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306850 pbkdf2->input_cost = data;
6851 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6852
6853 return PSA_SUCCESS;
6854}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306855
6856static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6857 const uint8_t *data,
6858 size_t data_length)
6859{
Gilles Peskineead17662023-08-20 22:02:51 +02006860 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6861 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6862 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6863 /* Appending to existing salt. No state change. */
6864 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306865 return PSA_ERROR_BAD_STATE;
6866 }
6867
Gilles Peskineca57d782023-07-20 19:08:06 +02006868 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006869 /* Appending an empty string, nothing to do. */
6870 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306871 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306872
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306873 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6874 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306875 return PSA_ERROR_INSUFFICIENT_MEMORY;
6876 }
6877
Gilles Peskineead17662023-08-20 22:02:51 +02006878 if (pbkdf2->salt_length != 0) {
6879 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6880 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306881 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306882 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306883 mbedtls_free(pbkdf2->salt);
6884 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306885 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306886 return PSA_SUCCESS;
6887}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306888
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306889#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306890static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306891 const uint8_t *input,
6892 size_t input_len,
6893 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306894 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306895{
6896 psa_status_t status = PSA_SUCCESS;
6897 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6898 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306899 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306900 } else {
6901 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306902 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306903 }
6904 return status;
6905}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306906#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306907
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306908#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306909static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6910 size_t input_len,
6911 uint8_t *output,
6912 size_t *output_len)
6913{
6914 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306915 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306916 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306917 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306918 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6919 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6920 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306921 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306922 * mac_size as the driver function sets mac_output_length = mac_size
6923 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306924 status = psa_driver_wrapper_mac_compute(&attributes,
6925 zeros, sizeof(zeros),
6926 PSA_ALG_CMAC, input, input_len,
6927 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306928 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6929 128U,
6930 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306931 output_len);
6932 } else {
6933 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306934 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306935 }
6936 return status;
6937}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306938#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306939
6940static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306941 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306942 const uint8_t *data,
6943 size_t data_length)
6944{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306945 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306946 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6947 return PSA_ERROR_BAD_STATE;
6948 }
6949
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306950#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306951 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6952 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6953 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6954 pbkdf2->password,
6955 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306956 } else
6957#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6958#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6959 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306960 status = psa_pbkdf2_cmac_set_password(data, data_length,
6961 pbkdf2->password,
6962 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306963 } else
6964#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6965 {
6966 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306967 }
6968
6969 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6970
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306971 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306972}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306973
6974static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306975 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306976 psa_key_derivation_step_t step,
6977 const uint8_t *data,
6978 size_t data_length)
6979{
6980 switch (step) {
6981 case PSA_KEY_DERIVATION_INPUT_SALT:
6982 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6983 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306984 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306985 default:
6986 return PSA_ERROR_INVALID_ARGUMENT;
6987 }
6988}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306989#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306990
Gilles Peskineb8965192019-09-24 16:21:10 +02006991/** Check whether the given key type is acceptable for the given
6992 * input step of a key derivation.
6993 *
6994 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6995 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6996 * Both secret and non-secret inputs can alternatively have the type
6997 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6998 * that the input was passed as a buffer rather than via a key object.
6999 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007000static int psa_key_derivation_check_input_type(
7001 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007002 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007003{
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007005 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 if (key_type == PSA_KEY_TYPE_DERIVE) {
7007 return PSA_SUCCESS;
7008 }
7009 if (key_type == PSA_KEY_TYPE_NONE) {
7010 return PSA_SUCCESS;
7011 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007012 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007013 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 if (key_type == PSA_KEY_TYPE_DERIVE) {
7015 return PSA_SUCCESS;
7016 }
7017 if (key_type == PSA_KEY_TYPE_NONE) {
7018 return PSA_SUCCESS;
7019 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007020 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007021 case PSA_KEY_DERIVATION_INPUT_LABEL:
7022 case PSA_KEY_DERIVATION_INPUT_SALT:
7023 case PSA_KEY_DERIVATION_INPUT_INFO:
7024 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7026 return PSA_SUCCESS;
7027 }
7028 if (key_type == PSA_KEY_TYPE_NONE) {
7029 return PSA_SUCCESS;
7030 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007031 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307032 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7033 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7034 return PSA_SUCCESS;
7035 }
7036 if (key_type == PSA_KEY_TYPE_DERIVE) {
7037 return PSA_SUCCESS;
7038 }
7039 if (key_type == PSA_KEY_TYPE_NONE) {
7040 return PSA_SUCCESS;
7041 }
7042 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007043 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007044 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007045}
7046
Janos Follathb80a94e2019-06-12 15:54:46 +01007047static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007048 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007049 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007050 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007051 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007053{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007054 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007056
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 status = psa_key_derivation_check_input_type(step, key_type);
7058 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007059 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007061
Przemek Stekiel69c46792022-06-10 12:59:51 +02007062#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7064 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7065 step, data, data_length);
7066 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007067#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007068#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7070 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7071 step, data, data_length);
7072 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007073#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7074#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7076 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7077 step, data, data_length);
7078 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007079#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007080#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007082 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7084 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007085#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307086#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307087 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307088 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7089 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307090 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307091#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007092 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007093 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007094 (void) data;
7095 (void) data_length;
7096 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007098 }
7099
Gilles Peskine224b0d62019-09-23 18:13:17 +02007100exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 if (status != PSA_SUCCESS) {
7102 psa_key_derivation_abort(operation);
7103 }
7104 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007105}
7106
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307107static psa_status_t psa_key_derivation_input_integer_internal(
7108 psa_key_derivation_operation_t *operation,
7109 psa_key_derivation_step_t step,
7110 uint64_t value)
7111{
7112 psa_status_t status;
7113 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7114
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307115#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307116 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307117 status = psa_pbkdf2_set_input_cost(
7118 &operation->ctx.pbkdf2, step, value);
7119 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307120#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307121 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307122 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307123 (void) value;
7124 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307125 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307126 }
7127
7128 if (status != PSA_SUCCESS) {
7129 psa_key_derivation_abort(operation);
7130 }
7131 return status;
7132}
7133
Janos Follath51f4a0f2019-06-14 11:35:55 +01007134psa_status_t psa_key_derivation_input_bytes(
7135 psa_key_derivation_operation_t *operation,
7136 psa_key_derivation_step_t step,
7137 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007139{
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 return psa_key_derivation_input_internal(operation, step,
7141 PSA_KEY_TYPE_NONE,
7142 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007143}
7144
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307145psa_status_t psa_key_derivation_input_integer(
7146 psa_key_derivation_operation_t *operation,
7147 psa_key_derivation_step_t step,
7148 uint64_t value)
7149{
7150 return psa_key_derivation_input_integer_internal(operation, step, value);
7151}
7152
Janos Follath51f4a0f2019-06-14 11:35:55 +01007153psa_status_t psa_key_derivation_input_key(
7154 psa_key_derivation_operation_t *operation,
7155 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007157{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007158 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007159 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007160 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007161
Ronald Cron5c522922020-11-14 16:35:34 +01007162 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7164 if (status != PSA_SUCCESS) {
7165 psa_key_derivation_abort(operation);
7166 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007167 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007168
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307169 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7170 * permission to output to a key object. */
7171 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7172 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007173 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007175
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 status = psa_key_derivation_input_internal(operation,
7177 step, slot->attr.type,
7178 slot->key.data,
7179 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007180
Ryan Everett1b70a072024-01-04 10:32:49 +00007181 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007182
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007184}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007185
7186
7187
7188/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007189/* Key agreement */
7190/****************************************************************/
7191
Gilles Peskine449bd832023-01-11 14:50:10 +01007192psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7193 const uint8_t *key_buffer,
7194 size_t key_buffer_size,
7195 psa_algorithm_t alg,
7196 const uint8_t *peer_key,
7197 size_t peer_key_length,
7198 uint8_t *shared_secret,
7199 size_t shared_secret_size,
7200 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007201{
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007203#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007204 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7206 key_buffer_size, alg,
7207 peer_key, peer_key_length,
7208 shared_secret,
7209 shared_secret_size,
7210 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007211#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007212
7213#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7214 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007215 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007216 peer_key,
7217 peer_key_length,
7218 key_buffer,
7219 key_buffer_size,
7220 shared_secret,
7221 shared_secret_size,
7222 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007223#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7224
Gilles Peskine01d718c2018-09-18 12:01:02 +02007225 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007226 (void) attributes;
7227 (void) key_buffer;
7228 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007229 (void) peer_key;
7230 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007231 (void) shared_secret;
7232 (void) shared_secret_size;
7233 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007234 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007235 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007236}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007237
Aditya Deshpande17845b82022-10-13 17:21:01 +01007238/** Internal function for raw key agreement
7239 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007240 * to the driver's implementation if a driver is present.
7241 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007242 * (psa_key_agreement_raw_builtin).
7243 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007244static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7245 psa_key_slot_t *private_key,
7246 const uint8_t *peer_key,
7247 size_t peer_key_length,
7248 uint8_t *shared_secret,
7249 size_t shared_secret_size,
7250 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007251{
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7253 return PSA_ERROR_NOT_SUPPORTED;
7254 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007255
7256 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007258 };
7259
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 return psa_driver_wrapper_key_agreement(&attributes,
7261 private_key->key.data,
7262 private_key->key.bytes, alg,
7263 peer_key, peer_key_length,
7264 shared_secret,
7265 shared_secret_size,
7266 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007267}
7268
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007269/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007270 * to potentially free embedded data structures and wipe confidential data.
7271 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007272static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7273 psa_key_derivation_step_t step,
7274 psa_key_slot_t *private_key,
7275 const uint8_t *peer_key,
7276 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007277{
7278 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007279 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007280 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007282
7283 /* Step 1: run the secret agreement algorithm to generate the shared
7284 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 status = psa_key_agreement_raw_internal(ka_alg,
7286 private_key,
7287 peer_key, peer_key_length,
7288 shared_secret,
7289 sizeof(shared_secret),
7290 &shared_secret_length);
7291 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007292 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007294
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007295 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007296 * the shared secret. A shared secret is permitted wherever a key
7297 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007298 status = psa_key_derivation_input_internal(operation, step,
7299 PSA_KEY_TYPE_DERIVE,
7300 shared_secret,
7301 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007302exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007303 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7304 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007305}
7306
Gilles Peskine449bd832023-01-11 14:50:10 +01007307psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7308 psa_key_derivation_step_t step,
7309 mbedtls_svc_key_id_t private_key,
7310 const uint8_t *peer_key,
7311 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007312{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007313 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007314 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007315 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007316
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7318 return PSA_ERROR_INVALID_ARGUMENT;
7319 }
Ronald Cron5c522922020-11-14 16:35:34 +01007320 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007321 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7322 if (status != PSA_SUCCESS) {
7323 return status;
7324 }
7325 status = psa_key_agreement_internal(operation, step,
7326 slot,
7327 peer_key, peer_key_length);
7328 if (status != PSA_SUCCESS) {
7329 psa_key_derivation_abort(operation);
7330 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007331 /* If a private key has been added as SECRET, we allow the derived
7332 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007334 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007336 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007337
Ryan Everett1b70a072024-01-04 10:32:49 +00007338 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007339
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007341}
7342
Gilles Peskine449bd832023-01-11 14:50:10 +01007343psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7344 mbedtls_svc_key_id_t private_key,
7345 const uint8_t *peer_key,
7346 size_t peer_key_length,
7347 uint8_t *output,
7348 size_t output_size,
7349 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007350{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007351 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007352 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007353 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007354 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007355
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007357 status = PSA_ERROR_INVALID_ARGUMENT;
7358 goto exit;
7359 }
Ronald Cron5c522922020-11-14 16:35:34 +01007360 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7362 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007363 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007365
Gilles Peskine3e561302022-04-14 00:17:15 +02007366 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7367 * for the output size. The PSA specification only guarantees that this
7368 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7369 * but it might be nice to allow smaller buffers if the output fits.
7370 * At the time of writing this comment, with only ECDH implemented,
7371 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7372 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7373 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007374 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7376 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007377 status = PSA_ERROR_BUFFER_TOO_SMALL;
7378 goto exit;
7379 }
7380
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 status = psa_key_agreement_raw_internal(alg, slot,
7382 peer_key, peer_key_length,
7383 output, output_size,
7384 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007385
7386exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007388 /* If an error happens and is not handled properly, the output
7389 * may be used as a key to protect sensitive data. Arrange for such
7390 * a key to be random, which is likely to result in decryption or
7391 * verification errors. This is better than filling the buffer with
7392 * some constant data such as zeros, which would result in the data
7393 * being protected with a reproducible, easily knowable key.
7394 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007395 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007396 *output_length = output_size;
7397 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007398
Ryan Everett1b70a072024-01-04 10:32:49 +00007399 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007400
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007402}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007403
7404
Gilles Peskine30524eb2020-11-13 17:02:26 +01007405
Gilles Peskine86a440b2018-11-12 18:39:40 +01007406/****************************************************************/
7407/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007408/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007409
Gilles Peskine672a7712023-04-28 21:00:28 +02007410#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7411#include "entropy_poll.h"
7412#endif
7413
Gilles Peskine30524eb2020-11-13 17:02:26 +01007414/** Initialize the PSA random generator.
7415 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007416static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007417{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007418#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007420#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7421
Gilles Peskine30524eb2020-11-13 17:02:26 +01007422 /* Set default configuration if
7423 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007425 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 }
7427 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007428 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007430
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007432#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7433 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7434 /* The PSA entropy injection feature depends on using NV seed as an entropy
7435 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 mbedtls_entropy_add_source(&rng->entropy,
7437 mbedtls_nv_seed_poll, NULL,
7438 MBEDTLS_ENTROPY_BLOCK_SIZE,
7439 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007440#endif
7441
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007443#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007444}
7445
7446/** Deinitialize the PSA random generator.
7447 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007448static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007449{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007450#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007451 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007452#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007453 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7454 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007455#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007456}
7457
7458/** Seed the PSA random generator.
7459 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007460static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007461{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007462#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7463 /* Do nothing: the external RNG seeds itself. */
7464 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007466#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007467 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7469 drbg_seed, sizeof(drbg_seed) - 1);
7470 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007471#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007472}
7473
Gilles Peskine449bd832023-01-11 14:50:10 +01007474psa_status_t psa_generate_random(uint8_t *output,
7475 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007476{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007477 GUARD_MODULE_INITIALIZED;
7478
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007479#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7480
7481 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7483 output, output_size,
7484 &output_length);
7485 if (status != PSA_SUCCESS) {
7486 return status;
7487 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007488 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007489 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 if (output_length != output_size) {
7491 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7492 }
7493 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007494
7495#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7496
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007498 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7500 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7501 output_size);
7502 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7503 output, request_size);
7504 if (ret != 0) {
7505 return mbedtls_to_psa_error(ret);
7506 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007507 output_size -= request_size;
7508 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007509 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007511#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007512}
7513
Gilles Peskine8814fc42020-12-14 15:33:44 +01007514/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007515 *
7516 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7517 * `psa_generate_random(...)`. The state parameter is ignored since the
7518 * PSA API doesn't support passing an explicit state.
7519 *
7520 * In the non-external case, psa_generate_random() calls an
7521 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7522 * and semantics as mbedtls_psa_get_random(). As an optimization,
7523 * instead of doing this back-and-forth between the PSA API and the
7524 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7525 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007526 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007527#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7528int mbedtls_psa_get_random(void *p_rng,
7529 unsigned char *output,
7530 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007531{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007532 /* This function takes a pointer to the RNG state because that's what
7533 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7534 * its own state internally and doesn't let the caller access that state.
7535 * So we just ignore the state parameter, and in practice we'll pass
7536 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007537 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 psa_status_t status = psa_generate_random(output, output_size);
7539 if (status == PSA_SUCCESS) {
7540 return 0;
7541 } else {
7542 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7543 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007544}
7545#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7546
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007547#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007548psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7549 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007550{
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 if (global_data.initialized) {
7552 return PSA_ERROR_NOT_PERMITTED;
7553 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007554
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7556 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7557 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7558 return PSA_ERROR_INVALID_ARGUMENT;
7559 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007560
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007562}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007563#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007564
Ronald Cron3772afe2021-02-08 16:10:05 +01007565/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007566 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007567 * \param type The key type
7568 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007569 *
7570 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007571 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007572 * \retval #PSA_ERROR_INVALID_ARGUMENT
7573 * The size in bits of the key is not valid.
7574 * \retval #PSA_ERROR_NOT_SUPPORTED
7575 * The type and/or the size in bits of the key or the combination of
7576 * the two is not supported.
7577 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007578static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007580{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007581 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007582
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 if (key_type_is_raw_bytes(type)) {
7584 status = psa_validate_unstructured_key_bit_size(type, bits);
7585 if (status != PSA_SUCCESS) {
7586 return status;
7587 }
7588 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007589#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7591 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7592 return PSA_ERROR_NOT_SUPPORTED;
7593 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007594 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007595 return PSA_ERROR_NOT_SUPPORTED;
7596 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007597
Ronald Cron01b2aba2020-10-05 09:42:02 +02007598 /* Accept only byte-aligned keys, for the same reasons as
7599 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 if (bits % 8 != 0) {
7601 return PSA_ERROR_NOT_SUPPORTED;
7602 }
7603 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007604#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007605
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007606#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007608 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 return PSA_SUCCESS;
7610 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007611#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007612
Valerio Settia55f0422023-07-10 15:34:41 +02007613#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007614 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007615 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007616 return PSA_ERROR_NOT_SUPPORTED;
7617 }
7618 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007619#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007620 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007622 }
7623
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007625}
7626
Ronald Cron55ed0592020-10-05 10:30:40 +02007627psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007628 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007630{
7631 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007632 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007633
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 if ((attributes->domain_parameters == NULL) &&
7635 (attributes->domain_parameters_size != 0)) {
7636 return PSA_ERROR_INVALID_ARGUMENT;
7637 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007638
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 if (key_type_is_raw_bytes(type)) {
7640 status = psa_generate_random(key_buffer, key_buffer_size);
7641 if (status != PSA_SUCCESS) {
7642 return status;
7643 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007644
David Brown12ca5032021-02-11 11:02:00 -07007645#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 if (type == PSA_KEY_TYPE_DES) {
7647 psa_des_set_key_parity(key_buffer, key_buffer_size);
7648 }
David Brown8107e312021-02-12 08:08:46 -07007649#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007651
Valerio Setti76df8c12023-07-11 14:11:28 +02007652#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7654 return mbedtls_psa_rsa_generate_key(attributes,
7655 key_buffer,
7656 key_buffer_size,
7657 key_buffer_length);
7658 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007659#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007660
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007661#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007662 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7663 return mbedtls_psa_ecp_generate_key(attributes,
7664 key_buffer,
7665 key_buffer_size,
7666 key_buffer_length);
7667 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007668#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007669
Valerio Settia55f0422023-07-10 15:34:41 +02007670#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007671 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7672 return mbedtls_psa_ffdh_generate_key(attributes,
7673 key_buffer,
7674 key_buffer_size,
7675 key_buffer_length);
7676 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007677#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007678 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 (void) key_buffer_length;
7680 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007681 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007682
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007684}
Darryl Green0c6575a2018-11-07 16:05:30 +00007685
Gilles Peskine449bd832023-01-11 14:50:10 +01007686psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7687 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007688{
7689 psa_status_t status;
7690 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007691 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007692 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007693
Ronald Cron81709fc2020-11-14 12:10:32 +01007694 *key = MBEDTLS_SVC_KEY_ID_INIT;
7695
Gilles Peskine0f84d622019-09-12 19:03:13 +02007696 /* Reject any attempt to create a zero-length key so that we don't
7697 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007698 if (psa_get_key_bits(attributes) == 0) {
7699 return PSA_ERROR_INVALID_ARGUMENT;
7700 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007701
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007702 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7704 return PSA_ERROR_INVALID_ARGUMENT;
7705 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007706
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7708 &slot, &driver);
7709 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007710 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007711 }
Gilles Peskine11792082019-08-06 18:36:36 +02007712
Ronald Cron977c2472020-10-13 08:32:21 +02007713 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307714 * storage ( thus not in the case of generating a key in a secure element
7715 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7716 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 if (slot->key.data == NULL) {
7718 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7719 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007720 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 attributes->core.type, attributes->core.bits);
7722 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007723 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007725
7726 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007727 attributes->core.type,
7728 attributes->core.bits);
7729 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007730 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 attributes, &key_buffer_size);
7732 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007733 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 }
Ronald Cron977c2472020-10-13 08:32:21 +02007735 }
Ronald Cron977c2472020-10-13 08:32:21 +02007736
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7738 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007739 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007740 }
Ronald Cron977c2472020-10-13 08:32:21 +02007741 }
7742
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 status = psa_driver_wrapper_generate_key(attributes,
7744 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007745
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 if (status != PSA_SUCCESS) {
7747 psa_remove_key_data_from_memory(slot);
7748 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007749
Gilles Peskine11792082019-08-06 18:36:36 +02007750exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007751 if (status == PSA_SUCCESS) {
7752 status = psa_finish_key_creation(slot, driver, key);
7753 }
7754 if (status != PSA_SUCCESS) {
7755 psa_fail_key_creation(slot, driver);
7756 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007757
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007759}
7760
Gilles Peskinee59236f2018-01-27 23:32:46 +01007761/****************************************************************/
7762/* Module setup */
7763/****************************************************************/
7764
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007765#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007766psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 void (* entropy_init)(mbedtls_entropy_context *ctx),
7768 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007769{
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7771 return PSA_ERROR_BAD_STATE;
7772 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007773 global_data.rng.entropy_init = entropy_init;
7774 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007776}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007777#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007778
Gilles Peskine449bd832023-01-11 14:50:10 +01007779void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007780{
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007782 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7783 mbedtls_psa_random_free(&global_data.rng);
7784 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007785 /* Wipe all remaining data, including configuration.
7786 * In particular, this sets all state indicator to the value
7787 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007789
7790 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007791 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007792}
7793
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007794#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7795/** Recover a transaction that was interrupted by a power failure.
7796 *
7797 * This function is called during initialization, before psa_crypto_init()
7798 * returns. If this function returns a failure status, the initialization
7799 * fails.
7800 */
7801static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007803{
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007805 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7806 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007807 /* TODO - fall through to the failure case until this
7808 * is implemented.
7809 * https://github.com/ARMmbed/mbed-crypto/issues/218
7810 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007811 default:
7812 /* We found an unsupported transaction in the storage.
7813 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007815 }
7816}
7817#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7818
Gilles Peskine449bd832023-01-11 14:50:10 +01007819psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007820{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007821 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007822
Gilles Peskinec6b69072018-11-20 21:42:52 +01007823 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007824 if (global_data.initialized != 0) {
7825 return PSA_SUCCESS;
7826 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007827
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007828 /* Init drivers */
7829 status = psa_driver_wrapper_init();
7830 if (status != PSA_SUCCESS) {
7831 goto exit;
7832 }
7833 global_data.drivers_initialized = 1;
7834
Valerio Setti402cfba2023-11-13 10:24:32 +01007835 status = psa_initialize_key_slots();
7836 if (status != PSA_SUCCESS) {
7837 goto exit;
7838 }
7839
Gilles Peskine30524eb2020-11-13 17:02:26 +01007840 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007841 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007842 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007843 status = mbedtls_psa_random_seed(&global_data.rng);
7844 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007845 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007847 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007848
Gilles Peskine4b734222019-07-24 15:56:31 +02007849#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007850 status = psa_crypto_load_transaction();
7851 if (status == PSA_SUCCESS) {
7852 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7853 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007854 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 }
7856 status = psa_crypto_stop_transaction();
7857 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007858 /* There's no transaction to complete. It's all good. */
7859 status = PSA_SUCCESS;
7860 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007861#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007862
Gilles Peskinec6b69072018-11-20 21:42:52 +01007863 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007864 global_data.initialized = 1;
7865
7866exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 if (status != PSA_SUCCESS) {
7868 mbedtls_psa_crypto_free();
7869 }
7870 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007871}
7872
Yanray Wangffc3c482023-07-11 12:01:04 +08007873#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007874psa_status_t psa_crypto_driver_pake_get_password_len(
7875 const psa_crypto_driver_pake_inputs_t *inputs,
7876 size_t *password_len)
7877{
7878 if (inputs->password_len == 0) {
7879 return PSA_ERROR_BAD_STATE;
7880 }
7881
7882 *password_len = inputs->password_len;
7883
7884 return PSA_SUCCESS;
7885}
7886
7887psa_status_t psa_crypto_driver_pake_get_password(
7888 const psa_crypto_driver_pake_inputs_t *inputs,
7889 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7890{
7891 if (inputs->password_len == 0) {
7892 return PSA_ERROR_BAD_STATE;
7893 }
7894
7895 if (buffer_size < inputs->password_len) {
7896 return PSA_ERROR_BUFFER_TOO_SMALL;
7897 }
7898
7899 memcpy(buffer, inputs->password, inputs->password_len);
7900 *buffer_length = inputs->password_len;
7901
7902 return PSA_SUCCESS;
7903}
7904
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007905psa_status_t psa_crypto_driver_pake_get_user_len(
7906 const psa_crypto_driver_pake_inputs_t *inputs,
7907 size_t *user_len)
7908{
7909 if (inputs->user_len == 0) {
7910 return PSA_ERROR_BAD_STATE;
7911 }
7912
7913 *user_len = inputs->user_len;
7914
7915 return PSA_SUCCESS;
7916}
7917
7918psa_status_t psa_crypto_driver_pake_get_user(
7919 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007920 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007921{
7922 if (inputs->user_len == 0) {
7923 return PSA_ERROR_BAD_STATE;
7924 }
7925
Przemek Stekielc0e62502023-03-14 11:49:36 +01007926 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007927 return PSA_ERROR_BUFFER_TOO_SMALL;
7928 }
7929
Przemek Stekielc0e62502023-03-14 11:49:36 +01007930 memcpy(user_id, inputs->user, inputs->user_len);
7931 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007932
7933 return PSA_SUCCESS;
7934}
7935
7936psa_status_t psa_crypto_driver_pake_get_peer_len(
7937 const psa_crypto_driver_pake_inputs_t *inputs,
7938 size_t *peer_len)
7939{
7940 if (inputs->peer_len == 0) {
7941 return PSA_ERROR_BAD_STATE;
7942 }
7943
7944 *peer_len = inputs->peer_len;
7945
7946 return PSA_SUCCESS;
7947}
7948
7949psa_status_t psa_crypto_driver_pake_get_peer(
7950 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007951 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007952{
7953 if (inputs->peer_len == 0) {
7954 return PSA_ERROR_BAD_STATE;
7955 }
7956
Przemek Stekielc0e62502023-03-14 11:49:36 +01007957 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007958 return PSA_ERROR_BUFFER_TOO_SMALL;
7959 }
7960
Przemek Stekielc0e62502023-03-14 11:49:36 +01007961 memcpy(peer_id, inputs->peer, inputs->peer_len);
7962 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007963
7964 return PSA_SUCCESS;
7965}
7966
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007967psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7968 const psa_crypto_driver_pake_inputs_t *inputs,
7969 psa_pake_cipher_suite_t *cipher_suite)
7970{
7971 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7972 return PSA_ERROR_BAD_STATE;
7973 }
7974
7975 *cipher_suite = inputs->cipher_suite;
7976
7977 return PSA_SUCCESS;
7978}
7979
Neil Armstronga7d08c32022-06-01 18:21:20 +02007980psa_status_t psa_pake_setup(
7981 psa_pake_operation_t *operation,
7982 const psa_pake_cipher_suite_t *cipher_suite)
7983{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007984 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007985
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007986 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007987 status = PSA_ERROR_BAD_STATE;
7988 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007989 }
7990
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007991 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007992 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007993 status = PSA_ERROR_INVALID_ARGUMENT;
7994 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007995 }
7996
Przemek Stekiel51eac532022-12-07 11:04:51 +01007997 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7998
Przemek Stekiele12ed362022-12-21 12:54:46 +01007999 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008000 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8001 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008002 operation->data.inputs.cipher_suite = *cipher_suite;
8003
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008004#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008005 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008006 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008007 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008008
David Horstmann16f01512023-06-14 17:21:07 +01008009 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008010 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008011 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008012#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008013 {
8014 status = PSA_ERROR_NOT_SUPPORTED;
8015 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008016 }
8017
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008018 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8019
Przemek Stekiel51eac532022-12-07 11:04:51 +01008020 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008021exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008022 psa_pake_abort(operation);
8023 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008024}
8025
8026psa_status_t psa_pake_set_password_key(
8027 psa_pake_operation_t *operation,
8028 mbedtls_svc_key_id_t password)
8029{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008030 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008031 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8032 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008033 psa_key_attributes_t attributes;
8034 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008035
Przemek Stekiel51eac532022-12-07 11:04:51 +01008036 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008037 status = PSA_ERROR_BAD_STATE;
8038 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008039 }
8040
Przemek Stekiel6c764412022-11-22 14:05:12 +01008041 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8042 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008043 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008044 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008045 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008046 }
8047
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008048 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008049 .core = slot->attr
8050 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008051
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008052 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008053
Przemek Stekiel51eac532022-12-07 11:04:51 +01008054 if (type != PSA_KEY_TYPE_PASSWORD &&
8055 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8056 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008057 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008058 }
8059
Przemek Stekiel51eac532022-12-07 11:04:51 +01008060 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8061 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008062 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008063 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008064 }
8065
8066 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8067 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008068 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008069exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008070 if (status != PSA_SUCCESS) {
8071 psa_pake_abort(operation);
8072 }
Ryan Everett1b70a072024-01-04 10:32:49 +00008073 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008074 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008075}
8076
8077psa_status_t psa_pake_set_user(
8078 psa_pake_operation_t *operation,
8079 const uint8_t *user_id,
8080 size_t user_id_len)
8081{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008082 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008083
8084 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008085 status = PSA_ERROR_BAD_STATE;
8086 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008087 }
8088
Przemek Stekiel51eac532022-12-07 11:04:51 +01008089 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008090 status = PSA_ERROR_INVALID_ARGUMENT;
8091 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008092 }
8093
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008094 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008095 status = PSA_ERROR_BAD_STATE;
8096 goto exit;
8097 }
8098
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008099 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8100 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008101 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8102 goto exit;
8103 }
8104
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008105 memcpy(operation->data.inputs.user, user_id, user_id_len);
8106 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008107
8108 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008109exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008110 psa_pake_abort(operation);
8111 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008112}
8113
8114psa_status_t psa_pake_set_peer(
8115 psa_pake_operation_t *operation,
8116 const uint8_t *peer_id,
8117 size_t peer_id_len)
8118{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008119 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008120
8121 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008122 status = PSA_ERROR_BAD_STATE;
8123 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008124 }
8125
Przemek Stekiel51eac532022-12-07 11:04:51 +01008126 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008127 status = PSA_ERROR_INVALID_ARGUMENT;
8128 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008129 }
8130
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008131 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008132 status = PSA_ERROR_BAD_STATE;
8133 goto exit;
8134 }
8135
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008136 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8137 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008138 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8139 goto exit;
8140 }
8141
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008142 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8143 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008144
8145 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008146exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008147 psa_pake_abort(operation);
8148 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008149}
8150
8151psa_status_t psa_pake_set_role(
8152 psa_pake_operation_t *operation,
8153 psa_pake_role_t role)
8154{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008155 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008156
Przemek Stekiel51eac532022-12-07 11:04:51 +01008157 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008158 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008159 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008160 }
8161
Przemek Stekiel09104b82023-03-06 14:11:51 +01008162 switch (operation->alg) {
8163#if defined(PSA_WANT_ALG_JPAKE)
8164 case PSA_ALG_JPAKE:
8165 if (role == PSA_PAKE_ROLE_NONE) {
8166 return PSA_SUCCESS;
8167 }
8168 status = PSA_ERROR_INVALID_ARGUMENT;
8169 break;
8170#endif
8171 default:
8172 (void) role;
8173 status = PSA_ERROR_NOT_SUPPORTED;
8174 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008175 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008176exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008177 psa_pake_abort(operation);
8178 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008179}
8180
David Horstmanne7f21e62023-05-12 18:17:21 +01008181/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008182#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008183static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008184 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008185{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008186 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008187 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008188 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008189
David Horstmann024e5c52023-06-14 15:48:21 +01008190 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008191 is_x1 = (stage->outputs < 1);
8192 } else {
8193 is_x1 = (stage->inputs < 1);
8194 }
8195
David Horstmann74a3d8c2023-06-14 18:28:19 +01008196 key_share_step = is_x1 ?
8197 PSA_JPAKE_X1_STEP_KEY_SHARE :
8198 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008199 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008200 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8201 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8202 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8203 } else {
8204 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008205 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008206 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008207}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008208#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008209
Przemek Stekiel2797d372022-12-22 11:19:22 +01008210static psa_status_t psa_pake_complete_inputs(
8211 psa_pake_operation_t *operation)
8212{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008213 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008214 /* Create copy of the inputs on stack as inputs share memory
8215 with the driver context which will be setup by the driver. */
8216 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008217
Przemek Stekielfde11282023-03-13 16:06:09 +01008218 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008219 return PSA_ERROR_BAD_STATE;
8220 }
8221
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008222 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008223 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8224 return PSA_ERROR_BAD_STATE;
8225 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008226 }
8227
Przemek Stekiel18620a32023-01-17 16:34:52 +01008228 /* Clear driver context */
8229 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8230
8231 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008232
8233 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008234 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008235
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008236 /* User and peer are translated to role. */
8237 mbedtls_free(inputs.user);
8238 mbedtls_free(inputs.peer);
8239
Przemek Stekiel2797d372022-12-22 11:19:22 +01008240 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008241#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008242 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008243 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008244 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008245#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008246 {
8247 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008248 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008249 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008250 return status;
8251}
8252
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008253#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008254static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008255 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008256 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008257 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008258{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008259 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8260 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8261 step != PSA_PAKE_STEP_ZK_PROOF) {
8262 return PSA_ERROR_INVALID_ARGUMENT;
8263 }
8264
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008265 psa_jpake_computation_stage_t *computation_stage =
8266 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008267
David Horstmann5da95602023-06-08 15:37:12 +01008268 if (computation_stage->round != PSA_JPAKE_FIRST &&
8269 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008270 return PSA_ERROR_BAD_STATE;
8271 }
8272
David Horstmanne7f21e62023-05-12 18:17:21 +01008273 /* Check that the step we are given is the one we were expecting */
8274 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008275 return PSA_ERROR_BAD_STATE;
8276 }
8277
David Horstmanne7f21e62023-05-12 18:17:21 +01008278 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8279 computation_stage->inputs == 0 &&
8280 computation_stage->outputs == 0) {
8281 /* Start of the round, so function decides whether we are inputting
8282 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008283 computation_stage->io_mode = io_mode;
8284 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008285 /* Middle of the round so the mode we are in must match the function
8286 * called by the user */
8287 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008288 }
8289
8290 return PSA_SUCCESS;
8291}
8292
David Horstmanne7f21e62023-05-12 18:17:21 +01008293static psa_status_t psa_jpake_epilogue(
8294 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008295 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008296{
David Horstmanne7f21e62023-05-12 18:17:21 +01008297 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008298 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008299
David Horstmanne7f21e62023-05-12 18:17:21 +01008300 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8301 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008302 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008303 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008304 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008305 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008306 }
8307 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008308 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008309 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008310 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008311 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008312 }
8313 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008314 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8315 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008316 /* End of a round, move to the next round */
8317 stage->inputs = 0;
8318 stage->outputs = 0;
8319 stage->round++;
8320 }
8321 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008322 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008323 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008324 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008325 return PSA_SUCCESS;
8326}
David Horstmanne7f21e62023-05-12 18:17:21 +01008327
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008328#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008329
Neil Armstronga7d08c32022-06-01 18:21:20 +02008330psa_status_t psa_pake_output(
8331 psa_pake_operation_t *operation,
8332 psa_pake_step_t step,
8333 uint8_t *output,
8334 size_t output_size,
8335 size_t *output_length)
8336{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008337 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008338 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008339 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008340
8341 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008342 status = psa_pake_complete_inputs(operation);
8343 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008344 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008345 }
8346 }
8347
8348 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008349 status = PSA_ERROR_BAD_STATE;
8350 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008351 }
8352
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008353 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008354 status = PSA_ERROR_INVALID_ARGUMENT;
8355 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008356 }
8357
Przemek Stekiele12ed362022-12-21 12:54:46 +01008358 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008359#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008360 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008361 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008362 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008363 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008364 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008365 driver_step = convert_jpake_computation_stage_to_driver_step(
8366 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008367 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008368#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008369 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008370 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008371 status = PSA_ERROR_NOT_SUPPORTED;
8372 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008373 }
8374
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008375 status = psa_driver_wrapper_pake_output(operation, driver_step,
8376 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008377
8378 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008379 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008380 }
8381
8382 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008383#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008384 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008385 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008386 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008387 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008388 }
8389 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008390#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008391 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008392 status = PSA_ERROR_NOT_SUPPORTED;
8393 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008394 }
8395
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008396 return PSA_SUCCESS;
8397exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008398 psa_pake_abort(operation);
8399 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008400}
8401
8402psa_status_t psa_pake_input(
8403 psa_pake_operation_t *operation,
8404 psa_pake_step_t step,
8405 const uint8_t *input,
8406 size_t input_length)
8407{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008408 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008409 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008410 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8411 operation->primitive,
8412 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008413
8414 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008415 status = psa_pake_complete_inputs(operation);
8416 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008417 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008418 }
8419 }
8420
8421 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008422 status = PSA_ERROR_BAD_STATE;
8423 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008424 }
8425
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008426 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008427 status = PSA_ERROR_INVALID_ARGUMENT;
8428 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008429 }
8430
Przemek Stekiele12ed362022-12-21 12:54:46 +01008431 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008432#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008433 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008434 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008435 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008436 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008437 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008438 driver_step = convert_jpake_computation_stage_to_driver_step(
8439 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008440 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008441#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008442 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008443 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008444 status = PSA_ERROR_NOT_SUPPORTED;
8445 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008446 }
8447
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008448 status = psa_driver_wrapper_pake_input(operation, driver_step,
8449 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008450
8451 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008452 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008453 }
8454
8455 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008456#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008457 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008458 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008459 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008460 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008461 }
8462 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008463#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008464 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008465 status = PSA_ERROR_NOT_SUPPORTED;
8466 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008467 }
8468
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008469 return PSA_SUCCESS;
8470exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008471 psa_pake_abort(operation);
8472 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008473}
8474
8475psa_status_t psa_pake_get_implicit_key(
8476 psa_pake_operation_t *operation,
8477 psa_key_derivation_operation_t *output)
8478{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008479 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008480 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008481 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008482 size_t shared_key_len = 0;
8483
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008484 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008485 status = PSA_ERROR_BAD_STATE;
8486 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008487 }
8488
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008489#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008490 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008491 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008492 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008493 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008494 status = PSA_ERROR_BAD_STATE;
8495 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008496 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008497 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008498#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008499 {
8500 status = PSA_ERROR_NOT_SUPPORTED;
8501 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008502 }
8503
Przemek Stekiel0c781802022-11-29 14:53:13 +01008504 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8505 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008506 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008507 &shared_key_len);
8508
8509 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008510 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008511 }
8512
8513 status = psa_key_derivation_input_bytes(output,
8514 PSA_KEY_DERIVATION_INPUT_SECRET,
8515 shared_key,
8516 shared_key_len);
8517
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008518 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008519exit:
8520 abort_status = psa_pake_abort(operation);
8521 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008522}
8523
8524psa_status_t psa_pake_abort(
8525 psa_pake_operation_t *operation)
8526{
Przemek Stekield69dca92023-01-31 19:59:20 +01008527 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008528
Przemek Stekield69dca92023-01-31 19:59:20 +01008529 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008530 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008531 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008532
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008533 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8534 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008535 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008536 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008537 }
8538 if (operation->data.inputs.user != NULL) {
8539 mbedtls_free(operation->data.inputs.user);
8540 }
8541 if (operation->data.inputs.peer != NULL) {
8542 mbedtls_free(operation->data.inputs.peer);
8543 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008544 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008545 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008546
Przemek Stekield69dca92023-01-31 19:59:20 +01008547 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008548}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008549#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008550
David Horstmann00d7a042023-12-07 18:39:17 +00008551/* Memory copying test hooks. These are called before input copy, after input
8552 * copy, before output copy and after output copy, respectively.
8553 * They are used by memory-poisoning tests to temporarily unpoison buffers
8554 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008555#if defined(MBEDTLS_TEST_HOOKS)
8556void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8557void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8558void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8559void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8560#endif
David Horstmannfde97392023-10-30 20:29:43 +00008561
David Horstmann1b7279a2023-11-15 15:18:30 +00008562/** Copy from an input buffer to a local copy.
8563 *
8564 * \param[in] input Pointer to input buffer.
8565 * \param[in] input_len Length of the input buffer.
8566 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8567 * \param[out] input_copy_len Length of the local copy buffer.
8568 * \return #PSA_SUCCESS, if the buffer was successfully
8569 * copied.
8570 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8571 * copy is too small to hold contents of the
8572 * input buffer.
8573 */
8574MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008575psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8576 uint8_t *input_copy, size_t input_copy_len)
8577{
8578 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008579 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008580 }
8581
David Horstmann372b8bb2023-11-24 16:21:04 +00008582#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008583 if (psa_input_pre_copy_hook != NULL) {
8584 psa_input_pre_copy_hook(input, input_len);
8585 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008586#endif
8587
David Horstmann777e7412023-11-15 17:33:47 +00008588 if (input_len > 0) {
8589 memcpy(input_copy, input, input_len);
8590 }
David Horstmannfde97392023-10-30 20:29:43 +00008591
David Horstmann372b8bb2023-11-24 16:21:04 +00008592#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008593 if (psa_input_post_copy_hook != NULL) {
8594 psa_input_post_copy_hook(input, input_len);
8595 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008596#endif
8597
David Horstmannfde97392023-10-30 20:29:43 +00008598 return PSA_SUCCESS;
8599}
8600
David Horstmann1b7279a2023-11-15 15:18:30 +00008601/** Copy from a local output buffer into a user-supplied one.
8602 *
8603 * \param[in] output_copy Pointer to a local buffer containing the output.
8604 * \param[in] output_copy_len Length of the local buffer.
8605 * \param[out] output Pointer to user-supplied output buffer.
8606 * \param[out] output_len Length of the user-supplied output buffer.
8607 * \return #PSA_SUCCESS, if the buffer was successfully
8608 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008609 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008610 * user-supplied output buffer is too small to
8611 * hold the contents of the local buffer.
8612 */
8613MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008614psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8615 uint8_t *output, size_t output_len)
8616{
8617 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008618 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008619 }
David Horstmann777e7412023-11-15 17:33:47 +00008620
David Horstmann372b8bb2023-11-24 16:21:04 +00008621#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008622 if (psa_output_pre_copy_hook != NULL) {
8623 psa_output_pre_copy_hook(output, output_len);
8624 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008625#endif
8626
David Horstmann777e7412023-11-15 17:33:47 +00008627 if (output_copy_len > 0) {
8628 memcpy(output, output_copy, output_copy_len);
8629 }
8630
David Horstmann372b8bb2023-11-24 16:21:04 +00008631#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008632 if (psa_output_post_copy_hook != NULL) {
8633 psa_output_post_copy_hook(output, output_len);
8634 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008635#endif
8636
David Horstmann8978f5c2023-10-30 20:37:12 +00008637 return PSA_SUCCESS;
8638}
8639
David Horstmannf1734052023-11-20 17:15:32 +00008640psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8641 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008642{
8643 psa_status_t status;
8644
David Horstmann9db14482023-11-23 15:50:37 +00008645 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008646
David Horstmannc5cc1c32023-11-15 18:11:26 +00008647 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008648 return PSA_SUCCESS;
8649 }
8650
David Horstmannf1734052023-11-20 17:15:32 +00008651 local_input->buffer = mbedtls_calloc(input_len, 1);
8652 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008653 /* Since we dealt with the zero-length case above, we know that
8654 * a NULL return value means a failure of allocation. */
8655 return PSA_ERROR_INSUFFICIENT_MEMORY;
8656 }
David Horstmannf1734052023-11-20 17:15:32 +00008657 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008658
David Horstmannf1734052023-11-20 17:15:32 +00008659 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008660
8661 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008662 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008663 if (status != PSA_SUCCESS) {
8664 goto error;
8665 }
8666
8667 return PSA_SUCCESS;
8668
8669error:
David Horstmannf1734052023-11-20 17:15:32 +00008670 mbedtls_free(local_input->buffer);
8671 local_input->buffer = NULL;
8672 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008673 return status;
8674}
8675
David Horstmannf1734052023-11-20 17:15:32 +00008676void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008677{
David Horstmannf1734052023-11-20 17:15:32 +00008678 mbedtls_free(local_input->buffer);
8679 local_input->buffer = NULL;
8680 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008681}
8682
David Horstmann89875a42023-11-20 12:54:09 +00008683psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8684 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008685{
David Horstmann9db14482023-11-23 15:50:37 +00008686 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008687
David Horstmannc5cc1c32023-11-15 18:11:26 +00008688 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008689 return PSA_SUCCESS;
8690 }
David Horstmann89875a42023-11-20 12:54:09 +00008691 local_output->buffer = mbedtls_calloc(output_len, 1);
8692 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008693 /* Since we dealt with the zero-length case above, we know that
8694 * a NULL return value means a failure of allocation. */
8695 return PSA_ERROR_INSUFFICIENT_MEMORY;
8696 }
David Horstmann89875a42023-11-20 12:54:09 +00008697 local_output->length = output_len;
8698 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008699
8700 return PSA_SUCCESS;
8701}
8702
Gabor Mezei1882c512024-01-24 13:07:17 +01008703psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8704 psa_crypto_local_output_t *local_output)
8705{
8706 psa_status_t status;
8707 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8708
8709 if (output_len == 0) {
8710 return PSA_SUCCESS;
8711 }
8712 local_output->buffer = mbedtls_calloc(output_len, 1);
8713 if (local_output->buffer == NULL) {
8714 /* Since we dealt with the zero-length case above, we know that
8715 * a NULL return value means a failure of allocation. */
8716 return PSA_ERROR_INSUFFICIENT_MEMORY;
8717 }
8718 local_output->length = output_len;
8719 local_output->original = output;
8720
8721 status = psa_crypto_copy_input(output, output_len,
8722 local_output->buffer, local_output->length);
8723 if (status != PSA_SUCCESS) {
8724 goto error;
8725 }
8726
8727 return PSA_SUCCESS;
8728
8729error:
8730 mbedtls_free(local_output->buffer);
8731 local_output->buffer = NULL;
8732 local_output->length = 0;
8733 return status;
8734}
8735
David Horstmann89875a42023-11-20 12:54:09 +00008736psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008737{
David Horstmannc335a4e2023-11-15 15:57:32 +00008738 psa_status_t status;
8739
David Horstmann89875a42023-11-20 12:54:09 +00008740 if (local_output->buffer == NULL) {
8741 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008742 return PSA_SUCCESS;
8743 }
David Horstmann89875a42023-11-20 12:54:09 +00008744 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008745 /* We have an internal copy but nothing to copy back to. */
8746 return PSA_ERROR_CORRUPTION_DETECTED;
8747 }
8748
David Horstmann89875a42023-11-20 12:54:09 +00008749 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8750 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008751 if (status != PSA_SUCCESS) {
8752 return status;
8753 }
David Horstmann9467ea32023-11-08 17:44:18 +00008754
David Horstmann89875a42023-11-20 12:54:09 +00008755 mbedtls_free(local_output->buffer);
8756 local_output->buffer = NULL;
8757 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008758
8759 return PSA_SUCCESS;
8760}
8761
Gilles Peskinee59236f2018-01-27 23:32:46 +01008762#endif /* MBEDTLS_PSA_CRYPTO_C */