blob: 1cde8688b7c46dbdc530867552fa6ef904f720ee [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,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002369 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 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;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002373 LOCAL_INPUT_DECLARE(input_external, input);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002374
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002376 status = PSA_ERROR_BAD_STATE;
2377 goto exit;
2378 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002379
Steven Cooremanc8288352021-03-04 14:02:19 +01002380 /* Don't require hash implementations to behave correctly on a
2381 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 if (input_length == 0) {
2383 return PSA_SUCCESS;
2384 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002385
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002386 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002388
2389exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 if (status != PSA_SUCCESS) {
2391 psa_hash_abort(operation);
2392 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002393
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002394 LOCAL_INPUT_FREE(input_external, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002396}
2397
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002398psa_status_t psa_hash_finish_internal(psa_hash_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 uint8_t *hash,
2400 size_t hash_size,
2401 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002402{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2404
Steven Cooremanfbe09282021-03-08 18:41:12 +01002405 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 if (operation->id == 0) {
2407 return PSA_ERROR_BAD_STATE;
2408 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002409
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002410 status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 operation, hash, hash_size, hash_length);
2412 psa_hash_abort(operation);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002413
2414 return status;
2415}
2416
2417psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2418 uint8_t *hash_external,
2419 size_t hash_size,
2420 size_t *hash_length)
2421{
2422 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2423 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2424
2425 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2426 status = psa_hash_finish_internal(operation, hash, hash_size, hash_length);
2427
2428exit:
2429 LOCAL_OUTPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002431}
2432
Gilles Peskine449bd832023-01-11 14:50:10 +01002433psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002434 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002436{
Ronald Cron69a63422021-10-18 09:47:58 +02002437 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002438 size_t actual_hash_length;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002439 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2440 LOCAL_INPUT_DECLARE(hash_external, hash);
2441
2442 status = psa_hash_finish_internal(
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 operation,
2444 actual_hash, sizeof(actual_hash),
2445 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002448 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002452 status = PSA_ERROR_INVALID_SIGNATURE;
2453 goto exit;
2454 }
2455
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002456 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002457 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002458 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002460
2461exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2463 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002464 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 }
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002466 LOCAL_INPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002468}
2469
Gilles Peskine449bd832023-01-11 14:50:10 +01002470psa_status_t psa_hash_compute(psa_algorithm_t alg,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002471 const uint8_t *input_external, size_t input_length,
2472 uint8_t *hash_external, size_t hash_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002474{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002475 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2476 LOCAL_INPUT_DECLARE(input_external, input);
2477 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2478
Steven Cooremanfbe09282021-03-08 18:41:12 +01002479 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 if (!PSA_ALG_IS_HASH(alg)) {
2481 return PSA_ERROR_INVALID_ARGUMENT;
2482 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002483
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002484 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2485 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2486 status = psa_driver_wrapper_hash_compute(alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 hash, hash_size, hash_length);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002488
2489exit:
2490 LOCAL_INPUT_FREE(input_external, input);
2491 LOCAL_OUTPUT_FREE(hash_external, hash);
2492 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002493}
2494
Gilles Peskine449bd832023-01-11 14:50:10 +01002495psa_status_t psa_hash_compare(psa_algorithm_t alg,
2496 const uint8_t *input, size_t input_length,
2497 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002498{
Ronald Cron69a63422021-10-18 09:47:58 +02002499 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002500 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002501
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 if (!PSA_ALG_IS_HASH(alg)) {
2503 return PSA_ERROR_INVALID_ARGUMENT;
2504 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002505
Steven Cooreman1e582352021-02-18 17:24:37 +01002506 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 alg, input, input_length,
2508 actual_hash, sizeof(actual_hash),
2509 &actual_hash_length);
2510 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002511 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 }
2513 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002514 status = PSA_ERROR_INVALID_SIGNATURE;
2515 goto exit;
2516 }
Dave Rodgman78701152023-08-29 14:20:18 +01002517 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002518 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002520
2521exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2523 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002524}
2525
Gilles Peskine449bd832023-01-11 14:50:10 +01002526psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2527 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002528{
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 if (source_operation->id == 0 ||
2530 target_operation->id != 0) {
2531 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002532 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002533
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2535 target_operation);
2536 if (status != PSA_SUCCESS) {
2537 psa_hash_abort(target_operation);
2538 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002539
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002541}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002542
2543
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002544/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002545/* MAC */
2546/****************************************************************/
2547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002549{
Steven Cooremane6804192021-03-19 18:28:56 +01002550 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 if (operation->id == 0) {
2552 return PSA_SUCCESS;
2553 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002554
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002556 operation->mac_size = 0;
2557 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002558 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002561}
2562
Ronald Cron2dff3b22021-06-17 16:33:22 +02002563static psa_status_t psa_mac_finalize_alg_and_key_validation(
2564 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002565 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002567{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002568 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 psa_key_type_t key_type = psa_get_key_type(attributes);
2570 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 if (!PSA_ALG_IS_MAC(alg)) {
2573 return PSA_ERROR_INVALID_ARGUMENT;
2574 }
Steven Cooremane6804192021-03-19 18:28:56 +01002575
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002576 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 status = psa_mac_key_can_do(alg, key_type);
2578 if (status != PSA_SUCCESS) {
2579 return status;
2580 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002581
Steven Cooremand1a68f12021-05-10 11:13:41 +02002582 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002584
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002586 /* A very short MAC is too short for security since it can be
2587 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2588 * so we make this our minimum, even though 32 bits is still
2589 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002591 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2594 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002595 /* It's impossible to "truncate" to a larger length than the full length
2596 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002598 }
2599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002601 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2602 * that is disabled in the compile-time configuration. The result can
2603 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2604 * configuration into account. In this case, force a return of
2605 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2606 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2607 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2608 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2609 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002611 }
2612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002614}
2615
Gilles Peskine449bd832023-01-11 14:50:10 +01002616static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2617 mbedtls_svc_key_id_t key,
2618 psa_algorithm_t alg,
2619 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002620{
2621 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2622 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002623 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002624 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002625
2626 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002628 status = PSA_ERROR_BAD_STATE;
2629 goto exit;
2630 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002631
2632 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 key,
2634 &slot,
2635 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2636 alg);
2637 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002638 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002640
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002641 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002642 .core = slot->attr
2643 };
2644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2646 &operation->mac_size);
2647 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002648 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002650
2651 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002652 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 if (is_sign) {
2654 status = psa_driver_wrapper_mac_sign_setup(operation,
2655 &attributes,
2656 slot->key.data,
2657 slot->key.bytes,
2658 alg);
2659 } else {
2660 status = psa_driver_wrapper_mac_verify_setup(operation,
2661 &attributes,
2662 slot->key.data,
2663 slot->key.bytes,
2664 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002665 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002666
Gilles Peskinefbfac682018-07-08 20:51:54 +02002667exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 if (status != PSA_SUCCESS) {
2669 psa_mac_abort(operation);
2670 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002671
Ryan Everett1b70a072024-01-04 10:32:49 +00002672 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002675}
2676
Gilles Peskine449bd832023-01-11 14:50:10 +01002677psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2678 mbedtls_svc_key_id_t key,
2679 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002680{
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002682}
2683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2685 mbedtls_svc_key_id_t key,
2686 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002687{
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002689}
2690
Gilles Peskine449bd832023-01-11 14:50:10 +01002691psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2692 const uint8_t *input,
2693 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002694{
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 if (operation->id == 0) {
2696 return PSA_ERROR_BAD_STATE;
2697 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002698
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002699 /* Don't require hash implementations to behave correctly on a
2700 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 if (input_length == 0) {
2702 return PSA_SUCCESS;
2703 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2706 input, input_length);
2707 if (status != PSA_SUCCESS) {
2708 psa_mac_abort(operation);
2709 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002710
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002712}
2713
Gilles Peskine449bd832023-01-11 14:50:10 +01002714psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2715 uint8_t *mac,
2716 size_t mac_size,
2717 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002718{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002719 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2720 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002721
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002723 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002724 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002725 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002728 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002729 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002730 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002731
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002732 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2733 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002735 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002736 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002737 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002738
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002740 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002741 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002742 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002743
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 status = psa_driver_wrapper_mac_sign_finish(operation,
2745 mac, operation->mac_size,
2746 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002747
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002748exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002749 /* In case of success, set the potential excess room in the output buffer
2750 * to an invalid value, to avoid potentially leaking a longer MAC.
2751 * In case of error, set the output length and content to a safe default,
2752 * such that in case the caller misses an error check, the output would be
2753 * an unachievable MAC.
2754 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002756 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002757 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002758 }
mohammad16036df908f2018-04-02 08:34:15 -07002759
Paul Elliottdc42ca82023-02-24 18:11:59 +00002760 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002761
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002763
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002765}
2766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2768 const uint8_t *mac,
2769 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002770{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002771 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2772 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002773
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002775 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002776 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002777 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002778
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002780 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002781 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002782 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002783
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002785 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002786 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002787 }
2788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 status = psa_driver_wrapper_mac_verify_finish(operation,
2790 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002791
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002792exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002796}
2797
Gilles Peskine449bd832023-01-11 14:50:10 +01002798static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2799 psa_algorithm_t alg,
2800 const uint8_t *input,
2801 size_t input_length,
2802 uint8_t *mac,
2803 size_t mac_size,
2804 size_t *mac_length,
2805 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002806{
2807 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002808 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2809 psa_key_slot_t *slot;
2810 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002811 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002812
Ronald Cron51131b52021-06-17 17:17:20 +02002813 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 key,
2815 &slot,
2816 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2817 alg);
2818 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002819 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002821
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002822 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002823 .core = slot->attr
2824 };
2825
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2827 &operation_mac_size);
2828 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002829 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002831
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002833 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002834 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002835 }
2836
2837 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 &attributes,
2839 slot->key.data, slot->key.bytes,
2840 alg,
2841 input, input_length,
2842 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002843
2844exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002845 /* In case of success, set the potential excess room in the output buffer
2846 * to an invalid value, to avoid potentially leaking a longer MAC.
2847 * In case of error, set the output length and content to a safe default,
2848 * such that in case the caller misses an error check, the output would be
2849 * an unachievable MAC.
2850 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002852 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002853 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002854 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002855
2856 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002857
Ryan Everett1b70a072024-01-04 10:32:49 +00002858 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002861}
2862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002864 psa_algorithm_t alg,
2865 const uint8_t *input,
2866 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 uint8_t *mac,
2868 size_t mac_size,
2869 size_t *mac_length)
2870{
2871 return psa_mac_compute_internal(key, alg,
2872 input, input_length,
2873 mac, mac_size, mac_length, 1);
2874}
2875
2876psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2877 psa_algorithm_t alg,
2878 const uint8_t *input,
2879 size_t input_length,
2880 const uint8_t *mac,
2881 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002882{
2883 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002884 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2885 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002886
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 }
Dave Rodgman78701152023-08-29 14:20:18 +01002899 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002900 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002901 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002902 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002903
2904exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002906
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002908}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002909
Gilles Peskinee59236f2018-01-27 23:32:46 +01002910/****************************************************************/
2911/* Asymmetric cryptography */
2912/****************************************************************/
2913
Gilles Peskine449bd832023-01-11 14:50:10 +01002914static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2915 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002916{
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 if (input_is_message) {
2918 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2919 return PSA_ERROR_INVALID_ARGUMENT;
2920 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2923 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2924 return PSA_ERROR_INVALID_ARGUMENT;
2925 }
2926 }
2927 } else {
2928 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2929 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002930 }
2931 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002932
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002934}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002935
Gilles Peskine449bd832023-01-11 14:50:10 +01002936static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2937 int input_is_message,
2938 psa_algorithm_t alg,
2939 const uint8_t *input,
2940 size_t input_length,
2941 uint8_t *signature,
2942 size_t signature_size,
2943 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002944{
2945 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2946 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2947 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002948 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002949
2950 *signature_length = 0;
2951
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 status = psa_sign_verify_check_alg(input_is_message, alg);
2953 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002954 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002955 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002956
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002957 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002958 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002959 * buffer can in principle be empty since it doesn't actually have
2960 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 if (signature_size == 0) {
2962 return PSA_ERROR_BUFFER_TOO_SMALL;
2963 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002964
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002965 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 key, &slot,
2967 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2968 PSA_KEY_USAGE_SIGN_HASH,
2969 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002972 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002974
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002976 status = PSA_ERROR_INVALID_ARGUMENT;
2977 goto exit;
2978 }
2979
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002980 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002982 };
2983
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002985 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002986 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002987 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 signature, signature_size, signature_length);
2989 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002990
2991 status = psa_driver_wrapper_sign_hash(
2992 &attributes, slot->key.data, slot->key.bytes,
2993 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002995 }
2996
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002997
2998exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002999 psa_wipe_tag_output_buffer(signature, status, signature_size,
3000 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003001
Ryan Everett1b70a072024-01-04 10:32:49 +00003002 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003003
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003005}
3006
Gilles Peskine449bd832023-01-11 14:50:10 +01003007static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3008 int input_is_message,
3009 psa_algorithm_t alg,
3010 const uint8_t *input,
3011 size_t input_length,
3012 const uint8_t *signature,
3013 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003014{
3015 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3016 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3017 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 status = psa_sign_verify_check_alg(input_is_message, alg);
3020 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003021 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003023
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003024 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 key, &slot,
3026 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3027 PSA_KEY_USAGE_VERIFY_HASH,
3028 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003029
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 if (status != PSA_SUCCESS) {
3031 return status;
3032 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003033
3034 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003036 };
3037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003039 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003040 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003041 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 signature, signature_length);
3043 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003044 status = psa_driver_wrapper_verify_hash(
3045 &attributes, slot->key.data, slot->key.bytes,
3046 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003048 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003049
Ryan Everett1b70a072024-01-04 10:32:49 +00003050 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003051
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003053
3054}
3055
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003056psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003057 const psa_key_attributes_t *attributes,
3058 const uint8_t *key_buffer,
3059 size_t key_buffer_size,
3060 psa_algorithm_t alg,
3061 const uint8_t *input,
3062 size_t input_length,
3063 uint8_t *signature,
3064 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003066{
3067 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003068
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003070 size_t hash_length;
3071 uint8_t hash[PSA_HASH_MAX_SIZE];
3072
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003073 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 PSA_ALG_SIGN_GET_HASH(alg),
3075 input, input_length,
3076 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003077
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003079 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003081
3082 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 attributes, key_buffer, key_buffer_size,
3084 alg, hash, hash_length,
3085 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003086 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003087
Gilles Peskine449bd832023-01-11 14:50:10 +01003088 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003089}
3090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3092 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003093 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003095 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 size_t signature_size,
3097 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003098{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003099 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3100 LOCAL_INPUT_DECLARE(input_external, input);
3101 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3102
3103 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3104 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3105 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3106 signature_size, signature_length);
3107
Thomas Daubney3e65f522024-01-30 12:37:25 +00003108#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003109exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003110#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003111 LOCAL_INPUT_FREE(input_external, input);
3112 LOCAL_OUTPUT_FREE(signature_external, signature);
3113 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003114}
3115
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003116psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003117 const psa_key_attributes_t *attributes,
3118 const uint8_t *key_buffer,
3119 size_t key_buffer_size,
3120 psa_algorithm_t alg,
3121 const uint8_t *input,
3122 size_t input_length,
3123 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003125{
3126 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003127
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003129 size_t hash_length;
3130 uint8_t hash[PSA_HASH_MAX_SIZE];
3131
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003132 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 PSA_ALG_SIGN_GET_HASH(alg),
3134 input, input_length,
3135 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003136
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003138 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003140
3141 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 attributes, key_buffer, key_buffer_size,
3143 alg, hash, hash_length,
3144 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003145 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003146
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003148}
3149
Gilles Peskine449bd832023-01-11 14:50:10 +01003150psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3151 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003152 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003154 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003155 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003156{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003157 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3158 LOCAL_INPUT_DECLARE(input_external, input);
3159 LOCAL_INPUT_DECLARE(signature_external, signature);
3160
3161 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3162 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3163 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3164 signature_length);
3165
Thomas Daubney3e65f522024-01-30 12:37:25 +00003166#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003167exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003168#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003169 LOCAL_INPUT_FREE(input_external, input);
3170 LOCAL_INPUT_FREE(signature_external, signature);
3171
3172 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003173}
3174
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003175psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003176 const psa_key_attributes_t *attributes,
3177 const uint8_t *key_buffer, size_t key_buffer_size,
3178 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003180{
Gilles Peskine449bd832023-01-11 14:50:10 +01003181 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3182 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3183 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003184#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003185 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3186 return mbedtls_psa_rsa_sign_hash(
3187 attributes,
3188 key_buffer, key_buffer_size,
3189 alg, hash, hash_length,
3190 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003191#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3192 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003193 } else {
3194 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003195 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003196 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3197 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003198#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3200 return mbedtls_psa_ecdsa_sign_hash(
3201 attributes,
3202 key_buffer, key_buffer_size,
3203 alg, hash, hash_length,
3204 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003205#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3206 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 } else {
3208 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003209 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003210 }
Ronald Cron4501c982021-03-19 20:09:32 +01003211
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 (void) key_buffer;
3213 (void) key_buffer_size;
3214 (void) hash;
3215 (void) hash_length;
3216 (void) signature;
3217 (void) signature_size;
3218 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003221}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003222
Gilles Peskine449bd832023-01-11 14:50:10 +01003223psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3224 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003225 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003226 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003227 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 size_t signature_size,
3229 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003230{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003231 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3232 LOCAL_INPUT_DECLARE(hash_external, hash);
3233 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3234
3235 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3236 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3237 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3238 signature_size, signature_length);
3239
Thomas Daubney3e65f522024-01-30 12:37:25 +00003240#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003241exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003242#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003243 LOCAL_INPUT_FREE(hash_external, hash);
3244 LOCAL_OUTPUT_FREE(signature_external, signature);
3245
3246 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003247}
3248
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003249psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003250 const psa_key_attributes_t *attributes,
3251 const uint8_t *key_buffer, size_t key_buffer_size,
3252 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003254{
Gilles Peskine449bd832023-01-11 14:50:10 +01003255 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3256 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3257 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003258#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003259 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3260 return mbedtls_psa_rsa_verify_hash(
3261 attributes,
3262 key_buffer, key_buffer_size,
3263 alg, hash, hash_length,
3264 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003265#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3266 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003267 } else {
3268 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003269 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3271 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003272#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003273 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3274 return mbedtls_psa_ecdsa_verify_hash(
3275 attributes,
3276 key_buffer, key_buffer_size,
3277 alg, hash, hash_length,
3278 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003279#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3280 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003281 } else {
3282 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003283 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003284 }
Ronald Cron4501c982021-03-19 20:09:32 +01003285
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 (void) key_buffer;
3287 (void) key_buffer_size;
3288 (void) hash;
3289 (void) hash_length;
3290 (void) signature;
3291 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003292
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003294}
3295
Gilles Peskine449bd832023-01-11 14:50:10 +01003296psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3297 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003298 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003300 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003302{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003303 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3304 LOCAL_INPUT_DECLARE(hash_external, hash);
3305 LOCAL_INPUT_DECLARE(signature_external, signature);
3306
3307 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3308 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3309 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3310 signature_length);
3311
Thomas Daubney3e65f522024-01-30 12:37:25 +00003312#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003313exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003314#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003315 LOCAL_INPUT_FREE(hash_external, hash);
3316 LOCAL_INPUT_FREE(signature_external, signature);
3317
3318 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003319}
3320
Gilles Peskine449bd832023-01-11 14:50:10 +01003321psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3322 psa_algorithm_t alg,
3323 const uint8_t *input,
3324 size_t input_length,
3325 const uint8_t *salt,
3326 size_t salt_length,
3327 uint8_t *output,
3328 size_t output_size,
3329 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003330{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003331 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003332 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003333 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003334 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003335
Darryl Green5cc689a2018-07-24 15:34:10 +01003336 (void) input;
3337 (void) input_length;
3338 (void) salt;
3339 (void) output;
3340 (void) output_size;
3341
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003342 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003343
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3345 return PSA_ERROR_INVALID_ARGUMENT;
3346 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003347
Valerio Setti5bb454a2024-01-15 10:43:16 +01003348 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3350 if (status != PSA_SUCCESS) {
3351 return status;
3352 }
3353 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3354 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003355 status = PSA_ERROR_INVALID_ARGUMENT;
3356 goto exit;
3357 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003358
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003359 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003361 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003362
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003363 status = psa_driver_wrapper_asymmetric_encrypt(
3364 &attributes, slot->key.data, slot->key.bytes,
3365 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003366 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003367exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003368 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003369
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003371}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003372
Gilles Peskine449bd832023-01-11 14:50:10 +01003373psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3374 psa_algorithm_t alg,
3375 const uint8_t *input,
3376 size_t input_length,
3377 const uint8_t *salt,
3378 size_t salt_length,
3379 uint8_t *output,
3380 size_t output_size,
3381 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003382{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003383 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003384 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003385 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003386 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003387
Darryl Green5cc689a2018-07-24 15:34:10 +01003388 (void) input;
3389 (void) input_length;
3390 (void) salt;
3391 (void) output;
3392 (void) output_size;
3393
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003394 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003395
Gilles Peskine449bd832023-01-11 14:50:10 +01003396 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3397 return PSA_ERROR_INVALID_ARGUMENT;
3398 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003399
Valerio Setti5bb454a2024-01-15 10:43:16 +01003400 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003401 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3402 if (status != PSA_SUCCESS) {
3403 return status;
3404 }
3405 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003406 status = PSA_ERROR_INVALID_ARGUMENT;
3407 goto exit;
3408 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003409
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003410 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003411 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003412 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003413
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003414 status = psa_driver_wrapper_asymmetric_decrypt(
3415 &attributes, slot->key.data, slot->key.bytes,
3416 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003417 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003418
3419exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003420 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003421
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003423}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003424
Paul Elliott9fe12f62022-11-30 19:16:02 +00003425/****************************************************************/
3426/* Asymmetric interruptible cryptography */
3427/****************************************************************/
3428
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003429static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3430
Paul Elliott9fe12f62022-11-30 19:16:02 +00003431void psa_interruptible_set_max_ops(uint32_t max_ops)
3432{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003433 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003434}
3435
3436uint32_t psa_interruptible_get_max_ops(void)
3437{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003438 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003439}
3440
Paul Elliott9fe12f62022-11-30 19:16:02 +00003441uint32_t psa_sign_hash_get_num_ops(
3442 const psa_sign_hash_interruptible_operation_t *operation)
3443{
Paul Elliott296ede92022-12-15 17:00:30 +00003444 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003445}
3446
3447uint32_t psa_verify_hash_get_num_ops(
3448 const psa_verify_hash_interruptible_operation_t *operation)
3449{
Paul Elliott296ede92022-12-15 17:00:30 +00003450 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003451}
3452
Paul Elliott59ad9452022-12-18 15:09:02 +00003453static psa_status_t psa_sign_hash_abort_internal(
3454 psa_sign_hash_interruptible_operation_t *operation)
3455{
3456 if (operation->id == 0) {
3457 /* The object has (apparently) been initialized but it is not (yet)
3458 * in use. It's ok to call abort on such an object, and there's
3459 * nothing to do. */
3460 return PSA_SUCCESS;
3461 }
3462
3463 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3464
3465 status = psa_driver_wrapper_sign_hash_abort(operation);
3466
3467 operation->id = 0;
3468
Paul Elliotte6145dc2023-02-07 12:51:21 +00003469 /* Do not clear either the error_occurred or num_ops elements here as they
3470 * only want to be cleared by the application calling abort, not by abort
3471 * being called at completion of an operation. */
3472
Paul Elliott59ad9452022-12-18 15:09:02 +00003473 return status;
3474}
3475
Paul Elliott9fe12f62022-11-30 19:16:02 +00003476psa_status_t psa_sign_hash_start(
3477 psa_sign_hash_interruptible_operation_t *operation,
3478 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3479 const uint8_t *hash, size_t hash_length)
3480{
3481 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3482 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3483 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003484 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003485
Paul Elliottc9774412023-02-06 15:14:07 +00003486 /* Check that start has not been previously called, or operation has not
3487 * previously errored. */
3488 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003489 return PSA_ERROR_BAD_STATE;
3490 }
3491
Paul Elliott9fe12f62022-11-30 19:16:02 +00003492 status = psa_sign_verify_check_alg(0, alg);
3493 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003494 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003495 return status;
3496 }
3497
3498 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3499 PSA_KEY_USAGE_SIGN_HASH,
3500 alg);
3501
3502 if (status != PSA_SUCCESS) {
3503 goto exit;
3504 }
3505
3506 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3507 status = PSA_ERROR_INVALID_ARGUMENT;
3508 goto exit;
3509 }
3510
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003511 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003512 .core = slot->attr
3513 };
3514
Paul Elliott296ede92022-12-15 17:00:30 +00003515 /* Ensure ops count gets reset, in case of operation re-use. */
3516 operation->num_ops = 0;
3517
Paul Elliott9fe12f62022-11-30 19:16:02 +00003518 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3519 slot->key.data,
3520 slot->key.bytes, alg,
3521 hash, hash_length);
3522exit:
3523
3524 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003525 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003526 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003527 }
3528
Ryan Everett1b70a072024-01-04 10:32:49 +00003529 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003530
Paul Elliottc9774412023-02-06 15:14:07 +00003531 if (unlock_status != PSA_SUCCESS) {
3532 operation->error_occurred = 1;
3533 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003534
Paul Elliottc9774412023-02-06 15:14:07 +00003535 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003536}
3537
3538
3539psa_status_t psa_sign_hash_complete(
3540 psa_sign_hash_interruptible_operation_t *operation,
3541 uint8_t *signature, size_t signature_size,
3542 size_t *signature_length)
3543{
3544 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3545
3546 *signature_length = 0;
3547
Paul Elliottc9774412023-02-06 15:14:07 +00003548 /* Check that start has been called first, and that operation has not
3549 * previously errored. */
3550 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003551 status = PSA_ERROR_BAD_STATE;
3552 goto exit;
3553 }
3554
Paul Elliott096abc42023-02-03 18:33:23 +00003555 /* Immediately reject a zero-length signature buffer. This guarantees that
3556 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003557 if (signature_size == 0) {
3558 status = PSA_ERROR_BUFFER_TOO_SMALL;
3559 goto exit;
3560 }
3561
3562 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3563 signature_size,
3564 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003565
Paul Elliott296ede92022-12-15 17:00:30 +00003566 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003567 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003568
Paul Elliottebe225c2023-02-10 14:32:53 +00003569exit:
3570
Paul Elliott59200a22023-02-21 15:07:40 +00003571 psa_wipe_tag_output_buffer(signature, status, signature_size,
3572 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003573
Paul Elliott53bb3122023-02-10 14:22:22 +00003574 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003575 if (status != PSA_SUCCESS) {
3576 operation->error_occurred = 1;
3577 }
3578
Paul Elliott59ad9452022-12-18 15:09:02 +00003579 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003580 }
3581
3582 return status;
3583}
3584
3585psa_status_t psa_sign_hash_abort(
3586 psa_sign_hash_interruptible_operation_t *operation)
3587{
Paul Elliott59ad9452022-12-18 15:09:02 +00003588 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3589
3590 status = psa_sign_hash_abort_internal(operation);
3591
3592 /* We clear the number of ops done here, so that it is not cleared when
3593 * the operation fails or succeeds, only on manual abort. */
3594 operation->num_ops = 0;
3595
Paul Elliottc9774412023-02-06 15:14:07 +00003596 /* Likewise, failure state. */
3597 operation->error_occurred = 0;
3598
Paul Elliott59ad9452022-12-18 15:09:02 +00003599 return status;
3600}
3601
3602static psa_status_t psa_verify_hash_abort_internal(
3603 psa_verify_hash_interruptible_operation_t *operation)
3604{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003605 if (operation->id == 0) {
3606 /* The object has (apparently) been initialized but it is not (yet)
3607 * in use. It's ok to call abort on such an object, and there's
3608 * nothing to do. */
3609 return PSA_SUCCESS;
3610 }
3611
Paul Elliott59ad9452022-12-18 15:09:02 +00003612 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3613
3614 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003615
3616 operation->id = 0;
3617
Paul Elliotte6145dc2023-02-07 12:51:21 +00003618 /* Do not clear either the error_occurred or num_ops elements here as they
3619 * only want to be cleared by the application calling abort, not by abort
3620 * being called at completion of an operation. */
3621
Paul Elliott59ad9452022-12-18 15:09:02 +00003622 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003623}
3624
3625psa_status_t psa_verify_hash_start(
3626 psa_verify_hash_interruptible_operation_t *operation,
3627 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3628 const uint8_t *hash, size_t hash_length,
3629 const uint8_t *signature, size_t signature_length)
3630{
3631 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3632 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3633 psa_key_slot_t *slot;
3634
Paul Elliottc9774412023-02-06 15:14:07 +00003635 /* Check that start has not been previously called, or operation has not
3636 * previously errored. */
3637 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003638 return PSA_ERROR_BAD_STATE;
3639 }
3640
3641 status = psa_sign_verify_check_alg(0, alg);
3642 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003643 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003644 return status;
3645 }
3646
3647 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3648 PSA_KEY_USAGE_VERIFY_HASH,
3649 alg);
3650
3651 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003652 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003653 return status;
3654 }
3655
3656 psa_key_attributes_t attributes = {
3657 .core = slot->attr
3658 };
3659
Paul Elliott296ede92022-12-15 17:00:30 +00003660 /* Ensure ops count gets reset, in case of operation re-use. */
3661 operation->num_ops = 0;
3662
Paul Elliott9fe12f62022-11-30 19:16:02 +00003663 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3664 slot->key.data,
3665 slot->key.bytes,
3666 alg, hash, hash_length,
3667 signature, signature_length);
3668
3669 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003670 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003671 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003672 }
3673
Ryan Everett1b70a072024-01-04 10:32:49 +00003674 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003675
Paul Elliottc9774412023-02-06 15:14:07 +00003676 if (unlock_status != PSA_SUCCESS) {
3677 operation->error_occurred = 1;
3678 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003679
Paul Elliottc9774412023-02-06 15:14:07 +00003680 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003681}
3682
3683psa_status_t psa_verify_hash_complete(
3684 psa_verify_hash_interruptible_operation_t *operation)
3685{
3686 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3687
Paul Elliottc9774412023-02-06 15:14:07 +00003688 /* Check that start has been called first, and that operation has not
3689 * previously errored. */
3690 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003691 status = PSA_ERROR_BAD_STATE;
3692 goto exit;
3693 }
3694
3695 status = psa_driver_wrapper_verify_hash_complete(operation);
3696
Paul Elliott296ede92022-12-15 17:00:30 +00003697 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003698 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003699 operation);
3700
Paul Elliottebe225c2023-02-10 14:32:53 +00003701exit:
3702
Paul Elliott9fe12f62022-11-30 19:16:02 +00003703 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003704 if (status != PSA_SUCCESS) {
3705 operation->error_occurred = 1;
3706 }
3707
Paul Elliott59ad9452022-12-18 15:09:02 +00003708 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003709 }
3710
3711 return status;
3712}
3713
3714psa_status_t psa_verify_hash_abort(
3715 psa_verify_hash_interruptible_operation_t *operation)
3716{
Paul Elliott59ad9452022-12-18 15:09:02 +00003717 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003718
Paul Elliott59ad9452022-12-18 15:09:02 +00003719 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003720
Paul Elliott59ad9452022-12-18 15:09:02 +00003721 /* We clear the number of ops done here, so that it is not cleared when
3722 * the operation fails or succeeds, only on manual abort. */
3723 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003724
Paul Elliottc9774412023-02-06 15:14:07 +00003725 /* Likewise, failure state. */
3726 operation->error_occurred = 0;
3727
Paul Elliott59ad9452022-12-18 15:09:02 +00003728 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003729}
3730
Paul Elliott588f8ed2022-12-02 18:10:26 +00003731/****************************************************************/
3732/* Asymmetric interruptible cryptography internal */
3733/* implementations */
3734/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003735
Paul Elliott588f8ed2022-12-02 18:10:26 +00003736void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3737{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003738
Paul Elliott588f8ed2022-12-02 18:10:26 +00003739#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3740 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3741 defined(MBEDTLS_ECP_RESTARTABLE)
3742
3743 /* Internal implementation uses zero to indicate infinite number max ops,
3744 * therefore avoid this value, and set to minimum possible. */
3745 if (max_ops == 0) {
3746 max_ops = 1;
3747 }
3748
Paul Elliott588f8ed2022-12-02 18:10:26 +00003749 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003750#else
3751 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003752#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3753 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3754 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3755}
3756
Paul Elliott588f8ed2022-12-02 18:10:26 +00003757uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003758 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003759{
3760#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3761 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3762 defined(MBEDTLS_ECP_RESTARTABLE)
3763
Paul Elliott93d9ca82023-02-15 18:14:21 +00003764 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003765#else
3766 (void) operation;
3767 return 0;
3768#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3769 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3770 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3771}
3772
3773uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003774 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003775{
3776 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3777 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3778 defined(MBEDTLS_ECP_RESTARTABLE)
3779
Paul Elliott93d9ca82023-02-15 18:14:21 +00003780 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003781#else
3782 (void) operation;
3783 return 0;
3784#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3785 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3786 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3787}
3788
3789psa_status_t mbedtls_psa_sign_hash_start(
3790 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3791 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3792 size_t key_buffer_size, psa_algorithm_t alg,
3793 const uint8_t *hash, size_t hash_length)
3794{
3795 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003796 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003797
Paul Elliott068fe072023-01-16 13:59:15 +00003798 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3799 return PSA_ERROR_NOT_SUPPORTED;
3800 }
3801
3802 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003803 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003804 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003805
3806#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003807 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3808 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003809
Paul Elliotta1c94092023-02-15 16:38:04 +00003810 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3811
Paul Elliott93d9ca82023-02-15 18:14:21 +00003812 /* Ensure num_ops is zero'ed in case of context re-use. */
3813 operation->num_ops = 0;
3814
Paul Elliott068fe072023-01-16 13:59:15 +00003815 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3816 attributes->core.bits,
3817 key_buffer,
3818 key_buffer_size,
3819 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003820
Paul Elliott068fe072023-01-16 13:59:15 +00003821 if (status != PSA_SUCCESS) {
3822 return status;
3823 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003824
Paul Elliott1bc59df2023-02-05 13:41:57 +00003825 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003826 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003827
Paul Elliott068fe072023-01-16 13:59:15 +00003828 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003829 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003830 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003831
Paul Elliott0290a762023-02-09 14:30:24 +00003832 /* We only need to store the same length of hash as the private key size
3833 * here, it would be truncated by the internal implementation anyway. */
3834 required_hash_length = (hash_length < operation->coordinate_bytes ?
3835 hash_length : operation->coordinate_bytes);
3836
Paul Elliottba70ad42023-02-15 18:23:53 +00003837 if (required_hash_length > sizeof(operation->hash)) {
3838 /* Shouldn't happen, but better safe than sorry. */
3839 return PSA_ERROR_CORRUPTION_DETECTED;
3840 }
3841
Paul Elliott0290a762023-02-09 14:30:24 +00003842 memcpy(operation->hash, hash, required_hash_length);
3843 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003844
3845 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003846
3847#else
Paul Elliott068fe072023-01-16 13:59:15 +00003848 (void) operation;
3849 (void) key_buffer;
3850 (void) key_buffer_size;
3851 (void) alg;
3852 (void) hash;
3853 (void) hash_length;
3854 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003855 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003856
Paul Elliott068fe072023-01-16 13:59:15 +00003857 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003858#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3859 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3860 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003861}
3862
3863psa_status_t mbedtls_psa_sign_hash_complete(
3864 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3865 uint8_t *signature, size_t signature_size,
3866 size_t *signature_length)
3867{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003868#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3869 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3870 defined(MBEDTLS_ECP_RESTARTABLE)
3871
Paul Elliotta1c94092023-02-15 16:38:04 +00003872 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003873 mbedtls_mpi r;
3874 mbedtls_mpi s;
3875
Paul Elliott46845252023-02-03 14:59:11 +00003876 mbedtls_mpi_init(&r);
3877 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003878
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003879 /* Ensure max_ops is set to the current value (or default). */
3880 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3881
Paul Elliotta1c94092023-02-15 16:38:04 +00003882 if (signature_size < 2 * operation->coordinate_bytes) {
3883 status = PSA_ERROR_BUFFER_TOO_SMALL;
3884 goto exit;
3885 }
3886
Paul Elliott588f8ed2022-12-02 18:10:26 +00003887 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003888
Paul Elliott588f8ed2022-12-02 18:10:26 +00003889#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3890 status = mbedtls_to_psa_error(
3891 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003892 &r,
3893 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003894 &operation->ctx->d,
3895 operation->hash,
3896 operation->hash_length,
3897 operation->md_alg,
3898 mbedtls_psa_get_random,
3899 MBEDTLS_PSA_RANDOM_STATE,
3900 &operation->restart_ctx));
3901#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003902 status = PSA_ERROR_NOT_SUPPORTED;
3903 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003904#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3905 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003906 status = mbedtls_to_psa_error(
3907 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003908 &r,
3909 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003910 &operation->ctx->d,
3911 operation->hash,
3912 operation->hash_length,
3913 mbedtls_psa_get_random,
3914 MBEDTLS_PSA_RANDOM_STATE,
3915 mbedtls_psa_get_random,
3916 MBEDTLS_PSA_RANDOM_STATE,
3917 &operation->restart_ctx));
3918 }
3919
Paul Elliottf8e5b562023-02-19 18:43:45 +00003920 /* Hide the fact that the restart context only holds a delta of number of
3921 * ops done during the last operation, not an absolute value. */
3922 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3923
Paul Elliott724bd252023-02-08 12:35:08 +00003924 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003925 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003926 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003927 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003928 operation->coordinate_bytes)
3929 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003930
3931 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003932 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003933 }
3934
3935 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003936 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003937 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003938 operation->coordinate_bytes,
3939 operation->coordinate_bytes)
3940 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003941
3942 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003943 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003944 }
3945
Paul Elliott1bc59df2023-02-05 13:41:57 +00003946 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003947
Paul Elliott724bd252023-02-08 12:35:08 +00003948 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003949 }
Paul Elliott724bd252023-02-08 12:35:08 +00003950
3951exit:
3952
3953 mbedtls_mpi_free(&r);
3954 mbedtls_mpi_free(&s);
3955 return status;
3956
Paul Elliott588f8ed2022-12-02 18:10:26 +00003957 #else
3958
3959 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003960 (void) signature;
3961 (void) signature_size;
3962 (void) signature_length;
3963
3964 return PSA_ERROR_NOT_SUPPORTED;
3965
3966#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3967 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3968 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3969}
3970
3971psa_status_t mbedtls_psa_sign_hash_abort(
3972 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3973{
3974
3975#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3976 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3977 defined(MBEDTLS_ECP_RESTARTABLE)
3978
3979 if (operation->ctx) {
3980 mbedtls_ecdsa_free(operation->ctx);
3981 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003982 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003983 }
3984
3985 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3986
Paul Elliott93d9ca82023-02-15 18:14:21 +00003987 operation->num_ops = 0;
3988
Paul Elliott588f8ed2022-12-02 18:10:26 +00003989 return PSA_SUCCESS;
3990
3991#else
3992
3993 (void) operation;
3994
3995 return PSA_ERROR_NOT_SUPPORTED;
3996
3997#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3998 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3999 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4000}
4001
4002psa_status_t mbedtls_psa_verify_hash_start(
4003 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4004 const psa_key_attributes_t *attributes,
4005 const uint8_t *key_buffer, size_t key_buffer_size,
4006 psa_algorithm_t alg,
4007 const uint8_t *hash, size_t hash_length,
4008 const uint8_t *signature, size_t signature_length)
4009{
4010 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004011 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004012 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004013
Paul Elliott068fe072023-01-16 13:59:15 +00004014 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4015 return PSA_ERROR_NOT_SUPPORTED;
4016 }
4017
4018 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004019 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004020 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004021
4022#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004023 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4024 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004025
Paul Elliotta1c94092023-02-15 16:38:04 +00004026 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4027 mbedtls_mpi_init(&operation->r);
4028 mbedtls_mpi_init(&operation->s);
4029
Paul Elliott93d9ca82023-02-15 18:14:21 +00004030 /* Ensure num_ops is zero'ed in case of context re-use. */
4031 operation->num_ops = 0;
4032
Paul Elliott068fe072023-01-16 13:59:15 +00004033 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4034 attributes->core.bits,
4035 key_buffer,
4036 key_buffer_size,
4037 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004038
Paul Elliott068fe072023-01-16 13:59:15 +00004039 if (status != PSA_SUCCESS) {
4040 return status;
4041 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004042
Paul Elliottc569fc22023-02-10 13:02:54 +00004043 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004044
Paul Elliott1bc59df2023-02-05 13:41:57 +00004045 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004046 return PSA_ERROR_INVALID_SIGNATURE;
4047 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004048
Paul Elliott068fe072023-01-16 13:59:15 +00004049 status = mbedtls_to_psa_error(
4050 mbedtls_mpi_read_binary(&operation->r,
4051 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004052 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004053
Paul Elliott068fe072023-01-16 13:59:15 +00004054 if (status != PSA_SUCCESS) {
4055 return status;
4056 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004057
Paul Elliott068fe072023-01-16 13:59:15 +00004058 status = mbedtls_to_psa_error(
4059 mbedtls_mpi_read_binary(&operation->s,
4060 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004061 coordinate_bytes,
4062 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004063
Paul Elliott068fe072023-01-16 13:59:15 +00004064 if (status != PSA_SUCCESS) {
4065 return status;
4066 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004067
Paul Elliott2c9843f2023-02-15 17:32:42 +00004068 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004069
Paul Elliott2c9843f2023-02-15 17:32:42 +00004070 if (status != PSA_SUCCESS) {
4071 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004072 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004073
Paul Elliott0290a762023-02-09 14:30:24 +00004074 /* We only need to store the same length of hash as the private key size
4075 * here, it would be truncated by the internal implementation anyway. */
4076 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4077 coordinate_bytes);
4078
Paul Elliottba70ad42023-02-15 18:23:53 +00004079 if (required_hash_length > sizeof(operation->hash)) {
4080 /* Shouldn't happen, but better safe than sorry. */
4081 return PSA_ERROR_CORRUPTION_DETECTED;
4082 }
4083
Paul Elliott0290a762023-02-09 14:30:24 +00004084 memcpy(operation->hash, hash, required_hash_length);
4085 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004086
4087 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004088#else
Paul Elliott068fe072023-01-16 13:59:15 +00004089 (void) operation;
4090 (void) key_buffer;
4091 (void) key_buffer_size;
4092 (void) alg;
4093 (void) hash;
4094 (void) hash_length;
4095 (void) signature;
4096 (void) signature_length;
4097 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004098 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004099 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004100
Paul Elliott068fe072023-01-16 13:59:15 +00004101 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004102#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4103 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4104 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004105}
4106
4107psa_status_t mbedtls_psa_verify_hash_complete(
4108 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4109{
4110
4111#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4112 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4113 defined(MBEDTLS_ECP_RESTARTABLE)
4114
Paul Elliottf8e5b562023-02-19 18:43:45 +00004115 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4116
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004117 /* Ensure max_ops is set to the current value (or default). */
4118 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4119
Paul Elliottf8e5b562023-02-19 18:43:45 +00004120 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004121 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4122 operation->hash,
4123 operation->hash_length,
4124 &operation->ctx->Q,
4125 &operation->r,
4126 &operation->s,
4127 &operation->restart_ctx));
4128
Paul Elliottf8e5b562023-02-19 18:43:45 +00004129 /* Hide the fact that the restart context only holds a delta of number of
4130 * ops done during the last operation, not an absolute value. */
4131 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4132
4133 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004134#else
4135 (void) operation;
4136
4137 return PSA_ERROR_NOT_SUPPORTED;
4138
4139#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4140 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4141 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4142}
4143
4144psa_status_t mbedtls_psa_verify_hash_abort(
4145 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4146{
4147
4148#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4149 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4150 defined(MBEDTLS_ECP_RESTARTABLE)
4151
4152 if (operation->ctx) {
4153 mbedtls_ecdsa_free(operation->ctx);
4154 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004155 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004156 }
4157
4158 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4159
Paul Elliott93d9ca82023-02-15 18:14:21 +00004160 operation->num_ops = 0;
4161
Paul Elliott588f8ed2022-12-02 18:10:26 +00004162 mbedtls_mpi_free(&operation->r);
4163 mbedtls_mpi_free(&operation->s);
4164
4165 return PSA_SUCCESS;
4166
4167#else
4168 (void) operation;
4169
4170 return PSA_ERROR_NOT_SUPPORTED;
4171
4172#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4173 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4174 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4175}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004176
mohammad1603503973b2018-03-12 15:59:30 +02004177/****************************************************************/
4178/* Symmetric cryptography */
4179/****************************************************************/
4180
Gilles Peskine449bd832023-01-11 14:50:10 +01004181static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4182 mbedtls_svc_key_id_t key,
4183 psa_algorithm_t alg,
4184 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004185{
4186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4187 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004188 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4190 PSA_KEY_USAGE_ENCRYPT :
4191 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004192 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004193
4194 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004196 status = PSA_ERROR_BAD_STATE;
4197 goto exit;
4198 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004199
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004201 status = PSA_ERROR_INVALID_ARGUMENT;
4202 goto exit;
4203 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004204
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4206 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004207 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004209
Ronald Cron49fafa92021-03-10 08:34:23 +01004210 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004211 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004212 * so we only set it (in the driver wrapper) after resources have been
4213 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004214 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004216 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004218 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 }
4220 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004221
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004222 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004224 };
4225
Ronald Cronab99ac22020-10-01 16:38:28 +02004226 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 if (cipher_operation == MBEDTLS_ENCRYPT) {
4228 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4229 &attributes,
4230 slot->key.data,
4231 slot->key.bytes,
4232 alg);
4233 } else {
4234 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4235 &attributes,
4236 slot->key.data,
4237 slot->key.bytes,
4238 alg);
4239 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004240
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004241exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 if (status != PSA_SUCCESS) {
4243 psa_cipher_abort(operation);
4244 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004245
Ryan Everett1b70a072024-01-04 10:32:49 +00004246 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004247
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004249}
4250
Gilles Peskine449bd832023-01-11 14:50:10 +01004251psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4252 mbedtls_svc_key_id_t key,
4253 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004254{
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004256}
4257
Gilles Peskine449bd832023-01-11 14:50:10 +01004258psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4259 mbedtls_svc_key_id_t key,
4260 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004261{
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004263}
4264
Gilles Peskine449bd832023-01-11 14:50:10 +01004265psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4266 uint8_t *iv,
4267 size_t iv_size,
4268 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004269{
Ronald Cron6d051732020-10-01 14:10:20 +02004270 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004271 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004272 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004273
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004275 status = PSA_ERROR_BAD_STATE;
4276 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004277 }
4278
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004280 status = PSA_ERROR_BAD_STATE;
4281 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004282 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004283
Ronald Cron2fb90522021-07-05 12:31:44 +02004284 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004285 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004286 status = PSA_ERROR_BUFFER_TOO_SMALL;
4287 goto exit;
4288 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004289
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004291 status = PSA_ERROR_GENERIC_ERROR;
4292 goto exit;
4293 }
4294
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 status = psa_generate_random(local_iv, default_iv_length);
4296 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004297 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 }
Ronald Cron5618a392021-03-26 09:52:26 +01004299
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 status = psa_driver_wrapper_cipher_set_iv(operation,
4301 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004302
4303exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 if (status == PSA_SUCCESS) {
4305 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004306 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004307 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004309 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004311 }
Ronald Cron6d051732020-10-01 14:10:20 +02004312
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004314}
4315
Gilles Peskine449bd832023-01-11 14:50:10 +01004316psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4317 const uint8_t *iv,
4318 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004319{
Ronald Cron6d051732020-10-01 14:10:20 +02004320 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004321
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004323 status = PSA_ERROR_BAD_STATE;
4324 goto exit;
4325 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004326
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004328 status = PSA_ERROR_BAD_STATE;
4329 goto exit;
4330 }
Ronald Crona0d68172021-03-26 10:15:08 +01004331
Gilles Peskine449bd832023-01-11 14:50:10 +01004332 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004333 status = PSA_ERROR_INVALID_ARGUMENT;
4334 goto exit;
4335 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004336
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 status = psa_driver_wrapper_cipher_set_iv(operation,
4338 iv,
4339 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004340
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004341exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004343 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 } else {
4345 psa_cipher_abort(operation);
4346 }
4347 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004348}
4349
Gilles Peskine449bd832023-01-11 14:50:10 +01004350psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4351 const uint8_t *input,
4352 size_t input_length,
4353 uint8_t *output,
4354 size_t output_size,
4355 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004356{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004358
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004360 status = PSA_ERROR_BAD_STATE;
4361 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004362 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004363
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004365 status = PSA_ERROR_BAD_STATE;
4366 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004367 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004368
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 status = psa_driver_wrapper_cipher_update(operation,
4370 input,
4371 input_length,
4372 output,
4373 output_size,
4374 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004375
4376exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 if (status != PSA_SUCCESS) {
4378 psa_cipher_abort(operation);
4379 }
Ronald Cron6d051732020-10-01 14:10:20 +02004380
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004382}
4383
Gilles Peskine449bd832023-01-11 14:50:10 +01004384psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4385 uint8_t *output,
4386 size_t output_size,
4387 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004388{
David Saadab4ecc272019-02-14 13:48:10 +02004389 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004390
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004392 status = PSA_ERROR_BAD_STATE;
4393 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004394 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004395
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004397 status = PSA_ERROR_BAD_STATE;
4398 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004399 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004400
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 status = psa_driver_wrapper_cipher_finish(operation,
4402 output,
4403 output_size,
4404 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004405
4406exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (status == PSA_SUCCESS) {
4408 return psa_cipher_abort(operation);
4409 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004410 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004414 }
mohammad1603503973b2018-03-12 15:59:30 +02004415}
4416
Gilles Peskine449bd832023-01-11 14:50:10 +01004417psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004418{
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004420 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004421 * in use. It's ok to call abort on such an object, and there's
4422 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004424 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004425
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004427
Ronald Cron49fafa92021-03-10 08:34:23 +01004428 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004429 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004430 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004431
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004433}
4434
Gilles Peskine449bd832023-01-11 14:50:10 +01004435psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4436 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004437 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004439 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 size_t output_size,
4441 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004442{
4443 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004444 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004445 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004446 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4447 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004448 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004449
David Horstmann62a56d92023-12-14 18:12:47 +00004450 LOCAL_INPUT_DECLARE(input_external, input);
4451 LOCAL_OUTPUT_DECLARE(output_external, output);
4452
David Horstmann36df4b22023-12-13 15:55:25 +00004453 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004454 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004455
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004457 status = PSA_ERROR_INVALID_ARGUMENT;
4458 goto exit;
4459 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004460
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4462 PSA_KEY_USAGE_ENCRYPT,
4463 alg);
4464 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004465 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004467
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004468 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004470 };
4471
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4473 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004474 status = PSA_ERROR_GENERIC_ERROR;
4475 goto exit;
4476 }
4477
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 if (default_iv_length > 0) {
4479 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004480 status = PSA_ERROR_BUFFER_TOO_SMALL;
4481 goto exit;
4482 }
4483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 status = psa_generate_random(local_iv, default_iv_length);
4485 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004486 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004488 }
4489
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004490 status = psa_driver_wrapper_cipher_encrypt(
4491 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004492 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004493 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004495
4496exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004497 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004499 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004500 }
Ronald Cron23919522021-07-08 19:00:07 +02004501
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 if (status == PSA_SUCCESS) {
4503 if (default_iv_length > 0) {
4504 memcpy(output, local_iv, default_iv_length);
4505 }
4506 *output_length += default_iv_length;
4507 } else {
4508 *output_length = 0;
4509 }
4510
David Horstmann62a56d92023-12-14 18:12:47 +00004511 LOCAL_INPUT_FREE(input_external, input);
4512 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004513
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004515}
4516
Gilles Peskine449bd832023-01-11 14:50:10 +01004517psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4518 psa_algorithm_t alg,
4519 const uint8_t *input,
4520 size_t input_length,
4521 uint8_t *output,
4522 size_t output_size,
4523 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004524{
4525 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004526 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004527 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004528 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004529
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004531 status = PSA_ERROR_INVALID_ARGUMENT;
4532 goto exit;
4533 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004534
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4536 PSA_KEY_USAGE_DECRYPT,
4537 alg);
4538 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004539 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004541
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004542 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004544 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004545
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4547 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004548 status = PSA_ERROR_INVALID_ARGUMENT;
4549 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004551 status = PSA_ERROR_INVALID_ARGUMENT;
4552 goto exit;
4553 }
4554
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004555 status = psa_driver_wrapper_cipher_decrypt(
4556 &attributes, slot->key.data, slot->key.bytes,
4557 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004559
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004560exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004561 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004563 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004565
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004567 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 }
Ronald Cron23919522021-07-08 19:00:07 +02004569
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004571}
4572
4573
mohammad16035955c982018-04-26 00:53:03 +03004574/****************************************************************/
4575/* AEAD */
4576/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004577
Paul Elliottbaff51c2021-09-28 17:44:45 +01004578/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004579static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004580{
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004582}
4583
4584/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004585static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4586 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004587{
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004589
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004591#if defined(PSA_WANT_ALG_GCM)
4592 case PSA_ALG_GCM:
4593 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 * arbitrarily large nonces. Please note that we do not generally
4595 * recommend the usage of nonces of greater length than
4596 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4597 * size, which can then lead to collisions if you encrypt a very
4598 * large number of messages.*/
4599 if (nonce_length != 0) {
4600 return PSA_SUCCESS;
4601 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004602 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004603#endif /* PSA_WANT_ALG_GCM */
4604#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004605 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 if (nonce_length >= 7 && nonce_length <= 13) {
4607 return PSA_SUCCESS;
4608 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004609 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004610#endif /* PSA_WANT_ALG_CCM */
4611#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004612 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 if (nonce_length == 12) {
4614 return PSA_SUCCESS;
4615 } else if (nonce_length == 8) {
4616 return PSA_ERROR_NOT_SUPPORTED;
4617 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004618 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004619#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004620 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004621 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004623 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004624
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004626}
4627
Gilles Peskine449bd832023-01-11 14:50:10 +01004628static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004629{
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4631 return PSA_ERROR_INVALID_ARGUMENT;
4632 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004633
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004635}
4636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4638 psa_algorithm_t alg,
4639 const uint8_t *nonce,
4640 size_t nonce_length,
4641 const uint8_t *additional_data,
4642 size_t additional_data_length,
4643 const uint8_t *plaintext,
4644 size_t plaintext_length,
4645 uint8_t *ciphertext,
4646 size_t ciphertext_size,
4647 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004648{
Ronald Cron215633c2021-03-16 17:15:37 +01004649 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4650 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004651
mohammad1603f08a5502018-06-03 15:05:47 +03004652 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004653
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 status = psa_aead_check_algorithm(alg);
4655 if (status != PSA_SUCCESS) {
4656 return status;
4657 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004658
Ronald Cron9a986162021-03-26 12:40:07 +01004659 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4661 if (status != PSA_SUCCESS) {
4662 return status;
4663 }
mohammad16035955c982018-04-26 00:53:03 +03004664
Ronald Cron215633c2021-03-16 17:15:37 +01004665 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004667 };
mohammad16035955c982018-04-26 00:53:03 +03004668
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 status = psa_aead_check_nonce_length(alg, nonce_length);
4670 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004671 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004673
Ronald Cronde822812021-03-17 16:08:20 +01004674 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004675 &attributes, slot->key.data, slot->key.bytes,
4676 alg,
4677 nonce, nonce_length,
4678 additional_data, additional_data_length,
4679 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004681
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4683 memset(ciphertext, 0, ciphertext_size);
4684 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004685
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004686exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004687 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004688
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004690}
4691
Gilles Peskine449bd832023-01-11 14:50:10 +01004692psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4693 psa_algorithm_t alg,
4694 const uint8_t *nonce,
4695 size_t nonce_length,
4696 const uint8_t *additional_data,
4697 size_t additional_data_length,
4698 const uint8_t *ciphertext,
4699 size_t ciphertext_length,
4700 uint8_t *plaintext,
4701 size_t plaintext_size,
4702 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004703{
Ronald Cron215633c2021-03-16 17:15:37 +01004704 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4705 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004706
Gilles Peskineee652a32018-06-01 19:23:52 +02004707 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004708
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 status = psa_aead_check_algorithm(alg);
4710 if (status != PSA_SUCCESS) {
4711 return status;
4712 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004713
Ronald Cron9a986162021-03-26 12:40:07 +01004714 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4716 if (status != PSA_SUCCESS) {
4717 return status;
4718 }
mohammad16035955c982018-04-26 00:53:03 +03004719
Ronald Cron215633c2021-03-16 17:15:37 +01004720 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004722 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004723
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 status = psa_aead_check_nonce_length(alg, nonce_length);
4725 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004726 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004728
Ronald Cronde822812021-03-17 16:08:20 +01004729 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004730 &attributes, slot->key.data, slot->key.bytes,
4731 alg,
4732 nonce, nonce_length,
4733 additional_data, additional_data_length,
4734 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004736
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 if (status != PSA_SUCCESS && plaintext_size != 0) {
4738 memset(plaintext, 0, plaintext_size);
4739 }
mohammad160360a64d02018-06-03 17:20:42 +03004740
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004741exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004742 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004743
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 return status;
mohammad16035955c982018-04-26 00:53:03 +03004745}
4746
Gilles Peskine449bd832023-01-11 14:50:10 +01004747static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4748{
4749 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004750
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004752#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004754 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4756 return PSA_ERROR_INVALID_ARGUMENT;
4757 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004758 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004759#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004760
Przemek Stekiel86679c72022-10-06 17:06:56 +02004761#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004763 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4765 return PSA_ERROR_INVALID_ARGUMENT;
4766 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004767 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004768#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004769
Przemek Stekiel86679c72022-10-06 17:06:56 +02004770#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004772 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 if (tag_len != 16) {
4774 return PSA_ERROR_INVALID_ARGUMENT;
4775 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004776 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004777#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004778
4779 default:
4780 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004782 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004784}
4785
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004786/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004787static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4788 int is_encrypt,
4789 mbedtls_svc_key_id_t key,
4790 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004791{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004792 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4793 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4794 psa_key_slot_t *slot = NULL;
4795 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004796 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004797
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 status = psa_aead_check_algorithm(alg);
4799 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004800 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004802
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004804 status = PSA_ERROR_BAD_STATE;
4805 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004806 }
4807
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 if (operation->nonce_set || operation->lengths_set ||
4809 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004810 status = PSA_ERROR_BAD_STATE;
4811 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004812 }
4813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004815 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004817 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004819
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4821 alg);
4822 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004823 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004825
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004826 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004827 .core = slot->attr
4828 };
4829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004831 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004833
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 if (is_encrypt) {
4835 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4836 &attributes,
4837 slot->key.data,
4838 slot->key.bytes,
4839 alg);
4840 } else {
4841 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4842 &attributes,
4843 slot->key.data,
4844 slot->key.bytes,
4845 alg);
4846 }
4847 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004848 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004850
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004852
4853exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004854 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004855
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004857 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004859 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 } else {
4861 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004862 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004863
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004865}
4866
Paul Elliott302ff6b2021-04-20 18:10:30 +01004867/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004868psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4869 mbedtls_svc_key_id_t key,
4870 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004871{
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004873}
4874
4875/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004876psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4877 mbedtls_svc_key_id_t key,
4878 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004879{
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004881}
4882
4883/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004884psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4885 uint8_t *nonce,
4886 size_t nonce_size,
4887 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004888{
4889 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004890 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004891 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004892
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004893 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004894
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004896 status = PSA_ERROR_BAD_STATE;
4897 goto exit;
4898 }
4899
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004901 status = PSA_ERROR_BAD_STATE;
4902 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004903 }
4904
Paul Elliotte193ea82021-10-01 13:00:16 +01004905 /* For CCM, this size may not be correct according to the PSA
4906 * specification. The PSA Crypto 1.0.1 specification states:
4907 *
4908 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4909 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4910 *
4911 * However this restriction that L has to be the smallest integer is not
4912 * applied in practice, and it is not implementable here since the
4913 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4915 operation->alg);
4916 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004917 status = PSA_ERROR_BUFFER_TOO_SMALL;
4918 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004919 }
4920
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 status = psa_generate_random(local_nonce, required_nonce_size);
4922 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004923 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004925
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004927
Paul Elliott39dc6b82021-05-11 19:16:09 +01004928exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 if (status == PSA_SUCCESS) {
4930 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004931 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 } else {
4933 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004934 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004935
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004937}
4938
4939/* Set the nonce for a multipart authenticated encryption or decryption
4940 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004941psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4942 const uint8_t *nonce,
4943 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004944{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004945 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4946
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004948 status = PSA_ERROR_BAD_STATE;
4949 goto exit;
4950 }
4951
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004953 status = PSA_ERROR_BAD_STATE;
4954 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004955 }
4956
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4958 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004959 status = PSA_ERROR_INVALID_ARGUMENT;
4960 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004961 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004962
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4964 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004965
Paul Elliott39dc6b82021-05-11 19:16:09 +01004966exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004968 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 } else {
4970 psa_aead_abort(operation);
4971 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004972
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004974}
4975
4976/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004977psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4978 size_t ad_length,
4979 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004980{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004981 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4982
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004984 status = PSA_ERROR_BAD_STATE;
4985 goto exit;
4986 }
4987
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 if (operation->lengths_set || operation->ad_started ||
4989 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004990 status = PSA_ERROR_BAD_STATE;
4991 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004992 }
4993
Gilles Peskine449bd832023-01-11 14:50:10 +01004994 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004995#if defined(PSA_WANT_ALG_GCM)
4996 case PSA_ALG_GCM:
4997 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 * bits. Without the guard this code will generate warnings on 32bit
4999 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005000#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 if (((uint64_t) ad_length) >> 61 != 0 ||
5002 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005003 status = PSA_ERROR_INVALID_ARGUMENT;
5004 goto exit;
5005 }
Paul Elliott325d3742021-09-27 17:56:28 +01005006#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005007 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005008#endif /* PSA_WANT_ALG_GCM */
5009#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005010 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005011 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005012 status = PSA_ERROR_INVALID_ARGUMENT;
5013 goto exit;
5014 }
5015 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005016#endif /* PSA_WANT_ALG_CCM */
5017#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005018 case PSA_ALG_CHACHA20_POLY1305:
5019 /* No length restrictions for ChaChaPoly. */
5020 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005021#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005022 default:
5023 break;
5024 }
Paul Elliott325d3742021-09-27 17:56:28 +01005025
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5027 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005028
Paul Elliott39dc6b82021-05-11 19:16:09 +01005029exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005031 operation->ad_remaining = ad_length;
5032 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005033 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 } else {
5035 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005036 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005037
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005039}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005040
5041/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005042psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5043 const uint8_t *input,
5044 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005045{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005046 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5047
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005049 status = PSA_ERROR_BAD_STATE;
5050 goto exit;
5051 }
5052
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005054 status = PSA_ERROR_BAD_STATE;
5055 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005056 }
5057
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 if (operation->lengths_set) {
5059 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005060 status = PSA_ERROR_INVALID_ARGUMENT;
5061 goto exit;
5062 }
5063
5064 operation->ad_remaining -= input_length;
5065 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005066#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005068 status = PSA_ERROR_BAD_STATE;
5069 goto exit;
5070 }
5071#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005072
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 status = psa_driver_wrapper_aead_update_ad(operation, input,
5074 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005075
Paul Elliott39dc6b82021-05-11 19:16:09 +01005076exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005078 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 } else {
5080 psa_aead_abort(operation);
5081 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005082
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005084}
5085
5086/* Encrypt or decrypt a message fragment in an active multipart AEAD
5087 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005088psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5089 const uint8_t *input,
5090 size_t input_length,
5091 uint8_t *output,
5092 size_t output_size,
5093 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005094{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005095 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005096
5097 *output_length = 0;
5098
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005100 status = PSA_ERROR_BAD_STATE;
5101 goto exit;
5102 }
5103
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005105 status = PSA_ERROR_BAD_STATE;
5106 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005107 }
5108
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005110 /* Additional data length was supplied, but not all the additional
5111 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005113 status = PSA_ERROR_INVALID_ARGUMENT;
5114 goto exit;
5115 }
5116
5117 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005119 status = PSA_ERROR_INVALID_ARGUMENT;
5120 goto exit;
5121 }
5122
5123 operation->body_remaining -= input_length;
5124 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005125#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005127 status = PSA_ERROR_BAD_STATE;
5128 goto exit;
5129 }
5130#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005131
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5133 output, output_size,
5134 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005135
Paul Elliott39dc6b82021-05-11 19:16:09 +01005136exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005138 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 } else {
5140 psa_aead_abort(operation);
5141 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005142
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005144}
5145
Gilles Peskine449bd832023-01-11 14:50:10 +01005146static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005147{
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 if (operation->id == 0 || !operation->nonce_set) {
5149 return PSA_ERROR_BAD_STATE;
5150 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005151
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5153 operation->body_remaining != 0)) {
5154 return PSA_ERROR_INVALID_ARGUMENT;
5155 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005156
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005158}
5159
Paul Elliott302ff6b2021-04-20 18:10:30 +01005160/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005161psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5162 uint8_t *ciphertext,
5163 size_t ciphertext_size,
5164 size_t *ciphertext_length,
5165 uint8_t *tag,
5166 size_t tag_size,
5167 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005168{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005169 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5170
Paul Elliott302ff6b2021-04-20 18:10:30 +01005171 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005172 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005173
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 status = psa_aead_final_checks(operation);
5175 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005176 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005178
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005180 status = PSA_ERROR_BAD_STATE;
5181 goto exit;
5182 }
5183
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5185 ciphertext_size,
5186 ciphertext_length,
5187 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005188
Paul Elliott39dc6b82021-05-11 19:16:09 +01005189exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005190
5191
Paul Elliottf47b0952021-05-21 18:02:33 +01005192 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005193 * the zero tag size, make sure the tag is set to something implausible.
5194 * Even if the operation succeeds, make sure we clear the rest of the
5195 * buffer to prevent potential leakage of anything previously placed in
5196 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005197 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005198
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005200
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005202}
5203
5204/* Finish authenticating and decrypting a message in a multipart AEAD
5205 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005206psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5207 uint8_t *plaintext,
5208 size_t plaintext_size,
5209 size_t *plaintext_length,
5210 const uint8_t *tag,
5211 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005212{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005213 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5214
Paul Elliott302ff6b2021-04-20 18:10:30 +01005215 *plaintext_length = 0;
5216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 status = psa_aead_final_checks(operation);
5218 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005219 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005221
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005223 status = PSA_ERROR_BAD_STATE;
5224 goto exit;
5225 }
5226
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5228 plaintext_size,
5229 plaintext_length,
5230 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005231
5232exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005234
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005236}
5237
5238/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005239psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005240{
5241 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5242
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005244 /* The object has (apparently) been initialized but it is not (yet)
5245 * in use. It's ok to call abort on such an object, and there's
5246 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005248 }
5249
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005251
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005253
Gilles Peskine449bd832023-01-11 14:50:10 +01005254 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005255}
5256
Gilles Peskinee59236f2018-01-27 23:32:46 +01005257/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005258/* Generators */
5259/****************************************************************/
5260
Przemek Stekiel69c46792022-06-10 12:59:51 +02005261#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005262 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005263 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305264 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305265 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005266#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005267#endif /* At least one builtin KDF */
5268
Przemek Stekiel69c46792022-06-10 12:59:51 +02005269#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005270 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5271 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5272static psa_status_t psa_key_derivation_start_hmac(
5273 psa_mac_operation_t *operation,
5274 psa_algorithm_t hash_alg,
5275 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005277{
5278 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5279 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5281 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5282 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005283
Steven Cooreman72f736a2021-05-07 14:14:37 +02005284 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005286
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 status = psa_driver_wrapper_mac_sign_setup(operation,
5288 &attributes,
5289 hmac_key, hmac_key_length,
5290 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005291
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 psa_reset_key_attributes(&attributes);
5293 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005294}
5295#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005296
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005297#define HKDF_STATE_INIT 0 /* no input yet */
5298#define HKDF_STATE_STARTED 1 /* got salt */
5299#define HKDF_STATE_KEYED 2 /* got key */
5300#define HKDF_STATE_OUTPUT 3 /* output started */
5301
Gilles Peskinecbe66502019-05-16 16:59:18 +02005302static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005304{
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5306 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5307 } else {
5308 return operation->alg;
5309 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005310}
5311
Gilles Peskine449bd832023-01-11 14:50:10 +01005312psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005313{
5314 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5316 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005317 /* The object has (apparently) been initialized but it is not
5318 * in use. It's ok to call abort on such an object, and there's
5319 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005320 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005321#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5323 mbedtls_free(operation->ctx.hkdf.info);
5324 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5325 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005326#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005327#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5328 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5330 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5331 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5332 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005333 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005335 }
5336
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005338 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005340 }
5341
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005343 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005345 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005346#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005347 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005348 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005350 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005351#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005352 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005353
5354 /* We leave the fields Ai and output_block to be erased safely by the
5355 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005357#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5358 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005359#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5361 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5362 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5363 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005364#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305365#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305366 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305367 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005368 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305369 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305370 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305371
5372 status = PSA_SUCCESS;
5373 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305374#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005375 {
5376 status = PSA_ERROR_BAD_STATE;
5377 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 mbedtls_platform_zeroize(operation, sizeof(*operation));
5379 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005380}
5381
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005382psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005384{
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005386 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005388 }
5389
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005390 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005392}
5393
Gilles Peskine449bd832023-01-11 14:50:10 +01005394psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5395 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005396{
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 if (operation->alg == 0) {
5398 return PSA_ERROR_BAD_STATE;
5399 }
5400 if (capacity > operation->capacity) {
5401 return PSA_ERROR_INVALID_ARGUMENT;
5402 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005403 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005405}
5406
Przemek Stekiel69c46792022-06-10 12:59:51 +02005407#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005408/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005409static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5410 psa_algorithm_t kdf_alg,
5411 uint8_t *output,
5412 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005413{
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5415 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005416 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005417 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005418#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005420#else
5421 const uint8_t last_block = 0xff;
5422#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005423
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 if (hkdf->state < HKDF_STATE_KEYED ||
5425 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005426#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005428#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 )) {
5430 return PSA_ERROR_BAD_STATE;
5431 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005432 hkdf->state = HKDF_STATE_OUTPUT;
5433
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005435 /* Copy what remains of the current block */
5436 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005438 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 }
5440 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005441 output += n;
5442 output_length -= n;
5443 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005445 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005447 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005448 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005449 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005450 * object was corrupted or if this function is called directly
5451 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 if (hkdf->block_number == last_block) {
5453 return PSA_ERROR_BAD_STATE;
5454 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005455
5456 /* We need a new block */
5457 ++hkdf->block_number;
5458 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005459
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5461 hash_alg,
5462 hkdf->prk,
5463 hash_length);
5464 if (status != PSA_SUCCESS) {
5465 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005466 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005467
5468 if (hkdf->block_number != 1) {
5469 status = psa_mac_update(&hkdf->hmac,
5470 hkdf->output_block,
5471 hash_length);
5472 if (status != PSA_SUCCESS) {
5473 return status;
5474 }
5475 }
5476 status = psa_mac_update(&hkdf->hmac,
5477 hkdf->info,
5478 hkdf->info_length);
5479 if (status != PSA_SUCCESS) {
5480 return status;
5481 }
5482 status = psa_mac_update(&hkdf->hmac,
5483 &hkdf->block_number, 1);
5484 if (status != PSA_SUCCESS) {
5485 return status;
5486 }
5487 status = psa_mac_sign_finish(&hkdf->hmac,
5488 hkdf->output_block,
5489 sizeof(hkdf->output_block),
5490 &hmac_output_length);
5491 if (status != PSA_SUCCESS) {
5492 return status;
5493 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005494 }
5495
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005497}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005498#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005499
John Durkop07cc04a2020-11-16 22:08:34 -08005500#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5501 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005502static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5503 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005505{
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5507 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005508 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5509 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005510 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005511
Janos Follath7742fee2019-06-17 12:58:10 +01005512 /* We can't be wanting more output after block 0xff, otherwise
5513 * the capacity check in psa_key_derivation_output_bytes() would have
5514 * prevented this call. It could happen only if the operation
5515 * object was corrupted or if this function is called directly
5516 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 if (tls12_prf->block_number == 0xff) {
5518 return PSA_ERROR_CORRUPTION_DETECTED;
5519 }
Janos Follath7742fee2019-06-17 12:58:10 +01005520
5521 /* We need a new block */
5522 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005523 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005524
5525 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5526 *
5527 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5528 *
5529 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5530 * HMAC_hash(secret, A(2) + seed) +
5531 * HMAC_hash(secret, A(3) + seed) + ...
5532 *
5533 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005534 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005535 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005536 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005537 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005538 * is currently extracted as `output_block` and where i is
5539 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005540 */
5541
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 status = psa_key_derivation_start_hmac(&hmac,
5543 hash_alg,
5544 tls12_prf->secret,
5545 tls12_prf->secret_length);
5546 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005547 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005549
5550 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005552 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5553 * the variable seed and in this instance means it in the context of the
5554 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 status = psa_mac_update(&hmac,
5556 tls12_prf->label,
5557 tls12_prf->label_length);
5558 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005559 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 }
5561 status = psa_mac_update(&hmac,
5562 tls12_prf->seed,
5563 tls12_prf->seed_length);
5564 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005565 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 }
5567 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005568 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5570 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005571 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005573 }
5574
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 status = psa_mac_sign_finish(&hmac,
5576 tls12_prf->Ai, hash_length,
5577 &hmac_output_length);
5578 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005579 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 }
5581 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005582 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005584
5585 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005586 status = psa_key_derivation_start_hmac(&hmac,
5587 hash_alg,
5588 tls12_prf->secret,
5589 tls12_prf->secret_length);
5590 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005591 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 }
5593 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_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->label, tls12_prf->label_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->seed, tls12_prf->seed_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_sign_finish(&hmac,
5606 tls12_prf->output_block, hash_length,
5607 &hmac_output_length);
5608 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005609 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005611
Janos Follath7742fee2019-06-17 12:58:10 +01005612
5613cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 cleanup_status = psa_mac_abort(&hmac);
5615 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005616 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005618
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005620}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005621
Janos Follath844eb0e2019-06-19 12:10:49 +01005622static psa_status_t psa_key_derivation_tls12_prf_read(
5623 psa_tls12_prf_key_derivation_t *tls12_prf,
5624 psa_algorithm_t alg,
5625 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005627{
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5629 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005630 psa_status_t status;
5631 uint8_t offset, length;
5632
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005634 case PSA_TLS12_PRF_STATE_LABEL_SET:
5635 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5636 break;
5637 case PSA_TLS12_PRF_STATE_OUTPUT:
5638 break;
5639 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005641 }
5642
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005644 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 if (tls12_prf->left_in_block == 0) {
5646 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5647 alg);
5648 if (status != PSA_SUCCESS) {
5649 return status;
5650 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005651
5652 continue;
5653 }
5654
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005656 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005657 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005658 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005660
5661 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005663 output += length;
5664 output_length -= length;
5665 tls12_prf->left_in_block -= length;
5666 }
5667
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005669}
John Durkop07cc04a2020-11-16 22:08:34 -08005670#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5671 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005672
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005673#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5674static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5675 psa_tls12_ecjpake_to_pms_t *ecjpake,
5676 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005678{
5679 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005680 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005681
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 if (output_length != 32) {
5683 return PSA_ERROR_INVALID_ARGUMENT;
5684 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005685
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5687 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5688 &output_size);
5689 if (status != PSA_SUCCESS) {
5690 return status;
5691 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005692
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 if (output_size != output_length) {
5694 return PSA_ERROR_GENERIC_ERROR;
5695 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005696
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005698}
5699#endif
5700
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305701#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305702static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5703 psa_pbkdf2_key_derivation_t *pbkdf2,
5704 psa_algorithm_t prf_alg,
5705 uint8_t prf_output_length,
5706 psa_key_attributes_t *attributes)
5707{
5708 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305709 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305710 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305711 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305712 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305713 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305714 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305715
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305716 mac_operation.is_sign = 1;
5717 mac_operation.mac_size = prf_output_length;
5718 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305719
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305720 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5721 attributes,
5722 pbkdf2->password,
5723 pbkdf2->password_length,
5724 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305725 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305726 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305727 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305728 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5729 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305730 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305731 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305732 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305733 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305734 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305735 }
5736 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5737 &mac_output_length);
5738 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305739 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305740 }
5741
5742 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305743 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305744 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305745 }
5746
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305747 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305748
5749 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305750 /* We are passing prf_output_length as mac_size because the driver
5751 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305752 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305753 status = psa_driver_wrapper_mac_compute(attributes,
5754 pbkdf2->password,
5755 pbkdf2->password_length,
5756 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305757 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305758 &mac_output_length);
5759 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305760 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305761 }
5762
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305763 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305764 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305765
5766cleanup:
5767 /* Zeroise buffers to clear sensitive data from memory. */
5768 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5769 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305770}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305771
5772static psa_status_t psa_key_derivation_pbkdf2_read(
5773 psa_pbkdf2_key_derivation_t *pbkdf2,
5774 psa_algorithm_t kdf_alg,
5775 uint8_t *output,
5776 size_t output_length)
5777{
5778 psa_status_t status;
5779 psa_algorithm_t prf_alg;
5780 uint8_t prf_output_length;
5781 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5782 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5783 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5784
5785 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5786 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5787 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5788 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305789 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5790 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305791 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305792 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305793 } else {
5794 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305795 }
5796
5797 switch (pbkdf2->state) {
5798 case PSA_PBKDF2_STATE_PASSWORD_SET:
5799 /* Initially we need a new block so bytes_used is equal to block size*/
5800 pbkdf2->bytes_used = prf_output_length;
5801 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5802 break;
5803 case PSA_PBKDF2_STATE_OUTPUT:
5804 break;
5805 default:
5806 return PSA_ERROR_BAD_STATE;
5807 }
5808
5809 while (output_length != 0) {
5810 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5811 if (n > output_length) {
5812 n = (uint8_t) output_length;
5813 }
5814 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5815 output += n;
5816 output_length -= n;
5817 pbkdf2->bytes_used += n;
5818
5819 if (output_length == 0) {
5820 break;
5821 }
5822
5823 /* We need a new block */
5824 pbkdf2->bytes_used = 0;
5825 pbkdf2->block_number++;
5826
5827 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5828 prf_output_length,
5829 &attributes);
5830 if (status != PSA_SUCCESS) {
5831 return status;
5832 }
5833 }
5834
5835 return PSA_SUCCESS;
5836}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305837#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305838
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005839psa_status_t psa_key_derivation_output_bytes(
5840 psa_key_derivation_operation_t *operation,
5841 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005842 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005843{
5844 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005846
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005848 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005850 }
5851
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005853 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005854 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005855 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005856 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005857 goto exit;
5858 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005860 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005861 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005862 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5863 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005864 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005865 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005867 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005868 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005869
Przemek Stekiel69c46792022-06-10 12:59:51 +02005870#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5872 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5873 output, output_length);
5874 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005875#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005876#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5877 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5879 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5880 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5881 kdf_alg, output,
5882 output_length);
5883 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005884#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5885 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005886#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005888 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5890 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005891#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305892#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305893 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305894 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5895 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305896 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305897#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005898
Gilles Peskineeab56e42018-07-12 17:12:33 +02005899 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005900 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005901 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005902 }
5903
5904exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005906 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005907 * This allows us to differentiate between exhausted operations and
5908 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5909 * operations. */
5910 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005911 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005912 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005914 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005916}
5917
David Brown7807bf72021-02-09 16:28:23 -07005918#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005919static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005920{
Gilles Peskine449bd832023-01-11 14:50:10 +01005921 if (data_size >= 8) {
5922 mbedtls_des_key_set_parity(data);
5923 }
5924 if (data_size >= 16) {
5925 mbedtls_des_key_set_parity(data + 8);
5926 }
5927 if (data_size >= 24) {
5928 mbedtls_des_key_set_parity(data + 16);
5929 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005930}
David Brown7807bf72021-02-09 16:28:23 -07005931#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005932
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005933/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 * ECC keys on a Weierstrass elliptic curve require the generation
5935 * of a private key which is an integer
5936 * in the range [1, N - 1], where N is the boundary of the private key domain:
5937 * N is the prime p for Diffie-Hellman, or the order of the
5938 * curve’s base point for ECC.
5939 *
5940 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5941 * This function generates the private key using the following process:
5942 *
5943 * 1. Draw a byte string of length ceiling(m/8) bytes.
5944 * 2. If m is not a multiple of 8, set the most significant
5945 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5946 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5947 * 4. If k > N - 2, discard the result and return to step 1.
5948 * 5. Output k + 1 as the private key.
5949 *
5950 * This method allows compliance to NIST standards, specifically the methods titled
5951 * Key-Pair Generation by Testing Candidates in the following publications:
5952 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5953 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5954 * Diffie-Hellman keys.
5955 *
5956 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5957 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5958 *
5959 * Note: Function allocates memory for *data buffer, so given *data should be
5960 * always NULL.
5961 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005962#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5963#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005964static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005965 psa_key_slot_t *slot,
5966 size_t bits,
5967 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005968 uint8_t **data
5969 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005970{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005971 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005972 mbedtls_mpi k;
5973 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005974 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005975 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005976 size_t m;
5977 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005978
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 mbedtls_mpi_init(&k);
5980 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005981
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005982 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005984 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005985 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005986
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005988 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005989 goto cleanup;
5990 }
5991
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005992 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005994
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005996
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005997 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005998 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005999 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006000
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006001 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006002
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006003 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006005
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006006 /* Note: This function is always called with *data == NULL and it
6007 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 *data = mbedtls_calloc(1, m_bytes);
6009 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006010 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006011 goto cleanup;
6012 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006013
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006015 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006017 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006019
6020 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006022 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006023 * (8 * ceiling(m/8) - m) bits of the first byte in
6024 * the string to zero.
6025 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006027 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006028 }
6029
6030 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 * big-endian byte string.
6032 */
6033 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006034
6035 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 * Result of comparison is returned. When it indicates error
6037 * then this function is called again.
6038 */
6039 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006040 }
6041
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006042 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6044 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006045cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 if (ret != 0) {
6047 status = mbedtls_to_psa_error(ret);
6048 }
6049 if (status != PSA_SUCCESS) {
6050 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006051 *data = NULL;
6052 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 mbedtls_mpi_free(&k);
6054 mbedtls_mpi_free(&diff_N_2);
6055 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006056}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006057
6058/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6059 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6060 *
6061 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6062 * draw a 32-byte string and process it as specified in
6063 * Elliptic Curves for Security [RFC7748] §5.
6064 *
6065 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6066 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6067 *
6068 * Note: Function allocates memory for *data buffer, so given *data should be
6069 * always NULL.
6070 */
6071
6072static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6073 size_t bits,
6074 psa_key_derivation_operation_t *operation,
6075 uint8_t **data
6076 )
6077{
6078 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006079 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006080
Gilles Peskine449bd832023-01-11 14:50:10 +01006081 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006082 case 255:
6083 output_length = 32;
6084 break;
6085 case 448:
6086 output_length = 56;
6087 break;
6088 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006090 break;
6091 }
6092
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006094
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 if (*data == NULL) {
6096 return PSA_ERROR_INSUFFICIENT_MEMORY;
6097 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006098
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006100
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006102 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006104
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006106 case 255:
6107 (*data)[0] &= 248;
6108 (*data)[31] &= 127;
6109 (*data)[31] |= 64;
6110 break;
6111 case 448:
6112 (*data)[0] &= 252;
6113 (*data)[55] |= 128;
6114 break;
6115 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006117 break;
6118 }
6119
6120 return status;
6121}
Valerio Setti86587ab2023-06-27 13:09:30 +02006122#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6123static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6124 psa_key_slot_t *slot, size_t bits,
6125 psa_key_derivation_operation_t *operation, uint8_t **data)
6126{
6127 (void) slot;
6128 (void) bits;
6129 (void) operation;
6130 (void) data;
6131 return PSA_ERROR_NOT_SUPPORTED;
6132}
6133
6134static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6135 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6136{
6137 (void) bits;
6138 (void) operation;
6139 (void) data;
6140 return PSA_ERROR_NOT_SUPPORTED;
6141}
6142#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6143#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006144
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006145static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006146 psa_key_slot_t *slot,
6147 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006149{
6150 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306152 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006153 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006154 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006155
Gilles Peskine449bd832023-01-11 14:50:10 +01006156 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6157 return PSA_ERROR_INVALID_ARGUMENT;
6158 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006159
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006160#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006161 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6163 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6164 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006165 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6167 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006168 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 }
6170 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006171 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6173 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006174 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006176 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006177 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006178#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006179 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 if (key_type_is_raw_bytes(slot->attr.type)) {
6181 if (bits % 8 != 0) {
6182 return PSA_ERROR_INVALID_ARGUMENT;
6183 }
6184 data = mbedtls_calloc(1, bytes);
6185 if (data == NULL) {
6186 return PSA_ERROR_INSUFFICIENT_MEMORY;
6187 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006188
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 status = psa_key_derivation_output_bytes(operation, data, bytes);
6190 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006191 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 }
David Brown12ca5032021-02-11 11:02:00 -07006193#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6195 psa_des_set_key_parity(data, bytes);
6196 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006197#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 } else {
6199 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006200 }
Ronald Crondd04d422020-11-28 15:14:42 +01006201
Ronald Cronbf33c932020-11-28 18:06:53 +01006202 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006203 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006205 };
6206
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6208 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6209 &storage_size);
6210 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306211 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 }
Archanad8a83dc2021-06-14 10:04:16 +05306213 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 status = psa_allocate_buffer_to_slot(slot, storage_size);
6215 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306216 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 }
Archanad8a83dc2021-06-14 10:04:16 +05306218
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 status = psa_driver_wrapper_import_key(&attributes,
6220 data, bytes,
6221 slot->key.data,
6222 slot->key.bytes,
6223 &slot->key.bytes, &bits);
6224 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006225 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006227
6228exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 mbedtls_free(data);
6230 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006231}
6232
Gilles Peskine449bd832023-01-11 14:50:10 +01006233psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6234 psa_key_derivation_operation_t *operation,
6235 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006236{
6237 psa_status_t status;
6238 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006239 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006240
Ronald Cron81709fc2020-11-14 12:10:32 +01006241 *key = MBEDTLS_SVC_KEY_ID_INIT;
6242
Gilles Peskine0f84d622019-09-12 19:03:13 +02006243 /* Reject any attempt to create a zero-length key so that we don't
6244 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006245 if (psa_get_key_bits(attributes) == 0) {
6246 return PSA_ERROR_INVALID_ARGUMENT;
6247 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006248
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 if (operation->alg == PSA_ALG_NONE) {
6250 return PSA_ERROR_BAD_STATE;
6251 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006252
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 if (!operation->can_output_key) {
6254 return PSA_ERROR_NOT_PERMITTED;
6255 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006256
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6258 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006259#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006261 /* Deriving a key in a secure element is not implemented yet. */
6262 status = PSA_ERROR_NOT_SUPPORTED;
6263 }
6264#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 if (status == PSA_SUCCESS) {
6266 status = psa_generate_derived_key_internal(slot,
6267 attributes->core.bits,
6268 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006269 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 if (status == PSA_SUCCESS) {
6271 status = psa_finish_key_creation(slot, driver, key);
6272 }
6273 if (status != PSA_SUCCESS) {
6274 psa_fail_key_creation(slot, driver);
6275 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006276
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006278}
6279
Gilles Peskineeab56e42018-07-12 17:12:33 +02006280
6281
6282/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006283/* Key derivation */
6284/****************************************************************/
6285
Steven Cooreman932ffb72021-02-15 12:14:32 +01006286#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006287static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006288{
6289#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6291 return 1;
6292 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006293#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006294#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6296 return 1;
6297 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006298#endif
6299#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6301 return 1;
6302 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006303#endif
6304#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6306 return 1;
6307 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006308#endif
6309#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6311 return 1;
6312 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006313#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006314#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006315 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6316 return 1;
6317 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006318#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306319#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6320 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6321 return 1;
6322 }
6323#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306324#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6325 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6326 return 1;
6327 }
6328#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006330}
6331
Gilles Peskine449bd832023-01-11 14:50:10 +01006332static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006333{
6334 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006335 psa_status_t status = psa_hash_setup(&operation, alg);
6336 psa_hash_abort(&operation);
6337 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006338}
6339
Gilles Peskine969c5d62019-01-16 15:53:06 +01006340static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006341 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006343{
Janos Follath5fe19732019-06-20 15:09:30 +01006344 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6345 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006347
Gilles Peskine969c5d62019-01-16 15:53:06 +01006348 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 if (!is_kdf_alg_supported(kdf_alg)) {
6350 return PSA_ERROR_NOT_SUPPORTED;
6351 }
John Durkop07cc04a2020-11-16 22:08:34 -08006352
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006353 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306354 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006355 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6356 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306357 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6358 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6359 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306360 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306361 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 if (hash_size == 0) {
6363 return PSA_ERROR_NOT_SUPPORTED;
6364 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006365
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006366 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6367 * we might fail later, which is somewhat unfriendly and potentially
6368 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 psa_status_t status = psa_hash_try_support(hash_alg);
6370 if (status != PSA_SUCCESS) {
6371 return status;
6372 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006373 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006374
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6376 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6377 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6378 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006379 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006380#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006381 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6383 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006384 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006385 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006386#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6387 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 operation->capacity = 255 * hash_size;
6389 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006390}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006391
Gilles Peskine449bd832023-01-11 14:50:10 +01006392static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006393{
6394#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 if (alg == PSA_ALG_ECDH) {
6396 return PSA_SUCCESS;
6397 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006398#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006399#if defined(PSA_WANT_ALG_FFDH)
6400 if (alg == PSA_ALG_FFDH) {
6401 return PSA_SUCCESS;
6402 }
6403#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006404 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006406}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006407
6408static int psa_key_derivation_allows_free_form_secret_input(
6409 psa_algorithm_t kdf_alg)
6410{
6411#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6412 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6413 return 0;
6414 }
6415#endif
6416 (void) kdf_alg;
6417 return 1;
6418}
John Durkop07cc04a2020-11-16 22:08:34 -08006419#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006420
Gilles Peskine449bd832023-01-11 14:50:10 +01006421psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6422 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006423{
6424 psa_status_t status;
6425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 if (operation->alg != 0) {
6427 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006428 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006429
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6431 return PSA_ERROR_INVALID_ARGUMENT;
6432 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6433#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6434 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6435 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6436 status = psa_key_agreement_try_support(ka_alg);
6437 if (status != PSA_SUCCESS) {
6438 return status;
6439 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006440 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6441 return PSA_ERROR_INVALID_ARGUMENT;
6442 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006443 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6444#else
6445 return PSA_ERROR_NOT_SUPPORTED;
6446#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6447 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6448#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6449 status = psa_key_derivation_setup_kdf(operation, alg);
6450#else
6451 return PSA_ERROR_NOT_SUPPORTED;
6452#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6453 } else {
6454 return PSA_ERROR_INVALID_ARGUMENT;
6455 }
6456
6457 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006458 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006459 }
6460 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006461}
6462
Przemek Stekiel69c46792022-06-10 12:59:51 +02006463#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006464static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6465 psa_algorithm_t kdf_alg,
6466 psa_key_derivation_step_t step,
6467 const uint8_t *data,
6468 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006469{
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006471 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006473 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006474#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6476 return PSA_ERROR_INVALID_ARGUMENT;
6477 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006478#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 if (hkdf->state != HKDF_STATE_INIT) {
6480 return PSA_ERROR_BAD_STATE;
6481 } else {
6482 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6483 hash_alg,
6484 data, data_length);
6485 if (status != PSA_SUCCESS) {
6486 return status;
6487 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006488 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006490 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006491 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006492#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006494 /* We shouldn't be in different state as HKDF_EXPAND only allows
6495 * two inputs: SECRET (this case) and INFO which does not modify
6496 * the state. It could happen only if the hkdf
6497 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 if (hkdf->state != HKDF_STATE_INIT) {
6499 return PSA_ERROR_BAD_STATE;
6500 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006501
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006502 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6504 return PSA_ERROR_INVALID_ARGUMENT;
6505 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006506
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 memcpy(hkdf->prk, data, data_length);
6508 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006509#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006510 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006511 /* HKDF: If no salt was provided, use an empty salt.
6512 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006514#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6516 return PSA_ERROR_BAD_STATE;
6517 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006518#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6520 hash_alg,
6521 NULL, 0);
6522 if (status != PSA_SUCCESS) {
6523 return status;
6524 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006525 hkdf->state = HKDF_STATE_STARTED;
6526 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006527 if (hkdf->state != HKDF_STATE_STARTED) {
6528 return PSA_ERROR_BAD_STATE;
6529 }
6530 status = psa_mac_update(&hkdf->hmac,
6531 data, data_length);
6532 if (status != PSA_SUCCESS) {
6533 return status;
6534 }
6535 status = psa_mac_sign_finish(&hkdf->hmac,
6536 hkdf->prk,
6537 sizeof(hkdf->prk),
6538 &data_length);
6539 if (status != PSA_SUCCESS) {
6540 return status;
6541 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006542 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006543
Gilles Peskine2b522db2019-04-12 15:11:49 +02006544 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006545 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006546#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006548 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006550 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006552#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006553 {
6554 /* Block 0 is empty, and the next block will be
6555 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006556 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006557 }
6558
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006560 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006561#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6563 return PSA_ERROR_INVALID_ARGUMENT;
6564 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006565#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006566#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6568 hkdf->state == HKDF_STATE_INIT) {
6569 return PSA_ERROR_BAD_STATE;
6570 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006571#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 if (hkdf->state == HKDF_STATE_OUTPUT) {
6573 return PSA_ERROR_BAD_STATE;
6574 }
6575 if (hkdf->info_set) {
6576 return PSA_ERROR_BAD_STATE;
6577 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006578 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 if (data_length != 0) {
6580 hkdf->info = mbedtls_calloc(1, data_length);
6581 if (hkdf->info == NULL) {
6582 return PSA_ERROR_INSUFFICIENT_MEMORY;
6583 }
6584 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006585 }
6586 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006588 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006590 }
6591}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006592#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006593
John Durkop07cc04a2020-11-16 22:08:34 -08006594#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6595 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006596static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6597 const uint8_t *data,
6598 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006599{
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6601 return PSA_ERROR_BAD_STATE;
6602 }
Janos Follathf08e2652019-06-13 09:05:41 +01006603
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 if (data_length != 0) {
6605 prf->seed = mbedtls_calloc(1, data_length);
6606 if (prf->seed == NULL) {
6607 return PSA_ERROR_INSUFFICIENT_MEMORY;
6608 }
Janos Follathf08e2652019-06-13 09:05:41 +01006609
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006611 prf->seed_length = data_length;
6612 }
Janos Follathf08e2652019-06-13 09:05:41 +01006613
Gilles Peskine43f958b2020-12-13 14:55:14 +01006614 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006615
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006617}
6618
Gilles Peskine449bd832023-01-11 14:50:10 +01006619static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6620 const uint8_t *data,
6621 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006622{
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6624 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6625 return PSA_ERROR_BAD_STATE;
6626 }
Janos Follath81550542019-06-13 14:26:34 +01006627
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 if (data_length != 0) {
6629 prf->secret = mbedtls_calloc(1, data_length);
6630 if (prf->secret == NULL) {
6631 return PSA_ERROR_INSUFFICIENT_MEMORY;
6632 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006633
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006635 prf->secret_length = data_length;
6636 }
Janos Follath81550542019-06-13 14:26:34 +01006637
Gilles Peskine43f958b2020-12-13 14:55:14 +01006638 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006639
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006641}
6642
Gilles Peskine449bd832023-01-11 14:50:10 +01006643static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6644 const uint8_t *data,
6645 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006646{
Gilles Peskine449bd832023-01-11 14:50:10 +01006647 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6648 return PSA_ERROR_BAD_STATE;
6649 }
Janos Follath63028dd2019-06-13 09:15:47 +01006650
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 if (data_length != 0) {
6652 prf->label = mbedtls_calloc(1, data_length);
6653 if (prf->label == NULL) {
6654 return PSA_ERROR_INSUFFICIENT_MEMORY;
6655 }
Janos Follath63028dd2019-06-13 09:15:47 +01006656
Gilles Peskine449bd832023-01-11 14:50:10 +01006657 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006658 prf->label_length = data_length;
6659 }
Janos Follath63028dd2019-06-13 09:15:47 +01006660
Gilles Peskine43f958b2020-12-13 14:55:14 +01006661 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006662
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006664}
6665
Gilles Peskine449bd832023-01-11 14:50:10 +01006666static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6667 psa_key_derivation_step_t step,
6668 const uint8_t *data,
6669 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006670{
Gilles Peskine449bd832023-01-11 14:50:10 +01006671 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006672 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006673 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006674 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006676 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006677 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006678 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006680 }
6681}
John Durkop07cc04a2020-11-16 22:08:34 -08006682#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6683 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6684
6685#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6686static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6687 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006688 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006690{
6691 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006692 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6693 4 + data_length + prf->other_secret_length :
6694 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006695
Gilles Peskine449bd832023-01-11 14:50:10 +01006696 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6697 return PSA_ERROR_INVALID_ARGUMENT;
6698 }
John Durkop07cc04a2020-11-16 22:08:34 -08006699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 uint8_t *pms = mbedtls_calloc(1, pms_len);
6701 if (pms == NULL) {
6702 return PSA_ERROR_INSUFFICIENT_MEMORY;
6703 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006704 uint8_t *cur = pms;
6705
6706 /* pure-PSK:
6707 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006708 *
6709 * The premaster secret is formed as follows: if the PSK is N octets
6710 * long, concatenate a uint16 with the value N, N zero octets, a second
6711 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006712 *
6713 * mixed-PSK:
6714 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6715 * follows: concatenate a uint16 with the length of the other secret,
6716 * the other secret itself, uint16 with the length of PSK, and the
6717 * PSK itself.
6718 * For details please check:
6719 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6720 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6721 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006722 */
6723
Gilles Peskine449bd832023-01-11 14:50:10 +01006724 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6725 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6726 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6727 if (prf->other_secret_length != 0) {
6728 memcpy(cur, prf->other_secret, prf->other_secret_length);
6729 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006730 cur += prf->other_secret_length;
6731 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 } else {
6733 *cur++ = MBEDTLS_BYTE_1(data_length);
6734 *cur++ = MBEDTLS_BYTE_0(data_length);
6735 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006736 cur += data_length;
6737 }
6738
Gilles Peskine449bd832023-01-11 14:50:10 +01006739 *cur++ = MBEDTLS_BYTE_1(data_length);
6740 *cur++ = MBEDTLS_BYTE_0(data_length);
6741 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006742 cur += data_length;
6743
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006744 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006745
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006746 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006748}
Janos Follath6660f0e2019-06-17 08:44:03 +01006749
Przemek Stekiele47201b2022-04-19 13:53:28 +02006750static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6751 psa_tls12_prf_key_derivation_t *prf,
6752 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006753 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006754{
Gilles Peskine449bd832023-01-11 14:50:10 +01006755 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6756 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006757 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006758
6759 if (data_length != 0) {
6760 prf->other_secret = mbedtls_calloc(1, data_length);
6761 if (prf->other_secret == NULL) {
6762 return PSA_ERROR_INSUFFICIENT_MEMORY;
6763 }
6764
6765 memcpy(prf->other_secret, data, data_length);
6766 prf->other_secret_length = data_length;
6767 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006768 prf->other_secret_length = 0;
6769 }
6770
6771 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6772
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006774}
6775
Janos Follath6660f0e2019-06-17 08:44:03 +01006776static psa_status_t psa_tls12_prf_psk_to_ms_input(
6777 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006778 psa_key_derivation_step_t step,
6779 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006781{
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006783 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 return psa_tls12_prf_psk_to_ms_set_key(prf,
6785 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006786 break;
6787 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6789 data,
6790 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006791 break;
6792 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006794 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006795
Przemek Stekiele47201b2022-04-19 13:53:28 +02006796 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006797}
John Durkop07cc04a2020-11-16 22:08:34 -08006798#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006799
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006800#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6801static psa_status_t psa_tls12_ecjpake_to_pms_input(
6802 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006803 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006804 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006805 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006806{
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6808 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6809 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006810 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006811
6812 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 if (data[0] != 0x04) {
6814 return PSA_ERROR_INVALID_ARGUMENT;
6815 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006816
6817 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006819
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006821}
6822#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306823
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306824#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306825static psa_status_t psa_pbkdf2_set_input_cost(
6826 psa_pbkdf2_key_derivation_t *pbkdf2,
6827 psa_key_derivation_step_t step,
6828 uint64_t data)
6829{
6830 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6831 return PSA_ERROR_INVALID_ARGUMENT;
6832 }
6833
6834 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6835 return PSA_ERROR_BAD_STATE;
6836 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306837
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306838 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306839 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306840 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306841
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306842 if (data == 0) {
6843 return PSA_ERROR_INVALID_ARGUMENT;
6844 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306845
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306846 pbkdf2->input_cost = data;
6847 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6848
6849 return PSA_SUCCESS;
6850}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306851
6852static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6853 const uint8_t *data,
6854 size_t data_length)
6855{
Gilles Peskineead17662023-08-20 22:02:51 +02006856 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6857 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6858 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6859 /* Appending to existing salt. No state change. */
6860 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306861 return PSA_ERROR_BAD_STATE;
6862 }
6863
Gilles Peskineca57d782023-07-20 19:08:06 +02006864 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006865 /* Appending an empty string, nothing to do. */
6866 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306867 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306868
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306869 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6870 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306871 return PSA_ERROR_INSUFFICIENT_MEMORY;
6872 }
6873
Gilles Peskineead17662023-08-20 22:02:51 +02006874 if (pbkdf2->salt_length != 0) {
6875 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6876 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306877 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306878 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306879 mbedtls_free(pbkdf2->salt);
6880 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306881 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306882 return PSA_SUCCESS;
6883}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306884
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306885#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306886static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306887 const uint8_t *input,
6888 size_t input_len,
6889 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306890 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306891{
6892 psa_status_t status = PSA_SUCCESS;
6893 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6894 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306895 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306896 } else {
6897 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306898 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306899 }
6900 return status;
6901}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306902#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306903
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306904#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306905static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6906 size_t input_len,
6907 uint8_t *output,
6908 size_t *output_len)
6909{
6910 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306911 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306912 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306913 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306914 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6915 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6916 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306917 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306918 * mac_size as the driver function sets mac_output_length = mac_size
6919 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306920 status = psa_driver_wrapper_mac_compute(&attributes,
6921 zeros, sizeof(zeros),
6922 PSA_ALG_CMAC, input, input_len,
6923 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306924 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6925 128U,
6926 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306927 output_len);
6928 } else {
6929 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306930 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306931 }
6932 return status;
6933}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306934#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306935
6936static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306937 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306938 const uint8_t *data,
6939 size_t data_length)
6940{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306941 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306942 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6943 return PSA_ERROR_BAD_STATE;
6944 }
6945
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306946#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306947 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6948 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6949 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6950 pbkdf2->password,
6951 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306952 } else
6953#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6954#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6955 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306956 status = psa_pbkdf2_cmac_set_password(data, data_length,
6957 pbkdf2->password,
6958 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306959 } else
6960#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6961 {
6962 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306963 }
6964
6965 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6966
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306967 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306968}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306969
6970static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306971 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306972 psa_key_derivation_step_t step,
6973 const uint8_t *data,
6974 size_t data_length)
6975{
6976 switch (step) {
6977 case PSA_KEY_DERIVATION_INPUT_SALT:
6978 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6979 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306980 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306981 default:
6982 return PSA_ERROR_INVALID_ARGUMENT;
6983 }
6984}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306985#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306986
Gilles Peskineb8965192019-09-24 16:21:10 +02006987/** Check whether the given key type is acceptable for the given
6988 * input step of a key derivation.
6989 *
6990 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6991 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6992 * Both secret and non-secret inputs can alternatively have the type
6993 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6994 * that the input was passed as a buffer rather than via a key object.
6995 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006996static int psa_key_derivation_check_input_type(
6997 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006999{
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007001 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007002 if (key_type == PSA_KEY_TYPE_DERIVE) {
7003 return PSA_SUCCESS;
7004 }
7005 if (key_type == PSA_KEY_TYPE_NONE) {
7006 return PSA_SUCCESS;
7007 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007008 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007009 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 if (key_type == PSA_KEY_TYPE_DERIVE) {
7011 return PSA_SUCCESS;
7012 }
7013 if (key_type == PSA_KEY_TYPE_NONE) {
7014 return PSA_SUCCESS;
7015 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007016 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007017 case PSA_KEY_DERIVATION_INPUT_LABEL:
7018 case PSA_KEY_DERIVATION_INPUT_SALT:
7019 case PSA_KEY_DERIVATION_INPUT_INFO:
7020 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007021 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7022 return PSA_SUCCESS;
7023 }
7024 if (key_type == PSA_KEY_TYPE_NONE) {
7025 return PSA_SUCCESS;
7026 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007027 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307028 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7029 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7030 return PSA_SUCCESS;
7031 }
7032 if (key_type == PSA_KEY_TYPE_DERIVE) {
7033 return PSA_SUCCESS;
7034 }
7035 if (key_type == PSA_KEY_TYPE_NONE) {
7036 return PSA_SUCCESS;
7037 }
7038 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007039 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007041}
7042
Janos Follathb80a94e2019-06-12 15:54:46 +01007043static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007044 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007045 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007046 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007047 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007049{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007050 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007052
Gilles Peskine449bd832023-01-11 14:50:10 +01007053 status = psa_key_derivation_check_input_type(step, key_type);
7054 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007055 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007057
Przemek Stekiel69c46792022-06-10 12:59:51 +02007058#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7060 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7061 step, data, data_length);
7062 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007063#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007064#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7066 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7067 step, data, data_length);
7068 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007069#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7070#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7072 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7073 step, data, data_length);
7074 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007075#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007076#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007078 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7080 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007081#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307082#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307083 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307084 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7085 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307086 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307087#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007088 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007089 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007090 (void) data;
7091 (void) data_length;
7092 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007094 }
7095
Gilles Peskine224b0d62019-09-23 18:13:17 +02007096exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 if (status != PSA_SUCCESS) {
7098 psa_key_derivation_abort(operation);
7099 }
7100 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007101}
7102
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307103static psa_status_t psa_key_derivation_input_integer_internal(
7104 psa_key_derivation_operation_t *operation,
7105 psa_key_derivation_step_t step,
7106 uint64_t value)
7107{
7108 psa_status_t status;
7109 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7110
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307111#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307112 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307113 status = psa_pbkdf2_set_input_cost(
7114 &operation->ctx.pbkdf2, step, value);
7115 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307116#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307117 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307118 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307119 (void) value;
7120 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307121 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307122 }
7123
7124 if (status != PSA_SUCCESS) {
7125 psa_key_derivation_abort(operation);
7126 }
7127 return status;
7128}
7129
Janos Follath51f4a0f2019-06-14 11:35:55 +01007130psa_status_t psa_key_derivation_input_bytes(
7131 psa_key_derivation_operation_t *operation,
7132 psa_key_derivation_step_t step,
7133 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007135{
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 return psa_key_derivation_input_internal(operation, step,
7137 PSA_KEY_TYPE_NONE,
7138 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007139}
7140
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307141psa_status_t psa_key_derivation_input_integer(
7142 psa_key_derivation_operation_t *operation,
7143 psa_key_derivation_step_t step,
7144 uint64_t value)
7145{
7146 return psa_key_derivation_input_integer_internal(operation, step, value);
7147}
7148
Janos Follath51f4a0f2019-06-14 11:35:55 +01007149psa_status_t psa_key_derivation_input_key(
7150 psa_key_derivation_operation_t *operation,
7151 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007153{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007154 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007155 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007156 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007157
Ronald Cron5c522922020-11-14 16:35:34 +01007158 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7160 if (status != PSA_SUCCESS) {
7161 psa_key_derivation_abort(operation);
7162 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007163 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007164
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307165 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7166 * permission to output to a key object. */
7167 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7168 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007169 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007170 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007171
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 status = psa_key_derivation_input_internal(operation,
7173 step, slot->attr.type,
7174 slot->key.data,
7175 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007176
Ryan Everett1b70a072024-01-04 10:32:49 +00007177 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007178
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007180}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007181
7182
7183
7184/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007185/* Key agreement */
7186/****************************************************************/
7187
Gilles Peskine449bd832023-01-11 14:50:10 +01007188psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7189 const uint8_t *key_buffer,
7190 size_t key_buffer_size,
7191 psa_algorithm_t alg,
7192 const uint8_t *peer_key,
7193 size_t peer_key_length,
7194 uint8_t *shared_secret,
7195 size_t shared_secret_size,
7196 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007197{
Gilles Peskine449bd832023-01-11 14:50:10 +01007198 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007199#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007200 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7202 key_buffer_size, alg,
7203 peer_key, peer_key_length,
7204 shared_secret,
7205 shared_secret_size,
7206 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007207#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007208
7209#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7210 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007211 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007212 peer_key,
7213 peer_key_length,
7214 key_buffer,
7215 key_buffer_size,
7216 shared_secret,
7217 shared_secret_size,
7218 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007219#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7220
Gilles Peskine01d718c2018-09-18 12:01:02 +02007221 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007222 (void) attributes;
7223 (void) key_buffer;
7224 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007225 (void) peer_key;
7226 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007227 (void) shared_secret;
7228 (void) shared_secret_size;
7229 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007231 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007232}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007233
Aditya Deshpande17845b82022-10-13 17:21:01 +01007234/** Internal function for raw key agreement
7235 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007236 * to the driver's implementation if a driver is present.
7237 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007238 * (psa_key_agreement_raw_builtin).
7239 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007240static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7241 psa_key_slot_t *private_key,
7242 const uint8_t *peer_key,
7243 size_t peer_key_length,
7244 uint8_t *shared_secret,
7245 size_t shared_secret_size,
7246 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007247{
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7249 return PSA_ERROR_NOT_SUPPORTED;
7250 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007251
7252 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007253 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007254 };
7255
Gilles Peskine449bd832023-01-11 14:50:10 +01007256 return psa_driver_wrapper_key_agreement(&attributes,
7257 private_key->key.data,
7258 private_key->key.bytes, alg,
7259 peer_key, peer_key_length,
7260 shared_secret,
7261 shared_secret_size,
7262 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007263}
7264
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007265/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007266 * to potentially free embedded data structures and wipe confidential data.
7267 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007268static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7269 psa_key_derivation_step_t step,
7270 psa_key_slot_t *private_key,
7271 const uint8_t *peer_key,
7272 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007273{
7274 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007275 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007276 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007278
7279 /* Step 1: run the secret agreement algorithm to generate the shared
7280 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 status = psa_key_agreement_raw_internal(ka_alg,
7282 private_key,
7283 peer_key, peer_key_length,
7284 shared_secret,
7285 sizeof(shared_secret),
7286 &shared_secret_length);
7287 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007288 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007290
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007291 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007292 * the shared secret. A shared secret is permitted wherever a key
7293 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 status = psa_key_derivation_input_internal(operation, step,
7295 PSA_KEY_TYPE_DERIVE,
7296 shared_secret,
7297 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007298exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7300 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007301}
7302
Gilles Peskine449bd832023-01-11 14:50:10 +01007303psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7304 psa_key_derivation_step_t step,
7305 mbedtls_svc_key_id_t private_key,
7306 const uint8_t *peer_key,
7307 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007308{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007309 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007310 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007311 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007312
Gilles Peskine449bd832023-01-11 14:50:10 +01007313 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7314 return PSA_ERROR_INVALID_ARGUMENT;
7315 }
Ronald Cron5c522922020-11-14 16:35:34 +01007316 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7318 if (status != PSA_SUCCESS) {
7319 return status;
7320 }
7321 status = psa_key_agreement_internal(operation, step,
7322 slot,
7323 peer_key, peer_key_length);
7324 if (status != PSA_SUCCESS) {
7325 psa_key_derivation_abort(operation);
7326 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007327 /* If a private key has been added as SECRET, we allow the derived
7328 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007330 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007332 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007333
Ryan Everett1b70a072024-01-04 10:32:49 +00007334 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007335
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007337}
7338
Gilles Peskine449bd832023-01-11 14:50:10 +01007339psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7340 mbedtls_svc_key_id_t private_key,
7341 const uint8_t *peer_key,
7342 size_t peer_key_length,
7343 uint8_t *output,
7344 size_t output_size,
7345 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007346{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007347 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007348 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007349 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007350 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007351
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007353 status = PSA_ERROR_INVALID_ARGUMENT;
7354 goto exit;
7355 }
Ronald Cron5c522922020-11-14 16:35:34 +01007356 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007357 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7358 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007359 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007361
Gilles Peskine3e561302022-04-14 00:17:15 +02007362 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7363 * for the output size. The PSA specification only guarantees that this
7364 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7365 * but it might be nice to allow smaller buffers if the output fits.
7366 * At the time of writing this comment, with only ECDH implemented,
7367 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7368 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7369 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007370 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007371 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7372 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007373 status = PSA_ERROR_BUFFER_TOO_SMALL;
7374 goto exit;
7375 }
7376
Gilles Peskine449bd832023-01-11 14:50:10 +01007377 status = psa_key_agreement_raw_internal(alg, slot,
7378 peer_key, peer_key_length,
7379 output, output_size,
7380 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007381
7382exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007383 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007384 /* If an error happens and is not handled properly, the output
7385 * may be used as a key to protect sensitive data. Arrange for such
7386 * a key to be random, which is likely to result in decryption or
7387 * verification errors. This is better than filling the buffer with
7388 * some constant data such as zeros, which would result in the data
7389 * being protected with a reproducible, easily knowable key.
7390 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007392 *output_length = output_size;
7393 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007394
Ryan Everett1b70a072024-01-04 10:32:49 +00007395 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007396
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007398}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007399
7400
Gilles Peskine30524eb2020-11-13 17:02:26 +01007401
Gilles Peskine86a440b2018-11-12 18:39:40 +01007402/****************************************************************/
7403/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007404/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007405
Gilles Peskine672a7712023-04-28 21:00:28 +02007406#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7407#include "entropy_poll.h"
7408#endif
7409
Gilles Peskine30524eb2020-11-13 17:02:26 +01007410/** Initialize the PSA random generator.
7411 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007412static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007413{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007414#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007415 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007416#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7417
Gilles Peskine30524eb2020-11-13 17:02:26 +01007418 /* Set default configuration if
7419 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007421 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 }
7423 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007424 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007426
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007428#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7429 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7430 /* The PSA entropy injection feature depends on using NV seed as an entropy
7431 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 mbedtls_entropy_add_source(&rng->entropy,
7433 mbedtls_nv_seed_poll, NULL,
7434 MBEDTLS_ENTROPY_BLOCK_SIZE,
7435 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007436#endif
7437
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007439#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007440}
7441
7442/** Deinitialize the PSA random generator.
7443 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007444static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007445{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007446#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007447 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007448#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007449 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7450 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007451#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007452}
7453
7454/** Seed the PSA random generator.
7455 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007456static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007457{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007458#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7459 /* Do nothing: the external RNG seeds itself. */
7460 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007462#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007463 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7465 drbg_seed, sizeof(drbg_seed) - 1);
7466 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007467#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007468}
7469
Gilles Peskine449bd832023-01-11 14:50:10 +01007470psa_status_t psa_generate_random(uint8_t *output,
7471 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007472{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007473 GUARD_MODULE_INITIALIZED;
7474
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007475#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7476
7477 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7479 output, output_size,
7480 &output_length);
7481 if (status != PSA_SUCCESS) {
7482 return status;
7483 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007484 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007485 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 if (output_length != output_size) {
7487 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7488 }
7489 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007490
7491#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7492
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007494 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007495 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7496 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7497 output_size);
7498 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7499 output, request_size);
7500 if (ret != 0) {
7501 return mbedtls_to_psa_error(ret);
7502 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007503 output_size -= request_size;
7504 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007505 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007506 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007507#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007508}
7509
Gilles Peskine8814fc42020-12-14 15:33:44 +01007510/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007511 *
7512 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7513 * `psa_generate_random(...)`. The state parameter is ignored since the
7514 * PSA API doesn't support passing an explicit state.
7515 *
7516 * In the non-external case, psa_generate_random() calls an
7517 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7518 * and semantics as mbedtls_psa_get_random(). As an optimization,
7519 * instead of doing this back-and-forth between the PSA API and the
7520 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7521 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007522 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007523#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7524int mbedtls_psa_get_random(void *p_rng,
7525 unsigned char *output,
7526 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007527{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007528 /* This function takes a pointer to the RNG state because that's what
7529 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7530 * its own state internally and doesn't let the caller access that state.
7531 * So we just ignore the state parameter, and in practice we'll pass
7532 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007533 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 psa_status_t status = psa_generate_random(output, output_size);
7535 if (status == PSA_SUCCESS) {
7536 return 0;
7537 } else {
7538 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7539 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007540}
7541#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7542
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007543#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007544psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7545 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007546{
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 if (global_data.initialized) {
7548 return PSA_ERROR_NOT_PERMITTED;
7549 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007550
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7552 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7553 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7554 return PSA_ERROR_INVALID_ARGUMENT;
7555 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007556
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007558}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007559#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007560
Ronald Cron3772afe2021-02-08 16:10:05 +01007561/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007562 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007563 * \param type The key type
7564 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007565 *
7566 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007567 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007568 * \retval #PSA_ERROR_INVALID_ARGUMENT
7569 * The size in bits of the key is not valid.
7570 * \retval #PSA_ERROR_NOT_SUPPORTED
7571 * The type and/or the size in bits of the key or the combination of
7572 * the two is not supported.
7573 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007574static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007576{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007577 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007578
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 if (key_type_is_raw_bytes(type)) {
7580 status = psa_validate_unstructured_key_bit_size(type, bits);
7581 if (status != PSA_SUCCESS) {
7582 return status;
7583 }
7584 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007585#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7587 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7588 return PSA_ERROR_NOT_SUPPORTED;
7589 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007590 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007591 return PSA_ERROR_NOT_SUPPORTED;
7592 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007593
Ronald Cron01b2aba2020-10-05 09:42:02 +02007594 /* Accept only byte-aligned keys, for the same reasons as
7595 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 if (bits % 8 != 0) {
7597 return PSA_ERROR_NOT_SUPPORTED;
7598 }
7599 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007600#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007601
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007602#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007604 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 return PSA_SUCCESS;
7606 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007607#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007608
Valerio Settia55f0422023-07-10 15:34:41 +02007609#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007610 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007611 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007612 return PSA_ERROR_NOT_SUPPORTED;
7613 }
7614 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007615#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007616 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007617 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007618 }
7619
Gilles Peskine449bd832023-01-11 14:50:10 +01007620 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007621}
7622
Ronald Cron55ed0592020-10-05 10:30:40 +02007623psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007624 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007626{
7627 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007628 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 if ((attributes->domain_parameters == NULL) &&
7631 (attributes->domain_parameters_size != 0)) {
7632 return PSA_ERROR_INVALID_ARGUMENT;
7633 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007634
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 if (key_type_is_raw_bytes(type)) {
7636 status = psa_generate_random(key_buffer, key_buffer_size);
7637 if (status != PSA_SUCCESS) {
7638 return status;
7639 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007640
David Brown12ca5032021-02-11 11:02:00 -07007641#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 if (type == PSA_KEY_TYPE_DES) {
7643 psa_des_set_key_parity(key_buffer, key_buffer_size);
7644 }
David Brown8107e312021-02-12 08:08:46 -07007645#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007647
Valerio Setti76df8c12023-07-11 14:11:28 +02007648#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7650 return mbedtls_psa_rsa_generate_key(attributes,
7651 key_buffer,
7652 key_buffer_size,
7653 key_buffer_length);
7654 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007655#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007656
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007657#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7659 return mbedtls_psa_ecp_generate_key(attributes,
7660 key_buffer,
7661 key_buffer_size,
7662 key_buffer_length);
7663 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007664#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007665
Valerio Settia55f0422023-07-10 15:34:41 +02007666#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007667 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7668 return mbedtls_psa_ffdh_generate_key(attributes,
7669 key_buffer,
7670 key_buffer_size,
7671 key_buffer_length);
7672 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007673#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007674 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 (void) key_buffer_length;
7676 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007677 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007678
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007680}
Darryl Green0c6575a2018-11-07 16:05:30 +00007681
Gilles Peskine449bd832023-01-11 14:50:10 +01007682psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7683 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007684{
7685 psa_status_t status;
7686 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007687 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007688 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007689
Ronald Cron81709fc2020-11-14 12:10:32 +01007690 *key = MBEDTLS_SVC_KEY_ID_INIT;
7691
Gilles Peskine0f84d622019-09-12 19:03:13 +02007692 /* Reject any attempt to create a zero-length key so that we don't
7693 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 if (psa_get_key_bits(attributes) == 0) {
7695 return PSA_ERROR_INVALID_ARGUMENT;
7696 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007697
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007698 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7700 return PSA_ERROR_INVALID_ARGUMENT;
7701 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007702
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7704 &slot, &driver);
7705 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007706 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 }
Gilles Peskine11792082019-08-06 18:36:36 +02007708
Ronald Cron977c2472020-10-13 08:32:21 +02007709 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307710 * storage ( thus not in the case of generating a key in a secure element
7711 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7712 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007713 if (slot->key.data == NULL) {
7714 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7715 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007716 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 attributes->core.type, attributes->core.bits);
7718 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007719 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007720 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007721
7722 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 attributes->core.type,
7724 attributes->core.bits);
7725 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007726 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007727 attributes, &key_buffer_size);
7728 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007729 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 }
Ronald Cron977c2472020-10-13 08:32:21 +02007731 }
Ronald Cron977c2472020-10-13 08:32:21 +02007732
Gilles Peskine449bd832023-01-11 14:50:10 +01007733 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7734 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007735 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 }
Ronald Cron977c2472020-10-13 08:32:21 +02007737 }
7738
Gilles Peskine449bd832023-01-11 14:50:10 +01007739 status = psa_driver_wrapper_generate_key(attributes,
7740 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007741
Gilles Peskine449bd832023-01-11 14:50:10 +01007742 if (status != PSA_SUCCESS) {
7743 psa_remove_key_data_from_memory(slot);
7744 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007745
Gilles Peskine11792082019-08-06 18:36:36 +02007746exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007747 if (status == PSA_SUCCESS) {
7748 status = psa_finish_key_creation(slot, driver, key);
7749 }
7750 if (status != PSA_SUCCESS) {
7751 psa_fail_key_creation(slot, driver);
7752 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007753
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007755}
7756
Gilles Peskinee59236f2018-01-27 23:32:46 +01007757/****************************************************************/
7758/* Module setup */
7759/****************************************************************/
7760
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007761#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007762psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 void (* entropy_init)(mbedtls_entropy_context *ctx),
7764 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007765{
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7767 return PSA_ERROR_BAD_STATE;
7768 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007769 global_data.rng.entropy_init = entropy_init;
7770 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007772}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007773#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007774
Gilles Peskine449bd832023-01-11 14:50:10 +01007775void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007776{
Gilles Peskine449bd832023-01-11 14:50:10 +01007777 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007778 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7779 mbedtls_psa_random_free(&global_data.rng);
7780 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007781 /* Wipe all remaining data, including configuration.
7782 * In particular, this sets all state indicator to the value
7783 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007785
7786 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007788}
7789
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007790#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7791/** Recover a transaction that was interrupted by a power failure.
7792 *
7793 * This function is called during initialization, before psa_crypto_init()
7794 * returns. If this function returns a failure status, the initialization
7795 * fails.
7796 */
7797static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007799{
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007801 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7802 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 /* TODO - fall through to the failure case until this
7804 * is implemented.
7805 * https://github.com/ARMmbed/mbed-crypto/issues/218
7806 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007807 default:
7808 /* We found an unsupported transaction in the storage.
7809 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007811 }
7812}
7813#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7814
Gilles Peskine449bd832023-01-11 14:50:10 +01007815psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007816{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007817 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007818
Gilles Peskinec6b69072018-11-20 21:42:52 +01007819 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007820 if (global_data.initialized != 0) {
7821 return PSA_SUCCESS;
7822 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007823
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007824 /* Init drivers */
7825 status = psa_driver_wrapper_init();
7826 if (status != PSA_SUCCESS) {
7827 goto exit;
7828 }
7829 global_data.drivers_initialized = 1;
7830
Valerio Setti402cfba2023-11-13 10:24:32 +01007831 status = psa_initialize_key_slots();
7832 if (status != PSA_SUCCESS) {
7833 goto exit;
7834 }
7835
Gilles Peskine30524eb2020-11-13 17:02:26 +01007836 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007837 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007838 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007839 status = mbedtls_psa_random_seed(&global_data.rng);
7840 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007841 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007843 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007844
Gilles Peskine4b734222019-07-24 15:56:31 +02007845#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 status = psa_crypto_load_transaction();
7847 if (status == PSA_SUCCESS) {
7848 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7849 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007850 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 }
7852 status = psa_crypto_stop_transaction();
7853 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007854 /* There's no transaction to complete. It's all good. */
7855 status = PSA_SUCCESS;
7856 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007857#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007858
Gilles Peskinec6b69072018-11-20 21:42:52 +01007859 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007860 global_data.initialized = 1;
7861
7862exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 if (status != PSA_SUCCESS) {
7864 mbedtls_psa_crypto_free();
7865 }
7866 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007867}
7868
Yanray Wangffc3c482023-07-11 12:01:04 +08007869#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007870psa_status_t psa_crypto_driver_pake_get_password_len(
7871 const psa_crypto_driver_pake_inputs_t *inputs,
7872 size_t *password_len)
7873{
7874 if (inputs->password_len == 0) {
7875 return PSA_ERROR_BAD_STATE;
7876 }
7877
7878 *password_len = inputs->password_len;
7879
7880 return PSA_SUCCESS;
7881}
7882
7883psa_status_t psa_crypto_driver_pake_get_password(
7884 const psa_crypto_driver_pake_inputs_t *inputs,
7885 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7886{
7887 if (inputs->password_len == 0) {
7888 return PSA_ERROR_BAD_STATE;
7889 }
7890
7891 if (buffer_size < inputs->password_len) {
7892 return PSA_ERROR_BUFFER_TOO_SMALL;
7893 }
7894
7895 memcpy(buffer, inputs->password, inputs->password_len);
7896 *buffer_length = inputs->password_len;
7897
7898 return PSA_SUCCESS;
7899}
7900
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007901psa_status_t psa_crypto_driver_pake_get_user_len(
7902 const psa_crypto_driver_pake_inputs_t *inputs,
7903 size_t *user_len)
7904{
7905 if (inputs->user_len == 0) {
7906 return PSA_ERROR_BAD_STATE;
7907 }
7908
7909 *user_len = inputs->user_len;
7910
7911 return PSA_SUCCESS;
7912}
7913
7914psa_status_t psa_crypto_driver_pake_get_user(
7915 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007916 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007917{
7918 if (inputs->user_len == 0) {
7919 return PSA_ERROR_BAD_STATE;
7920 }
7921
Przemek Stekielc0e62502023-03-14 11:49:36 +01007922 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007923 return PSA_ERROR_BUFFER_TOO_SMALL;
7924 }
7925
Przemek Stekielc0e62502023-03-14 11:49:36 +01007926 memcpy(user_id, inputs->user, inputs->user_len);
7927 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007928
7929 return PSA_SUCCESS;
7930}
7931
7932psa_status_t psa_crypto_driver_pake_get_peer_len(
7933 const psa_crypto_driver_pake_inputs_t *inputs,
7934 size_t *peer_len)
7935{
7936 if (inputs->peer_len == 0) {
7937 return PSA_ERROR_BAD_STATE;
7938 }
7939
7940 *peer_len = inputs->peer_len;
7941
7942 return PSA_SUCCESS;
7943}
7944
7945psa_status_t psa_crypto_driver_pake_get_peer(
7946 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007947 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007948{
7949 if (inputs->peer_len == 0) {
7950 return PSA_ERROR_BAD_STATE;
7951 }
7952
Przemek Stekielc0e62502023-03-14 11:49:36 +01007953 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007954 return PSA_ERROR_BUFFER_TOO_SMALL;
7955 }
7956
Przemek Stekielc0e62502023-03-14 11:49:36 +01007957 memcpy(peer_id, inputs->peer, inputs->peer_len);
7958 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007959
7960 return PSA_SUCCESS;
7961}
7962
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007963psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7964 const psa_crypto_driver_pake_inputs_t *inputs,
7965 psa_pake_cipher_suite_t *cipher_suite)
7966{
7967 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7968 return PSA_ERROR_BAD_STATE;
7969 }
7970
7971 *cipher_suite = inputs->cipher_suite;
7972
7973 return PSA_SUCCESS;
7974}
7975
Neil Armstronga7d08c32022-06-01 18:21:20 +02007976psa_status_t psa_pake_setup(
7977 psa_pake_operation_t *operation,
7978 const psa_pake_cipher_suite_t *cipher_suite)
7979{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007980 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007981
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007982 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007983 status = PSA_ERROR_BAD_STATE;
7984 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007985 }
7986
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007987 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007988 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007989 status = PSA_ERROR_INVALID_ARGUMENT;
7990 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007991 }
7992
Przemek Stekiel51eac532022-12-07 11:04:51 +01007993 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7994
Przemek Stekiele12ed362022-12-21 12:54:46 +01007995 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007996 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7997 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007998 operation->data.inputs.cipher_suite = *cipher_suite;
7999
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008000#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008001 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008002 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008003 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008004
David Horstmann16f01512023-06-14 17:21:07 +01008005 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008006 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008007 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008008#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008009 {
8010 status = PSA_ERROR_NOT_SUPPORTED;
8011 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008012 }
8013
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008014 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8015
Przemek Stekiel51eac532022-12-07 11:04:51 +01008016 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008017exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008018 psa_pake_abort(operation);
8019 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008020}
8021
8022psa_status_t psa_pake_set_password_key(
8023 psa_pake_operation_t *operation,
8024 mbedtls_svc_key_id_t password)
8025{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008026 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008027 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8028 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008029 psa_key_attributes_t attributes;
8030 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008031
Przemek Stekiel51eac532022-12-07 11:04:51 +01008032 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008033 status = PSA_ERROR_BAD_STATE;
8034 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008035 }
8036
Przemek Stekiel6c764412022-11-22 14:05:12 +01008037 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8038 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008039 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008040 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008041 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008042 }
8043
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008044 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008045 .core = slot->attr
8046 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008047
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008048 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008049
Przemek Stekiel51eac532022-12-07 11:04:51 +01008050 if (type != PSA_KEY_TYPE_PASSWORD &&
8051 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8052 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008053 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008054 }
8055
Przemek Stekiel51eac532022-12-07 11:04:51 +01008056 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8057 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008058 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008059 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008060 }
8061
8062 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8063 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008064 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008065exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008066 if (status != PSA_SUCCESS) {
8067 psa_pake_abort(operation);
8068 }
Ryan Everett1b70a072024-01-04 10:32:49 +00008069 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008070 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008071}
8072
8073psa_status_t psa_pake_set_user(
8074 psa_pake_operation_t *operation,
8075 const uint8_t *user_id,
8076 size_t user_id_len)
8077{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008078 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008079
8080 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008081 status = PSA_ERROR_BAD_STATE;
8082 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008083 }
8084
Przemek Stekiel51eac532022-12-07 11:04:51 +01008085 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008086 status = PSA_ERROR_INVALID_ARGUMENT;
8087 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008088 }
8089
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008090 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008091 status = PSA_ERROR_BAD_STATE;
8092 goto exit;
8093 }
8094
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008095 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8096 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008097 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8098 goto exit;
8099 }
8100
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008101 memcpy(operation->data.inputs.user, user_id, user_id_len);
8102 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008103
8104 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008105exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008106 psa_pake_abort(operation);
8107 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008108}
8109
8110psa_status_t psa_pake_set_peer(
8111 psa_pake_operation_t *operation,
8112 const uint8_t *peer_id,
8113 size_t peer_id_len)
8114{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008115 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008116
8117 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008118 status = PSA_ERROR_BAD_STATE;
8119 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008120 }
8121
Przemek Stekiel51eac532022-12-07 11:04:51 +01008122 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008123 status = PSA_ERROR_INVALID_ARGUMENT;
8124 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008125 }
8126
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008127 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008128 status = PSA_ERROR_BAD_STATE;
8129 goto exit;
8130 }
8131
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008132 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8133 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008134 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8135 goto exit;
8136 }
8137
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008138 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8139 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008140
8141 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008142exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008143 psa_pake_abort(operation);
8144 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008145}
8146
8147psa_status_t psa_pake_set_role(
8148 psa_pake_operation_t *operation,
8149 psa_pake_role_t role)
8150{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008151 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008152
Przemek Stekiel51eac532022-12-07 11:04:51 +01008153 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008154 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008155 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008156 }
8157
Przemek Stekiel09104b82023-03-06 14:11:51 +01008158 switch (operation->alg) {
8159#if defined(PSA_WANT_ALG_JPAKE)
8160 case PSA_ALG_JPAKE:
8161 if (role == PSA_PAKE_ROLE_NONE) {
8162 return PSA_SUCCESS;
8163 }
8164 status = PSA_ERROR_INVALID_ARGUMENT;
8165 break;
8166#endif
8167 default:
8168 (void) role;
8169 status = PSA_ERROR_NOT_SUPPORTED;
8170 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008171 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008172exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008173 psa_pake_abort(operation);
8174 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008175}
8176
David Horstmanne7f21e62023-05-12 18:17:21 +01008177/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008178#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008179static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008180 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008181{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008182 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008183 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008184 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008185
David Horstmann024e5c52023-06-14 15:48:21 +01008186 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008187 is_x1 = (stage->outputs < 1);
8188 } else {
8189 is_x1 = (stage->inputs < 1);
8190 }
8191
David Horstmann74a3d8c2023-06-14 18:28:19 +01008192 key_share_step = is_x1 ?
8193 PSA_JPAKE_X1_STEP_KEY_SHARE :
8194 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008195 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008196 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8197 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8198 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8199 } else {
8200 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008201 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008202 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008203}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008204#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008205
Przemek Stekiel2797d372022-12-22 11:19:22 +01008206static psa_status_t psa_pake_complete_inputs(
8207 psa_pake_operation_t *operation)
8208{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008209 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008210 /* Create copy of the inputs on stack as inputs share memory
8211 with the driver context which will be setup by the driver. */
8212 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008213
Przemek Stekielfde11282023-03-13 16:06:09 +01008214 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008215 return PSA_ERROR_BAD_STATE;
8216 }
8217
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008218 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008219 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8220 return PSA_ERROR_BAD_STATE;
8221 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008222 }
8223
Przemek Stekiel18620a32023-01-17 16:34:52 +01008224 /* Clear driver context */
8225 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8226
8227 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008228
8229 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008230 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008231
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008232 /* User and peer are translated to role. */
8233 mbedtls_free(inputs.user);
8234 mbedtls_free(inputs.peer);
8235
Przemek Stekiel2797d372022-12-22 11:19:22 +01008236 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008237#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008238 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008239 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008240 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008241#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008242 {
8243 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008244 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008245 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008246 return status;
8247}
8248
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008249#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008250static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008251 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008252 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008253 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008254{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008255 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8256 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8257 step != PSA_PAKE_STEP_ZK_PROOF) {
8258 return PSA_ERROR_INVALID_ARGUMENT;
8259 }
8260
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008261 psa_jpake_computation_stage_t *computation_stage =
8262 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008263
David Horstmann5da95602023-06-08 15:37:12 +01008264 if (computation_stage->round != PSA_JPAKE_FIRST &&
8265 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008266 return PSA_ERROR_BAD_STATE;
8267 }
8268
David Horstmanne7f21e62023-05-12 18:17:21 +01008269 /* Check that the step we are given is the one we were expecting */
8270 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008271 return PSA_ERROR_BAD_STATE;
8272 }
8273
David Horstmanne7f21e62023-05-12 18:17:21 +01008274 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8275 computation_stage->inputs == 0 &&
8276 computation_stage->outputs == 0) {
8277 /* Start of the round, so function decides whether we are inputting
8278 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008279 computation_stage->io_mode = io_mode;
8280 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008281 /* Middle of the round so the mode we are in must match the function
8282 * called by the user */
8283 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008284 }
8285
8286 return PSA_SUCCESS;
8287}
8288
David Horstmanne7f21e62023-05-12 18:17:21 +01008289static psa_status_t psa_jpake_epilogue(
8290 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008291 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008292{
David Horstmanne7f21e62023-05-12 18:17:21 +01008293 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008294 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008295
David Horstmanne7f21e62023-05-12 18:17:21 +01008296 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8297 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008298 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008299 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008300 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008301 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008302 }
8303 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008304 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008305 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008306 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008307 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008308 }
8309 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008310 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8311 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008312 /* End of a round, move to the next round */
8313 stage->inputs = 0;
8314 stage->outputs = 0;
8315 stage->round++;
8316 }
8317 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008318 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008319 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008320 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008321 return PSA_SUCCESS;
8322}
David Horstmanne7f21e62023-05-12 18:17:21 +01008323
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008324#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008325
Neil Armstronga7d08c32022-06-01 18:21:20 +02008326psa_status_t psa_pake_output(
8327 psa_pake_operation_t *operation,
8328 psa_pake_step_t step,
8329 uint8_t *output,
8330 size_t output_size,
8331 size_t *output_length)
8332{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008333 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008334 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008335 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008336
8337 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008338 status = psa_pake_complete_inputs(operation);
8339 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008340 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008341 }
8342 }
8343
8344 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008345 status = PSA_ERROR_BAD_STATE;
8346 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008347 }
8348
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008349 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008350 status = PSA_ERROR_INVALID_ARGUMENT;
8351 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008352 }
8353
Przemek Stekiele12ed362022-12-21 12:54:46 +01008354 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008355#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008356 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008357 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008358 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008359 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008360 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008361 driver_step = convert_jpake_computation_stage_to_driver_step(
8362 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008363 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008364#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008365 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008366 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008367 status = PSA_ERROR_NOT_SUPPORTED;
8368 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008369 }
8370
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008371 status = psa_driver_wrapper_pake_output(operation, driver_step,
8372 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008373
8374 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008375 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008376 }
8377
8378 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008379#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008380 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008381 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008382 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008383 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008384 }
8385 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008386#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008387 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008388 status = PSA_ERROR_NOT_SUPPORTED;
8389 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008390 }
8391
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008392 return PSA_SUCCESS;
8393exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008394 psa_pake_abort(operation);
8395 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008396}
8397
8398psa_status_t psa_pake_input(
8399 psa_pake_operation_t *operation,
8400 psa_pake_step_t step,
8401 const uint8_t *input,
8402 size_t input_length)
8403{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008404 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008405 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008406 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8407 operation->primitive,
8408 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008409
8410 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008411 status = psa_pake_complete_inputs(operation);
8412 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008413 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008414 }
8415 }
8416
8417 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008418 status = PSA_ERROR_BAD_STATE;
8419 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008420 }
8421
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008422 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008423 status = PSA_ERROR_INVALID_ARGUMENT;
8424 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008425 }
8426
Przemek Stekiele12ed362022-12-21 12:54:46 +01008427 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008428#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008429 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008430 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008431 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008432 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008433 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008434 driver_step = convert_jpake_computation_stage_to_driver_step(
8435 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008436 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008437#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008438 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008439 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008440 status = PSA_ERROR_NOT_SUPPORTED;
8441 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008442 }
8443
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008444 status = psa_driver_wrapper_pake_input(operation, driver_step,
8445 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008446
8447 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008448 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008449 }
8450
8451 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008452#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008453 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008454 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008455 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008456 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008457 }
8458 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008459#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008460 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008461 status = PSA_ERROR_NOT_SUPPORTED;
8462 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008463 }
8464
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008465 return PSA_SUCCESS;
8466exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008467 psa_pake_abort(operation);
8468 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008469}
8470
8471psa_status_t psa_pake_get_implicit_key(
8472 psa_pake_operation_t *operation,
8473 psa_key_derivation_operation_t *output)
8474{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008475 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008476 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008477 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008478 size_t shared_key_len = 0;
8479
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008480 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008481 status = PSA_ERROR_BAD_STATE;
8482 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008483 }
8484
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008485#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008486 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008487 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008488 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008489 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008490 status = PSA_ERROR_BAD_STATE;
8491 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008492 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008493 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008494#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008495 {
8496 status = PSA_ERROR_NOT_SUPPORTED;
8497 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008498 }
8499
Przemek Stekiel0c781802022-11-29 14:53:13 +01008500 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8501 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008502 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008503 &shared_key_len);
8504
8505 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008506 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008507 }
8508
8509 status = psa_key_derivation_input_bytes(output,
8510 PSA_KEY_DERIVATION_INPUT_SECRET,
8511 shared_key,
8512 shared_key_len);
8513
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008514 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008515exit:
8516 abort_status = psa_pake_abort(operation);
8517 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008518}
8519
8520psa_status_t psa_pake_abort(
8521 psa_pake_operation_t *operation)
8522{
Przemek Stekield69dca92023-01-31 19:59:20 +01008523 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008524
Przemek Stekield69dca92023-01-31 19:59:20 +01008525 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008526 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008527 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008528
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008529 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8530 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008531 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008532 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008533 }
8534 if (operation->data.inputs.user != NULL) {
8535 mbedtls_free(operation->data.inputs.user);
8536 }
8537 if (operation->data.inputs.peer != NULL) {
8538 mbedtls_free(operation->data.inputs.peer);
8539 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008540 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008541 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008542
Przemek Stekield69dca92023-01-31 19:59:20 +01008543 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008544}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008545#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008546
David Horstmann00d7a042023-12-07 18:39:17 +00008547/* Memory copying test hooks. These are called before input copy, after input
8548 * copy, before output copy and after output copy, respectively.
8549 * They are used by memory-poisoning tests to temporarily unpoison buffers
8550 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008551#if defined(MBEDTLS_TEST_HOOKS)
8552void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8553void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8554void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8555void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8556#endif
David Horstmannfde97392023-10-30 20:29:43 +00008557
David Horstmann1b7279a2023-11-15 15:18:30 +00008558/** Copy from an input buffer to a local copy.
8559 *
8560 * \param[in] input Pointer to input buffer.
8561 * \param[in] input_len Length of the input buffer.
8562 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8563 * \param[out] input_copy_len Length of the local copy buffer.
8564 * \return #PSA_SUCCESS, if the buffer was successfully
8565 * copied.
8566 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8567 * copy is too small to hold contents of the
8568 * input buffer.
8569 */
8570MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008571psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8572 uint8_t *input_copy, size_t input_copy_len)
8573{
8574 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008575 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008576 }
8577
David Horstmann372b8bb2023-11-24 16:21:04 +00008578#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008579 if (psa_input_pre_copy_hook != NULL) {
8580 psa_input_pre_copy_hook(input, input_len);
8581 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008582#endif
8583
David Horstmann777e7412023-11-15 17:33:47 +00008584 if (input_len > 0) {
8585 memcpy(input_copy, input, input_len);
8586 }
David Horstmannfde97392023-10-30 20:29:43 +00008587
David Horstmann372b8bb2023-11-24 16:21:04 +00008588#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008589 if (psa_input_post_copy_hook != NULL) {
8590 psa_input_post_copy_hook(input, input_len);
8591 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008592#endif
8593
David Horstmannfde97392023-10-30 20:29:43 +00008594 return PSA_SUCCESS;
8595}
8596
David Horstmann1b7279a2023-11-15 15:18:30 +00008597/** Copy from a local output buffer into a user-supplied one.
8598 *
8599 * \param[in] output_copy Pointer to a local buffer containing the output.
8600 * \param[in] output_copy_len Length of the local buffer.
8601 * \param[out] output Pointer to user-supplied output buffer.
8602 * \param[out] output_len Length of the user-supplied output buffer.
8603 * \return #PSA_SUCCESS, if the buffer was successfully
8604 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008605 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008606 * user-supplied output buffer is too small to
8607 * hold the contents of the local buffer.
8608 */
8609MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008610psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8611 uint8_t *output, size_t output_len)
8612{
8613 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008614 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008615 }
David Horstmann777e7412023-11-15 17:33:47 +00008616
David Horstmann372b8bb2023-11-24 16:21:04 +00008617#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008618 if (psa_output_pre_copy_hook != NULL) {
8619 psa_output_pre_copy_hook(output, output_len);
8620 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008621#endif
8622
David Horstmann777e7412023-11-15 17:33:47 +00008623 if (output_copy_len > 0) {
8624 memcpy(output, output_copy, output_copy_len);
8625 }
8626
David Horstmann372b8bb2023-11-24 16:21:04 +00008627#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008628 if (psa_output_post_copy_hook != NULL) {
8629 psa_output_post_copy_hook(output, output_len);
8630 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008631#endif
8632
David Horstmann8978f5c2023-10-30 20:37:12 +00008633 return PSA_SUCCESS;
8634}
8635
David Horstmannf1734052023-11-20 17:15:32 +00008636psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8637 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008638{
8639 psa_status_t status;
8640
David Horstmann9db14482023-11-23 15:50:37 +00008641 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008642
David Horstmannc5cc1c32023-11-15 18:11:26 +00008643 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008644 return PSA_SUCCESS;
8645 }
8646
David Horstmannf1734052023-11-20 17:15:32 +00008647 local_input->buffer = mbedtls_calloc(input_len, 1);
8648 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008649 /* Since we dealt with the zero-length case above, we know that
8650 * a NULL return value means a failure of allocation. */
8651 return PSA_ERROR_INSUFFICIENT_MEMORY;
8652 }
David Horstmannf1734052023-11-20 17:15:32 +00008653 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008654
David Horstmannf1734052023-11-20 17:15:32 +00008655 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008656
8657 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008658 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008659 if (status != PSA_SUCCESS) {
8660 goto error;
8661 }
8662
8663 return PSA_SUCCESS;
8664
8665error:
David Horstmannf1734052023-11-20 17:15:32 +00008666 mbedtls_free(local_input->buffer);
8667 local_input->buffer = NULL;
8668 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008669 return status;
8670}
8671
David Horstmannf1734052023-11-20 17:15:32 +00008672void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008673{
David Horstmannf1734052023-11-20 17:15:32 +00008674 mbedtls_free(local_input->buffer);
8675 local_input->buffer = NULL;
8676 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008677}
8678
David Horstmann89875a42023-11-20 12:54:09 +00008679psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8680 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008681{
David Horstmann9db14482023-11-23 15:50:37 +00008682 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008683
David Horstmannc5cc1c32023-11-15 18:11:26 +00008684 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008685 return PSA_SUCCESS;
8686 }
David Horstmann89875a42023-11-20 12:54:09 +00008687 local_output->buffer = mbedtls_calloc(output_len, 1);
8688 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008689 /* Since we dealt with the zero-length case above, we know that
8690 * a NULL return value means a failure of allocation. */
8691 return PSA_ERROR_INSUFFICIENT_MEMORY;
8692 }
David Horstmann89875a42023-11-20 12:54:09 +00008693 local_output->length = output_len;
8694 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008695
8696 return PSA_SUCCESS;
8697}
8698
Gabor Mezei1882c512024-01-24 13:07:17 +01008699psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8700 psa_crypto_local_output_t *local_output)
8701{
8702 psa_status_t status;
8703 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8704
8705 if (output_len == 0) {
8706 return PSA_SUCCESS;
8707 }
8708 local_output->buffer = mbedtls_calloc(output_len, 1);
8709 if (local_output->buffer == NULL) {
8710 /* Since we dealt with the zero-length case above, we know that
8711 * a NULL return value means a failure of allocation. */
8712 return PSA_ERROR_INSUFFICIENT_MEMORY;
8713 }
8714 local_output->length = output_len;
8715 local_output->original = output;
8716
8717 status = psa_crypto_copy_input(output, output_len,
8718 local_output->buffer, local_output->length);
8719 if (status != PSA_SUCCESS) {
8720 goto error;
8721 }
8722
8723 return PSA_SUCCESS;
8724
8725error:
8726 mbedtls_free(local_output->buffer);
8727 local_output->buffer = NULL;
8728 local_output->length = 0;
8729 return status;
8730}
8731
David Horstmann89875a42023-11-20 12:54:09 +00008732psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008733{
David Horstmannc335a4e2023-11-15 15:57:32 +00008734 psa_status_t status;
8735
David Horstmann89875a42023-11-20 12:54:09 +00008736 if (local_output->buffer == NULL) {
8737 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008738 return PSA_SUCCESS;
8739 }
David Horstmann89875a42023-11-20 12:54:09 +00008740 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008741 /* We have an internal copy but nothing to copy back to. */
8742 return PSA_ERROR_CORRUPTION_DETECTED;
8743 }
8744
David Horstmann89875a42023-11-20 12:54:09 +00008745 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8746 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008747 if (status != PSA_SUCCESS) {
8748 return status;
8749 }
David Horstmann9467ea32023-11-08 17:44:18 +00008750
David Horstmann89875a42023-11-20 12:54:09 +00008751 mbedtls_free(local_output->buffer);
8752 local_output->buffer = NULL;
8753 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008754
8755 return PSA_SUCCESS;
8756}
8757
Gilles Peskinee59236f2018-01-27 23:32:46 +01008758#endif /* MBEDTLS_PSA_CRYPTO_C */