blob: eab5aa5528fc80805b4b96615fab7e69a79d7ba1 [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 Daubney31d8c0b2024-01-18 15:26:59 +00002398static psa_status_t psa_hash_finish_internal(psa_hash_operation_t *operation,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002399 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
Thomas Daubneydedd1002024-01-25 16:52:50 +00002428#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002429exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002430#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002431 LOCAL_OUTPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002433}
2434
Gilles Peskine449bd832023-01-11 14:50:10 +01002435psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002436 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002438{
Ronald Cron69a63422021-10-18 09:47:58 +02002439 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002440 size_t actual_hash_length;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002441 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2442 LOCAL_INPUT_DECLARE(hash_external, hash);
2443
2444 status = psa_hash_finish_internal(
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 operation,
2446 actual_hash, sizeof(actual_hash),
2447 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002448
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002450 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002454 status = PSA_ERROR_INVALID_SIGNATURE;
2455 goto exit;
2456 }
2457
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002458 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002459 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002460 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002462
2463exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2465 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002466 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 }
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002468 LOCAL_INPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002470}
2471
Gilles Peskine449bd832023-01-11 14:50:10 +01002472psa_status_t psa_hash_compute(psa_algorithm_t alg,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002473 const uint8_t *input_external, size_t input_length,
2474 uint8_t *hash_external, size_t hash_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002476{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002477 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2478 LOCAL_INPUT_DECLARE(input_external, input);
2479 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2480
Steven Cooremanfbe09282021-03-08 18:41:12 +01002481 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 if (!PSA_ALG_IS_HASH(alg)) {
2483 return PSA_ERROR_INVALID_ARGUMENT;
2484 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002485
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002486 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2487 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2488 status = psa_driver_wrapper_hash_compute(alg, input, input_length,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002489 hash, hash_size, hash_length);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002490
Thomas Daubneydedd1002024-01-25 16:52:50 +00002491#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002492exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002493#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002494 LOCAL_INPUT_FREE(input_external, input);
2495 LOCAL_OUTPUT_FREE(hash_external, hash);
2496 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002497}
2498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499psa_status_t psa_hash_compare(psa_algorithm_t alg,
Thomas Daubney51ffac92024-01-18 15:46:26 +00002500 const uint8_t *input_external, size_t input_length,
2501 const uint8_t *hash_external, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002502{
Ronald Cron69a63422021-10-18 09:47:58 +02002503 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002504 size_t actual_hash_length;
Thomas Daubney51ffac92024-01-18 15:46:26 +00002505 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2506
2507 LOCAL_INPUT_DECLARE(input_external, input);
2508 LOCAL_INPUT_DECLARE(hash_external, hash);
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002509
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 if (!PSA_ALG_IS_HASH(alg)) {
Thomas Daubney51ffac92024-01-18 15:46:26 +00002511 status = PSA_ERROR_INVALID_ARGUMENT;
2512 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002514
Thomas Daubney51ffac92024-01-18 15:46:26 +00002515 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2516 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 alg, input, input_length,
2518 actual_hash, sizeof(actual_hash),
2519 &actual_hash_length);
2520 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002521 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 }
2523 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002524 status = PSA_ERROR_INVALID_SIGNATURE;
2525 goto exit;
2526 }
Thomas Daubney51ffac92024-01-18 15:46:26 +00002527
2528 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002529 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002530 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002532
2533exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
Thomas Daubney51ffac92024-01-18 15:46:26 +00002535
2536 LOCAL_INPUT_FREE(input_external, input);
2537 LOCAL_INPUT_FREE(hash_external, hash);
2538
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002540}
2541
Gilles Peskine449bd832023-01-11 14:50:10 +01002542psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2543 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002544{
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 if (source_operation->id == 0 ||
2546 target_operation->id != 0) {
2547 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002548 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2551 target_operation);
2552 if (status != PSA_SUCCESS) {
2553 psa_hash_abort(target_operation);
2554 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002557}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002558
2559
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002560/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002561/* MAC */
2562/****************************************************************/
2563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002565{
Steven Cooremane6804192021-03-19 18:28:56 +01002566 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 if (operation->id == 0) {
2568 return PSA_SUCCESS;
2569 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002570
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002572 operation->mac_size = 0;
2573 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002574 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002577}
2578
Ronald Cron2dff3b22021-06-17 16:33:22 +02002579static psa_status_t psa_mac_finalize_alg_and_key_validation(
2580 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002581 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002583{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002584 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 psa_key_type_t key_type = psa_get_key_type(attributes);
2586 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 if (!PSA_ALG_IS_MAC(alg)) {
2589 return PSA_ERROR_INVALID_ARGUMENT;
2590 }
Steven Cooremane6804192021-03-19 18:28:56 +01002591
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002592 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 status = psa_mac_key_can_do(alg, key_type);
2594 if (status != PSA_SUCCESS) {
2595 return status;
2596 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002597
Steven Cooremand1a68f12021-05-10 11:13:41 +02002598 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002602 /* A very short MAC is too short for security since it can be
2603 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2604 * so we make this our minimum, even though 32 bits is still
2605 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002607 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2610 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002611 /* It's impossible to "truncate" to a larger length than the full length
2612 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002614 }
2615
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002617 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2618 * that is disabled in the compile-time configuration. The result can
2619 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2620 * configuration into account. In this case, force a return of
2621 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2622 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2623 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2624 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2625 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002627 }
2628
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002630}
2631
Gilles Peskine449bd832023-01-11 14:50:10 +01002632static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2633 mbedtls_svc_key_id_t key,
2634 psa_algorithm_t alg,
2635 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002636{
2637 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2638 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002639 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002640 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002641
2642 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002644 status = PSA_ERROR_BAD_STATE;
2645 goto exit;
2646 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002647
2648 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 key,
2650 &slot,
2651 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2652 alg);
2653 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002654 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002656
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002657 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002658 .core = slot->attr
2659 };
2660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2662 &operation->mac_size);
2663 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002664 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002666
2667 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002668 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 if (is_sign) {
2670 status = psa_driver_wrapper_mac_sign_setup(operation,
2671 &attributes,
2672 slot->key.data,
2673 slot->key.bytes,
2674 alg);
2675 } else {
2676 status = psa_driver_wrapper_mac_verify_setup(operation,
2677 &attributes,
2678 slot->key.data,
2679 slot->key.bytes,
2680 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002681 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002682
Gilles Peskinefbfac682018-07-08 20:51:54 +02002683exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 if (status != PSA_SUCCESS) {
2685 psa_mac_abort(operation);
2686 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002687
Ryan Everett1b70a072024-01-04 10:32:49 +00002688 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002691}
2692
Gilles Peskine449bd832023-01-11 14:50:10 +01002693psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2694 mbedtls_svc_key_id_t key,
2695 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002696{
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002698}
2699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2701 mbedtls_svc_key_id_t key,
2702 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002703{
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002705}
2706
Gilles Peskine449bd832023-01-11 14:50:10 +01002707psa_status_t psa_mac_update(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002708 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002710{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002711 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2712 LOCAL_INPUT_DECLARE(input_external, input);
2713
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 if (operation->id == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002715 status = PSA_ERROR_BAD_STATE;
2716 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002718
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002719 /* Don't require hash implementations to behave correctly on a
2720 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 if (input_length == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002722 status = PSA_SUCCESS;
2723 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002725
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002726 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2727 status = psa_driver_wrapper_mac_update(operation, input, input_length);
2728
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 if (status != PSA_SUCCESS) {
2730 psa_mac_abort(operation);
2731 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002732
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002733#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002734exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002735#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002736 LOCAL_INPUT_FREE(input_external, input);
2737
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002739}
2740
Gilles Peskine449bd832023-01-11 14:50:10 +01002741psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002742 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 size_t mac_size,
2744 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002745{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002746 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2747 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002748 LOCAL_OUTPUT_DECLARE(mac_external, mac);
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002749 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002750
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002752 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002753 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002754 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002755
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002757 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002758 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002759 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002760
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002761 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2762 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002763 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002764 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002765 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002766 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002767
Gilles Peskine449bd832023-01-11 14:50:10 +01002768 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002769 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002770 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002771 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002772
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002773
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 status = psa_driver_wrapper_mac_sign_finish(operation,
2775 mac, operation->mac_size,
2776 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002777
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002778exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002779 /* In case of success, set the potential excess room in the output buffer
2780 * to an invalid value, to avoid potentially leaking a longer MAC.
2781 * In case of error, set the output length and content to a safe default,
2782 * such that in case the caller misses an error check, the output would be
2783 * an unachievable MAC.
2784 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002786 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002787 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002788 }
mohammad16036df908f2018-04-02 08:34:15 -07002789
Thomas Daubney03f1ea32024-02-01 16:16:27 +00002790 if (mac != NULL) {
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002791 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
2792 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002795 LOCAL_OUTPUT_FREE(mac_external, mac);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002798}
2799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002801 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002803{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002804 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2805 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002806 LOCAL_INPUT_DECLARE(mac_external, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002807
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002809 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002810 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002811 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002812
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002814 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002815 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002816 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002817
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002819 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002820 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002821 }
2822
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002823 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 status = psa_driver_wrapper_mac_verify_finish(operation,
2825 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002826
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002827exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002829 LOCAL_INPUT_FREE(mac_external, mac);
mohammad16036df908f2018-04-02 08:34:15 -07002830
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002832}
2833
Gilles Peskine449bd832023-01-11 14:50:10 +01002834static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2835 psa_algorithm_t alg,
2836 const uint8_t *input,
2837 size_t input_length,
2838 uint8_t *mac,
2839 size_t mac_size,
2840 size_t *mac_length,
2841 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002842{
2843 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002844 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2845 psa_key_slot_t *slot;
2846 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002847 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002848
Ronald Cron51131b52021-06-17 17:17:20 +02002849 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 key,
2851 &slot,
2852 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2853 alg);
2854 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002855 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002857
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002858 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002859 .core = slot->attr
2860 };
2861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2863 &operation_mac_size);
2864 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002865 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002869 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002870 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002871 }
2872
2873 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 &attributes,
2875 slot->key.data, slot->key.bytes,
2876 alg,
2877 input, input_length,
2878 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002879
2880exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002881 /* In case of success, set the potential excess room in the output buffer
2882 * to an invalid value, to avoid potentially leaking a longer MAC.
2883 * In case of error, set the output length and content to a safe default,
2884 * such that in case the caller misses an error check, the output would be
2885 * an unachievable MAC.
2886 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002888 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002889 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002890 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002891
2892 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002893
Ryan Everett1b70a072024-01-04 10:32:49 +00002894 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002895
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002897}
2898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002900 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002901 const uint8_t *input_external,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002902 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002903 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 size_t mac_size,
2905 size_t *mac_length)
2906{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002907 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2908 LOCAL_INPUT_DECLARE(input_external, input);
2909 LOCAL_OUTPUT_DECLARE(mac_external, mac);
2910
2911 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2912 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
2913 status = psa_mac_compute_internal(key, alg,
Thomas Daubney7480a742024-01-30 11:29:47 +00002914 input, input_length,
2915 mac, mac_size, mac_length, 1);
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002916
2917#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002918exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002919#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002920 LOCAL_INPUT_FREE(input_external, input);
2921 LOCAL_OUTPUT_FREE(mac_external, mac);
2922
2923 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002924}
2925
2926psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2927 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002928 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002930 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002932{
2933 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002934 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2935 size_t actual_mac_length;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002936 LOCAL_INPUT_DECLARE(input_external, input);
2937 LOCAL_INPUT_DECLARE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002938
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002939 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 status = psa_mac_compute_internal(key, alg,
2941 input, input_length,
2942 actual_mac, sizeof(actual_mac),
2943 &actual_mac_length, 0);
2944 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002945 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002946 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002947
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002949 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002950 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002951 }
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002952
2953 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Dave Rodgman78701152023-08-29 14:20:18 +01002954 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002955 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002956 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002957 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002958
2959exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002961 LOCAL_INPUT_FREE(input_external, input);
2962 LOCAL_INPUT_FREE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002963
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002965}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002966
Gilles Peskinee59236f2018-01-27 23:32:46 +01002967/****************************************************************/
2968/* Asymmetric cryptography */
2969/****************************************************************/
2970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2972 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002973{
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 if (input_is_message) {
2975 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2976 return PSA_ERROR_INVALID_ARGUMENT;
2977 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002978
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2980 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2981 return PSA_ERROR_INVALID_ARGUMENT;
2982 }
2983 }
2984 } else {
2985 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2986 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002987 }
2988 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002989
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002991}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002992
Gilles Peskine449bd832023-01-11 14:50:10 +01002993static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2994 int input_is_message,
2995 psa_algorithm_t alg,
2996 const uint8_t *input,
2997 size_t input_length,
2998 uint8_t *signature,
2999 size_t signature_size,
3000 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003001{
3002 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3003 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3004 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003005 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003006
3007 *signature_length = 0;
3008
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 status = psa_sign_verify_check_alg(input_is_message, alg);
3010 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003011 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003013
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003014 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02003015 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003016 * buffer can in principle be empty since it doesn't actually have
3017 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 if (signature_size == 0) {
3019 return PSA_ERROR_BUFFER_TOO_SMALL;
3020 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003021
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003022 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 key, &slot,
3024 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
3025 PSA_KEY_USAGE_SIGN_HASH,
3026 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003027
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003029 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003033 status = PSA_ERROR_INVALID_ARGUMENT;
3034 goto exit;
3035 }
3036
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003037 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003039 };
3040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003042 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003043 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003044 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 signature, signature_size, signature_length);
3046 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003047
3048 status = psa_driver_wrapper_sign_hash(
3049 &attributes, slot->key.data, slot->key.bytes,
3050 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003052 }
3053
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003054
3055exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003056 psa_wipe_tag_output_buffer(signature, status, signature_size,
3057 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003058
Ryan Everett1b70a072024-01-04 10:32:49 +00003059 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003062}
3063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3065 int input_is_message,
3066 psa_algorithm_t alg,
3067 const uint8_t *input,
3068 size_t input_length,
3069 const uint8_t *signature,
3070 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003071{
3072 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3073 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3074 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003075
Gilles Peskine449bd832023-01-11 14:50:10 +01003076 status = psa_sign_verify_check_alg(input_is_message, alg);
3077 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003078 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003080
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003081 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 key, &slot,
3083 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3084 PSA_KEY_USAGE_VERIFY_HASH,
3085 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003086
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 if (status != PSA_SUCCESS) {
3088 return status;
3089 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003090
3091 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003093 };
3094
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003096 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003097 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003098 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 signature, signature_length);
3100 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003101 status = psa_driver_wrapper_verify_hash(
3102 &attributes, slot->key.data, slot->key.bytes,
3103 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003105 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003106
Ryan Everett1b70a072024-01-04 10:32:49 +00003107 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003110
3111}
3112
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003113psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003114 const psa_key_attributes_t *attributes,
3115 const uint8_t *key_buffer,
3116 size_t key_buffer_size,
3117 psa_algorithm_t alg,
3118 const uint8_t *input,
3119 size_t input_length,
3120 uint8_t *signature,
3121 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003123{
3124 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003125
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003127 size_t hash_length;
3128 uint8_t hash[PSA_HASH_MAX_SIZE];
3129
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003130 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 PSA_ALG_SIGN_GET_HASH(alg),
3132 input, input_length,
3133 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003134
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003136 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003138
3139 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 attributes, key_buffer, key_buffer_size,
3141 alg, hash, hash_length,
3142 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003143 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003144
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003146}
3147
Gilles Peskine449bd832023-01-11 14:50:10 +01003148psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3149 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003150 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003152 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 size_t signature_size,
3154 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003155{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003156 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3157 LOCAL_INPUT_DECLARE(input_external, input);
3158 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3159
3160 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3161 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3162 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3163 signature_size, signature_length);
3164
Thomas Daubney3e65f522024-01-30 12:37:25 +00003165#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003166exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003167#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003168 LOCAL_INPUT_FREE(input_external, input);
3169 LOCAL_OUTPUT_FREE(signature_external, signature);
3170 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003171}
3172
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003173psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003174 const psa_key_attributes_t *attributes,
3175 const uint8_t *key_buffer,
3176 size_t key_buffer_size,
3177 psa_algorithm_t alg,
3178 const uint8_t *input,
3179 size_t input_length,
3180 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003181 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003182{
3183 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003184
Gilles Peskine449bd832023-01-11 14:50:10 +01003185 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003186 size_t hash_length;
3187 uint8_t hash[PSA_HASH_MAX_SIZE];
3188
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003189 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003190 PSA_ALG_SIGN_GET_HASH(alg),
3191 input, input_length,
3192 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003193
Gilles Peskine449bd832023-01-11 14:50:10 +01003194 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003195 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003196 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003197
3198 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 attributes, key_buffer, key_buffer_size,
3200 alg, hash, hash_length,
3201 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003202 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003203
Gilles Peskine449bd832023-01-11 14:50:10 +01003204 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003205}
3206
Gilles Peskine449bd832023-01-11 14:50:10 +01003207psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3208 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003209 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003211 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003213{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003214 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3215 LOCAL_INPUT_DECLARE(input_external, input);
3216 LOCAL_INPUT_DECLARE(signature_external, signature);
3217
3218 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3219 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3220 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3221 signature_length);
3222
Thomas Daubney3e65f522024-01-30 12:37:25 +00003223#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003224exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003225#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003226 LOCAL_INPUT_FREE(input_external, input);
3227 LOCAL_INPUT_FREE(signature_external, signature);
3228
3229 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003230}
3231
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003232psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003233 const psa_key_attributes_t *attributes,
3234 const uint8_t *key_buffer, size_t key_buffer_size,
3235 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003237{
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3239 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3240 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003241#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3243 return mbedtls_psa_rsa_sign_hash(
3244 attributes,
3245 key_buffer, key_buffer_size,
3246 alg, hash, hash_length,
3247 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003248#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3249 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 } else {
3251 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003252 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3254 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003255#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3257 return mbedtls_psa_ecdsa_sign_hash(
3258 attributes,
3259 key_buffer, key_buffer_size,
3260 alg, hash, hash_length,
3261 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003262#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3263 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003264 } else {
3265 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003266 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003267 }
Ronald Cron4501c982021-03-19 20:09:32 +01003268
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 (void) key_buffer;
3270 (void) key_buffer_size;
3271 (void) hash;
3272 (void) hash_length;
3273 (void) signature;
3274 (void) signature_size;
3275 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003276
Gilles Peskine449bd832023-01-11 14:50:10 +01003277 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003278}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003279
Gilles Peskine449bd832023-01-11 14:50:10 +01003280psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3281 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003282 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003283 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003284 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 size_t signature_size,
3286 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003287{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003288 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3289 LOCAL_INPUT_DECLARE(hash_external, hash);
3290 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3291
3292 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3293 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3294 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3295 signature_size, signature_length);
3296
Thomas Daubney3e65f522024-01-30 12:37:25 +00003297#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003298exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003299#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003300 LOCAL_INPUT_FREE(hash_external, hash);
3301 LOCAL_OUTPUT_FREE(signature_external, signature);
3302
3303 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003304}
3305
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003306psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003307 const psa_key_attributes_t *attributes,
3308 const uint8_t *key_buffer, size_t key_buffer_size,
3309 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003311{
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3313 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3314 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003315#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3317 return mbedtls_psa_rsa_verify_hash(
3318 attributes,
3319 key_buffer, key_buffer_size,
3320 alg, hash, hash_length,
3321 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003322#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3323 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003324 } else {
3325 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003326 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003327 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3328 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003329#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3331 return mbedtls_psa_ecdsa_verify_hash(
3332 attributes,
3333 key_buffer, key_buffer_size,
3334 alg, hash, hash_length,
3335 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003336#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3337 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 } else {
3339 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003340 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003341 }
Ronald Cron4501c982021-03-19 20:09:32 +01003342
Gilles Peskine449bd832023-01-11 14:50:10 +01003343 (void) key_buffer;
3344 (void) key_buffer_size;
3345 (void) hash;
3346 (void) hash_length;
3347 (void) signature;
3348 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003349
Gilles Peskine449bd832023-01-11 14:50:10 +01003350 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003351}
3352
Gilles Peskine449bd832023-01-11 14:50:10 +01003353psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3354 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003355 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003357 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003359{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003360 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3361 LOCAL_INPUT_DECLARE(hash_external, hash);
3362 LOCAL_INPUT_DECLARE(signature_external, signature);
3363
3364 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3365 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3366 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3367 signature_length);
3368
Thomas Daubney3e65f522024-01-30 12:37:25 +00003369#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003370exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003371#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003372 LOCAL_INPUT_FREE(hash_external, hash);
3373 LOCAL_INPUT_FREE(signature_external, signature);
3374
3375 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003376}
3377
Gilles Peskine449bd832023-01-11 14:50:10 +01003378psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3379 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003380 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003381 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003382 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003383 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003384 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003385 size_t output_size,
3386 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003387{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003388 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003389 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003390 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003391 psa_key_attributes_t attributes;
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003392 LOCAL_INPUT_DECLARE(input_external, input);
3393 LOCAL_INPUT_DECLARE(salt_external, salt);
3394 LOCAL_OUTPUT_DECLARE(output_external, output);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003395
Darryl Green5cc689a2018-07-24 15:34:10 +01003396 (void) input;
3397 (void) input_length;
3398 (void) salt;
3399 (void) output;
3400 (void) output_size;
3401
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003402 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003403
Gilles Peskine449bd832023-01-11 14:50:10 +01003404 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3405 return PSA_ERROR_INVALID_ARGUMENT;
3406 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003407
Valerio Setti5bb454a2024-01-15 10:43:16 +01003408 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003409 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3410 if (status != PSA_SUCCESS) {
3411 return status;
3412 }
3413 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3414 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003415 status = PSA_ERROR_INVALID_ARGUMENT;
3416 goto exit;
3417 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003418
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003419 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003421 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003422
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003423 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3424 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3425 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003426 status = psa_driver_wrapper_asymmetric_encrypt(
3427 &attributes, slot->key.data, slot->key.bytes,
3428 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003430exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003431 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003432
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003433 LOCAL_INPUT_FREE(input_external, input);
3434 LOCAL_INPUT_FREE(salt_external, salt);
3435 LOCAL_OUTPUT_FREE(output_external, output);
3436
Gilles Peskine449bd832023-01-11 14:50:10 +01003437 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003438}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003439
Gilles Peskine449bd832023-01-11 14:50:10 +01003440psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3441 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003442 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003443 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003444 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003445 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003446 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003447 size_t output_size,
3448 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003449{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003450 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003451 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003452 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003453 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003454
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003455 LOCAL_INPUT_DECLARE(input_external, input);
3456 LOCAL_INPUT_DECLARE(salt_external, salt);
3457 LOCAL_OUTPUT_DECLARE(output_external, output);
3458
Darryl Green5cc689a2018-07-24 15:34:10 +01003459 (void) input;
3460 (void) input_length;
3461 (void) salt;
3462 (void) output;
3463 (void) output_size;
3464
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003465 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003466
Gilles Peskine449bd832023-01-11 14:50:10 +01003467 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3468 return PSA_ERROR_INVALID_ARGUMENT;
3469 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003470
Valerio Setti5bb454a2024-01-15 10:43:16 +01003471 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003472 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3473 if (status != PSA_SUCCESS) {
3474 return status;
3475 }
3476 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003477 status = PSA_ERROR_INVALID_ARGUMENT;
3478 goto exit;
3479 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003480
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003481 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003482 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003483 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003484
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003485 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3486 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3487 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003488 status = psa_driver_wrapper_asymmetric_decrypt(
3489 &attributes, slot->key.data, slot->key.bytes,
3490 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003491 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003492
3493exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003494 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003495
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003496 LOCAL_INPUT_FREE(input_external, input);
3497 LOCAL_INPUT_FREE(salt_external, salt);
3498 LOCAL_OUTPUT_FREE(output_external, output);
3499
Gilles Peskine449bd832023-01-11 14:50:10 +01003500 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003501}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003502
Paul Elliott9fe12f62022-11-30 19:16:02 +00003503/****************************************************************/
3504/* Asymmetric interruptible cryptography */
3505/****************************************************************/
3506
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003507static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3508
Paul Elliott9fe12f62022-11-30 19:16:02 +00003509void psa_interruptible_set_max_ops(uint32_t max_ops)
3510{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003511 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003512}
3513
3514uint32_t psa_interruptible_get_max_ops(void)
3515{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003516 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003517}
3518
Paul Elliott9fe12f62022-11-30 19:16:02 +00003519uint32_t psa_sign_hash_get_num_ops(
3520 const psa_sign_hash_interruptible_operation_t *operation)
3521{
Paul Elliott296ede92022-12-15 17:00:30 +00003522 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003523}
3524
3525uint32_t psa_verify_hash_get_num_ops(
3526 const psa_verify_hash_interruptible_operation_t *operation)
3527{
Paul Elliott296ede92022-12-15 17:00:30 +00003528 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003529}
3530
Paul Elliott59ad9452022-12-18 15:09:02 +00003531static psa_status_t psa_sign_hash_abort_internal(
3532 psa_sign_hash_interruptible_operation_t *operation)
3533{
3534 if (operation->id == 0) {
3535 /* The object has (apparently) been initialized but it is not (yet)
3536 * in use. It's ok to call abort on such an object, and there's
3537 * nothing to do. */
3538 return PSA_SUCCESS;
3539 }
3540
3541 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3542
3543 status = psa_driver_wrapper_sign_hash_abort(operation);
3544
3545 operation->id = 0;
3546
Paul Elliotte6145dc2023-02-07 12:51:21 +00003547 /* Do not clear either the error_occurred or num_ops elements here as they
3548 * only want to be cleared by the application calling abort, not by abort
3549 * being called at completion of an operation. */
3550
Paul Elliott59ad9452022-12-18 15:09:02 +00003551 return status;
3552}
3553
Paul Elliott9fe12f62022-11-30 19:16:02 +00003554psa_status_t psa_sign_hash_start(
3555 psa_sign_hash_interruptible_operation_t *operation,
3556 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3557 const uint8_t *hash, size_t hash_length)
3558{
3559 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3560 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3561 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003562 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003563
Paul Elliottc9774412023-02-06 15:14:07 +00003564 /* Check that start has not been previously called, or operation has not
3565 * previously errored. */
3566 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003567 return PSA_ERROR_BAD_STATE;
3568 }
3569
Paul Elliott9fe12f62022-11-30 19:16:02 +00003570 status = psa_sign_verify_check_alg(0, alg);
3571 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003572 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003573 return status;
3574 }
3575
3576 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3577 PSA_KEY_USAGE_SIGN_HASH,
3578 alg);
3579
3580 if (status != PSA_SUCCESS) {
3581 goto exit;
3582 }
3583
3584 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3585 status = PSA_ERROR_INVALID_ARGUMENT;
3586 goto exit;
3587 }
3588
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003589 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003590 .core = slot->attr
3591 };
3592
Paul Elliott296ede92022-12-15 17:00:30 +00003593 /* Ensure ops count gets reset, in case of operation re-use. */
3594 operation->num_ops = 0;
3595
Paul Elliott9fe12f62022-11-30 19:16:02 +00003596 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3597 slot->key.data,
3598 slot->key.bytes, alg,
3599 hash, hash_length);
3600exit:
3601
3602 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003603 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003604 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003605 }
3606
Ryan Everett1b70a072024-01-04 10:32:49 +00003607 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003608
Paul Elliottc9774412023-02-06 15:14:07 +00003609 if (unlock_status != PSA_SUCCESS) {
3610 operation->error_occurred = 1;
3611 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003612
Paul Elliottc9774412023-02-06 15:14:07 +00003613 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003614}
3615
3616
3617psa_status_t psa_sign_hash_complete(
3618 psa_sign_hash_interruptible_operation_t *operation,
3619 uint8_t *signature, size_t signature_size,
3620 size_t *signature_length)
3621{
3622 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3623
3624 *signature_length = 0;
3625
Paul Elliottc9774412023-02-06 15:14:07 +00003626 /* Check that start has been called first, and that operation has not
3627 * previously errored. */
3628 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003629 status = PSA_ERROR_BAD_STATE;
3630 goto exit;
3631 }
3632
Paul Elliott096abc42023-02-03 18:33:23 +00003633 /* Immediately reject a zero-length signature buffer. This guarantees that
3634 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003635 if (signature_size == 0) {
3636 status = PSA_ERROR_BUFFER_TOO_SMALL;
3637 goto exit;
3638 }
3639
3640 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3641 signature_size,
3642 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003643
Paul Elliott296ede92022-12-15 17:00:30 +00003644 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003645 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003646
Paul Elliottebe225c2023-02-10 14:32:53 +00003647exit:
3648
Paul Elliott59200a22023-02-21 15:07:40 +00003649 psa_wipe_tag_output_buffer(signature, status, signature_size,
3650 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003651
Paul Elliott53bb3122023-02-10 14:22:22 +00003652 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003653 if (status != PSA_SUCCESS) {
3654 operation->error_occurred = 1;
3655 }
3656
Paul Elliott59ad9452022-12-18 15:09:02 +00003657 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003658 }
3659
3660 return status;
3661}
3662
3663psa_status_t psa_sign_hash_abort(
3664 psa_sign_hash_interruptible_operation_t *operation)
3665{
Paul Elliott59ad9452022-12-18 15:09:02 +00003666 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3667
3668 status = psa_sign_hash_abort_internal(operation);
3669
3670 /* We clear the number of ops done here, so that it is not cleared when
3671 * the operation fails or succeeds, only on manual abort. */
3672 operation->num_ops = 0;
3673
Paul Elliottc9774412023-02-06 15:14:07 +00003674 /* Likewise, failure state. */
3675 operation->error_occurred = 0;
3676
Paul Elliott59ad9452022-12-18 15:09:02 +00003677 return status;
3678}
3679
3680static psa_status_t psa_verify_hash_abort_internal(
3681 psa_verify_hash_interruptible_operation_t *operation)
3682{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003683 if (operation->id == 0) {
3684 /* The object has (apparently) been initialized but it is not (yet)
3685 * in use. It's ok to call abort on such an object, and there's
3686 * nothing to do. */
3687 return PSA_SUCCESS;
3688 }
3689
Paul Elliott59ad9452022-12-18 15:09:02 +00003690 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3691
3692 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003693
3694 operation->id = 0;
3695
Paul Elliotte6145dc2023-02-07 12:51:21 +00003696 /* Do not clear either the error_occurred or num_ops elements here as they
3697 * only want to be cleared by the application calling abort, not by abort
3698 * being called at completion of an operation. */
3699
Paul Elliott59ad9452022-12-18 15:09:02 +00003700 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003701}
3702
3703psa_status_t psa_verify_hash_start(
3704 psa_verify_hash_interruptible_operation_t *operation,
3705 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3706 const uint8_t *hash, size_t hash_length,
3707 const uint8_t *signature, size_t signature_length)
3708{
3709 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3710 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3711 psa_key_slot_t *slot;
3712
Paul Elliottc9774412023-02-06 15:14:07 +00003713 /* Check that start has not been previously called, or operation has not
3714 * previously errored. */
3715 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003716 return PSA_ERROR_BAD_STATE;
3717 }
3718
3719 status = psa_sign_verify_check_alg(0, alg);
3720 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003721 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003722 return status;
3723 }
3724
3725 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3726 PSA_KEY_USAGE_VERIFY_HASH,
3727 alg);
3728
3729 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003730 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003731 return status;
3732 }
3733
3734 psa_key_attributes_t attributes = {
3735 .core = slot->attr
3736 };
3737
Paul Elliott296ede92022-12-15 17:00:30 +00003738 /* Ensure ops count gets reset, in case of operation re-use. */
3739 operation->num_ops = 0;
3740
Paul Elliott9fe12f62022-11-30 19:16:02 +00003741 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3742 slot->key.data,
3743 slot->key.bytes,
3744 alg, hash, hash_length,
3745 signature, signature_length);
3746
3747 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003748 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003749 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003750 }
3751
Ryan Everett1b70a072024-01-04 10:32:49 +00003752 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003753
Paul Elliottc9774412023-02-06 15:14:07 +00003754 if (unlock_status != PSA_SUCCESS) {
3755 operation->error_occurred = 1;
3756 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003757
Paul Elliottc9774412023-02-06 15:14:07 +00003758 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003759}
3760
3761psa_status_t psa_verify_hash_complete(
3762 psa_verify_hash_interruptible_operation_t *operation)
3763{
3764 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3765
Paul Elliottc9774412023-02-06 15:14:07 +00003766 /* Check that start has been called first, and that operation has not
3767 * previously errored. */
3768 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003769 status = PSA_ERROR_BAD_STATE;
3770 goto exit;
3771 }
3772
3773 status = psa_driver_wrapper_verify_hash_complete(operation);
3774
Paul Elliott296ede92022-12-15 17:00:30 +00003775 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003776 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003777 operation);
3778
Paul Elliottebe225c2023-02-10 14:32:53 +00003779exit:
3780
Paul Elliott9fe12f62022-11-30 19:16:02 +00003781 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003782 if (status != PSA_SUCCESS) {
3783 operation->error_occurred = 1;
3784 }
3785
Paul Elliott59ad9452022-12-18 15:09:02 +00003786 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003787 }
3788
3789 return status;
3790}
3791
3792psa_status_t psa_verify_hash_abort(
3793 psa_verify_hash_interruptible_operation_t *operation)
3794{
Paul Elliott59ad9452022-12-18 15:09:02 +00003795 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003796
Paul Elliott59ad9452022-12-18 15:09:02 +00003797 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003798
Paul Elliott59ad9452022-12-18 15:09:02 +00003799 /* We clear the number of ops done here, so that it is not cleared when
3800 * the operation fails or succeeds, only on manual abort. */
3801 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003802
Paul Elliottc9774412023-02-06 15:14:07 +00003803 /* Likewise, failure state. */
3804 operation->error_occurred = 0;
3805
Paul Elliott59ad9452022-12-18 15:09:02 +00003806 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003807}
3808
Paul Elliott588f8ed2022-12-02 18:10:26 +00003809/****************************************************************/
3810/* Asymmetric interruptible cryptography internal */
3811/* implementations */
3812/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003813
Paul Elliott588f8ed2022-12-02 18:10:26 +00003814void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3815{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003816
Paul Elliott588f8ed2022-12-02 18:10:26 +00003817#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3818 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3819 defined(MBEDTLS_ECP_RESTARTABLE)
3820
3821 /* Internal implementation uses zero to indicate infinite number max ops,
3822 * therefore avoid this value, and set to minimum possible. */
3823 if (max_ops == 0) {
3824 max_ops = 1;
3825 }
3826
Paul Elliott588f8ed2022-12-02 18:10:26 +00003827 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003828#else
3829 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003830#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3831 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3832 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3833}
3834
Paul Elliott588f8ed2022-12-02 18:10:26 +00003835uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003836 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003837{
3838#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3839 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3840 defined(MBEDTLS_ECP_RESTARTABLE)
3841
Paul Elliott93d9ca82023-02-15 18:14:21 +00003842 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003843#else
3844 (void) operation;
3845 return 0;
3846#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3847 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3848 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3849}
3850
3851uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003852 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003853{
3854 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3855 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3856 defined(MBEDTLS_ECP_RESTARTABLE)
3857
Paul Elliott93d9ca82023-02-15 18:14:21 +00003858 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003859#else
3860 (void) operation;
3861 return 0;
3862#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3863 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3864 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3865}
3866
3867psa_status_t mbedtls_psa_sign_hash_start(
3868 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3869 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3870 size_t key_buffer_size, psa_algorithm_t alg,
3871 const uint8_t *hash, size_t hash_length)
3872{
3873 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003874 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003875
Paul Elliott068fe072023-01-16 13:59:15 +00003876 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3877 return PSA_ERROR_NOT_SUPPORTED;
3878 }
3879
3880 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003881 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003882 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003883
3884#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003885 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3886 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003887
Paul Elliotta1c94092023-02-15 16:38:04 +00003888 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3889
Paul Elliott93d9ca82023-02-15 18:14:21 +00003890 /* Ensure num_ops is zero'ed in case of context re-use. */
3891 operation->num_ops = 0;
3892
Paul Elliott068fe072023-01-16 13:59:15 +00003893 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3894 attributes->core.bits,
3895 key_buffer,
3896 key_buffer_size,
3897 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003898
Paul Elliott068fe072023-01-16 13:59:15 +00003899 if (status != PSA_SUCCESS) {
3900 return status;
3901 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003902
Paul Elliott1bc59df2023-02-05 13:41:57 +00003903 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003904 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003905
Paul Elliott068fe072023-01-16 13:59:15 +00003906 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003907 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003908 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003909
Paul Elliott0290a762023-02-09 14:30:24 +00003910 /* We only need to store the same length of hash as the private key size
3911 * here, it would be truncated by the internal implementation anyway. */
3912 required_hash_length = (hash_length < operation->coordinate_bytes ?
3913 hash_length : operation->coordinate_bytes);
3914
Paul Elliottba70ad42023-02-15 18:23:53 +00003915 if (required_hash_length > sizeof(operation->hash)) {
3916 /* Shouldn't happen, but better safe than sorry. */
3917 return PSA_ERROR_CORRUPTION_DETECTED;
3918 }
3919
Paul Elliott0290a762023-02-09 14:30:24 +00003920 memcpy(operation->hash, hash, required_hash_length);
3921 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003922
3923 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003924
3925#else
Paul Elliott068fe072023-01-16 13:59:15 +00003926 (void) operation;
3927 (void) key_buffer;
3928 (void) key_buffer_size;
3929 (void) alg;
3930 (void) hash;
3931 (void) hash_length;
3932 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003933 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003934
Paul Elliott068fe072023-01-16 13:59:15 +00003935 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003936#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3937 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3938 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003939}
3940
3941psa_status_t mbedtls_psa_sign_hash_complete(
3942 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3943 uint8_t *signature, size_t signature_size,
3944 size_t *signature_length)
3945{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003946#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3947 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3948 defined(MBEDTLS_ECP_RESTARTABLE)
3949
Paul Elliotta1c94092023-02-15 16:38:04 +00003950 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003951 mbedtls_mpi r;
3952 mbedtls_mpi s;
3953
Paul Elliott46845252023-02-03 14:59:11 +00003954 mbedtls_mpi_init(&r);
3955 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003956
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003957 /* Ensure max_ops is set to the current value (or default). */
3958 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3959
Paul Elliotta1c94092023-02-15 16:38:04 +00003960 if (signature_size < 2 * operation->coordinate_bytes) {
3961 status = PSA_ERROR_BUFFER_TOO_SMALL;
3962 goto exit;
3963 }
3964
Paul Elliott588f8ed2022-12-02 18:10:26 +00003965 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003966
Paul Elliott588f8ed2022-12-02 18:10:26 +00003967#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3968 status = mbedtls_to_psa_error(
3969 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003970 &r,
3971 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003972 &operation->ctx->d,
3973 operation->hash,
3974 operation->hash_length,
3975 operation->md_alg,
3976 mbedtls_psa_get_random,
3977 MBEDTLS_PSA_RANDOM_STATE,
3978 &operation->restart_ctx));
3979#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003980 status = PSA_ERROR_NOT_SUPPORTED;
3981 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003982#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3983 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003984 status = mbedtls_to_psa_error(
3985 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003986 &r,
3987 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003988 &operation->ctx->d,
3989 operation->hash,
3990 operation->hash_length,
3991 mbedtls_psa_get_random,
3992 MBEDTLS_PSA_RANDOM_STATE,
3993 mbedtls_psa_get_random,
3994 MBEDTLS_PSA_RANDOM_STATE,
3995 &operation->restart_ctx));
3996 }
3997
Paul Elliottf8e5b562023-02-19 18:43:45 +00003998 /* Hide the fact that the restart context only holds a delta of number of
3999 * ops done during the last operation, not an absolute value. */
4000 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4001
Paul Elliott724bd252023-02-08 12:35:08 +00004002 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00004003 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004004 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004005 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004006 operation->coordinate_bytes)
4007 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004008
4009 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004010 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004011 }
4012
4013 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004014 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004015 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004016 operation->coordinate_bytes,
4017 operation->coordinate_bytes)
4018 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004019
4020 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004021 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004022 }
4023
Paul Elliott1bc59df2023-02-05 13:41:57 +00004024 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004025
Paul Elliott724bd252023-02-08 12:35:08 +00004026 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004027 }
Paul Elliott724bd252023-02-08 12:35:08 +00004028
4029exit:
4030
4031 mbedtls_mpi_free(&r);
4032 mbedtls_mpi_free(&s);
4033 return status;
4034
Paul Elliott588f8ed2022-12-02 18:10:26 +00004035 #else
4036
4037 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004038 (void) signature;
4039 (void) signature_size;
4040 (void) signature_length;
4041
4042 return PSA_ERROR_NOT_SUPPORTED;
4043
4044#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4045 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4046 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4047}
4048
4049psa_status_t mbedtls_psa_sign_hash_abort(
4050 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4051{
4052
4053#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4054 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4055 defined(MBEDTLS_ECP_RESTARTABLE)
4056
4057 if (operation->ctx) {
4058 mbedtls_ecdsa_free(operation->ctx);
4059 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004060 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004061 }
4062
4063 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4064
Paul Elliott93d9ca82023-02-15 18:14:21 +00004065 operation->num_ops = 0;
4066
Paul Elliott588f8ed2022-12-02 18:10:26 +00004067 return PSA_SUCCESS;
4068
4069#else
4070
4071 (void) operation;
4072
4073 return PSA_ERROR_NOT_SUPPORTED;
4074
4075#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4076 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4077 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4078}
4079
4080psa_status_t mbedtls_psa_verify_hash_start(
4081 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4082 const psa_key_attributes_t *attributes,
4083 const uint8_t *key_buffer, size_t key_buffer_size,
4084 psa_algorithm_t alg,
4085 const uint8_t *hash, size_t hash_length,
4086 const uint8_t *signature, size_t signature_length)
4087{
4088 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004089 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004090 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004091
Paul Elliott068fe072023-01-16 13:59:15 +00004092 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4093 return PSA_ERROR_NOT_SUPPORTED;
4094 }
4095
4096 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004097 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004098 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004099
4100#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004101 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4102 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004103
Paul Elliotta1c94092023-02-15 16:38:04 +00004104 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4105 mbedtls_mpi_init(&operation->r);
4106 mbedtls_mpi_init(&operation->s);
4107
Paul Elliott93d9ca82023-02-15 18:14:21 +00004108 /* Ensure num_ops is zero'ed in case of context re-use. */
4109 operation->num_ops = 0;
4110
Paul Elliott068fe072023-01-16 13:59:15 +00004111 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4112 attributes->core.bits,
4113 key_buffer,
4114 key_buffer_size,
4115 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004116
Paul Elliott068fe072023-01-16 13:59:15 +00004117 if (status != PSA_SUCCESS) {
4118 return status;
4119 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004120
Paul Elliottc569fc22023-02-10 13:02:54 +00004121 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004122
Paul Elliott1bc59df2023-02-05 13:41:57 +00004123 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004124 return PSA_ERROR_INVALID_SIGNATURE;
4125 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004126
Paul Elliott068fe072023-01-16 13:59:15 +00004127 status = mbedtls_to_psa_error(
4128 mbedtls_mpi_read_binary(&operation->r,
4129 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004130 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004131
Paul Elliott068fe072023-01-16 13:59:15 +00004132 if (status != PSA_SUCCESS) {
4133 return status;
4134 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004135
Paul Elliott068fe072023-01-16 13:59:15 +00004136 status = mbedtls_to_psa_error(
4137 mbedtls_mpi_read_binary(&operation->s,
4138 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004139 coordinate_bytes,
4140 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004141
Paul Elliott068fe072023-01-16 13:59:15 +00004142 if (status != PSA_SUCCESS) {
4143 return status;
4144 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004145
Paul Elliott2c9843f2023-02-15 17:32:42 +00004146 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004147
Paul Elliott2c9843f2023-02-15 17:32:42 +00004148 if (status != PSA_SUCCESS) {
4149 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004150 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004151
Paul Elliott0290a762023-02-09 14:30:24 +00004152 /* We only need to store the same length of hash as the private key size
4153 * here, it would be truncated by the internal implementation anyway. */
4154 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4155 coordinate_bytes);
4156
Paul Elliottba70ad42023-02-15 18:23:53 +00004157 if (required_hash_length > sizeof(operation->hash)) {
4158 /* Shouldn't happen, but better safe than sorry. */
4159 return PSA_ERROR_CORRUPTION_DETECTED;
4160 }
4161
Paul Elliott0290a762023-02-09 14:30:24 +00004162 memcpy(operation->hash, hash, required_hash_length);
4163 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004164
4165 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004166#else
Paul Elliott068fe072023-01-16 13:59:15 +00004167 (void) operation;
4168 (void) key_buffer;
4169 (void) key_buffer_size;
4170 (void) alg;
4171 (void) hash;
4172 (void) hash_length;
4173 (void) signature;
4174 (void) signature_length;
4175 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004176 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004177 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004178
Paul Elliott068fe072023-01-16 13:59:15 +00004179 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004180#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4181 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4182 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004183}
4184
4185psa_status_t mbedtls_psa_verify_hash_complete(
4186 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4187{
4188
4189#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4190 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4191 defined(MBEDTLS_ECP_RESTARTABLE)
4192
Paul Elliottf8e5b562023-02-19 18:43:45 +00004193 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4194
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004195 /* Ensure max_ops is set to the current value (or default). */
4196 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4197
Paul Elliottf8e5b562023-02-19 18:43:45 +00004198 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004199 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4200 operation->hash,
4201 operation->hash_length,
4202 &operation->ctx->Q,
4203 &operation->r,
4204 &operation->s,
4205 &operation->restart_ctx));
4206
Paul Elliottf8e5b562023-02-19 18:43:45 +00004207 /* Hide the fact that the restart context only holds a delta of number of
4208 * ops done during the last operation, not an absolute value. */
4209 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4210
4211 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004212#else
4213 (void) operation;
4214
4215 return PSA_ERROR_NOT_SUPPORTED;
4216
4217#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4218 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4219 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4220}
4221
4222psa_status_t mbedtls_psa_verify_hash_abort(
4223 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4224{
4225
4226#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4227 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4228 defined(MBEDTLS_ECP_RESTARTABLE)
4229
4230 if (operation->ctx) {
4231 mbedtls_ecdsa_free(operation->ctx);
4232 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004233 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004234 }
4235
4236 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4237
Paul Elliott93d9ca82023-02-15 18:14:21 +00004238 operation->num_ops = 0;
4239
Paul Elliott588f8ed2022-12-02 18:10:26 +00004240 mbedtls_mpi_free(&operation->r);
4241 mbedtls_mpi_free(&operation->s);
4242
4243 return PSA_SUCCESS;
4244
4245#else
4246 (void) operation;
4247
4248 return PSA_ERROR_NOT_SUPPORTED;
4249
4250#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4251 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4252 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4253}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004254
mohammad1603503973b2018-03-12 15:59:30 +02004255/****************************************************************/
4256/* Symmetric cryptography */
4257/****************************************************************/
4258
Gilles Peskine449bd832023-01-11 14:50:10 +01004259static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4260 mbedtls_svc_key_id_t key,
4261 psa_algorithm_t alg,
4262 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004263{
4264 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4265 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004266 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4268 PSA_KEY_USAGE_ENCRYPT :
4269 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004270 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004271
4272 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004273 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004274 status = PSA_ERROR_BAD_STATE;
4275 goto exit;
4276 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004277
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004279 status = PSA_ERROR_INVALID_ARGUMENT;
4280 goto exit;
4281 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004282
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4284 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004285 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004287
Ronald Cron49fafa92021-03-10 08:34:23 +01004288 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004289 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004290 * so we only set it (in the driver wrapper) after resources have been
4291 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004292 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004294 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004296 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 }
4298 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004299
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004300 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004302 };
4303
Ronald Cronab99ac22020-10-01 16:38:28 +02004304 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 if (cipher_operation == MBEDTLS_ENCRYPT) {
4306 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4307 &attributes,
4308 slot->key.data,
4309 slot->key.bytes,
4310 alg);
4311 } else {
4312 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4313 &attributes,
4314 slot->key.data,
4315 slot->key.bytes,
4316 alg);
4317 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004318
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004319exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 if (status != PSA_SUCCESS) {
4321 psa_cipher_abort(operation);
4322 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004323
Ryan Everett1b70a072024-01-04 10:32:49 +00004324 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004325
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004327}
4328
Gilles Peskine449bd832023-01-11 14:50:10 +01004329psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4330 mbedtls_svc_key_id_t key,
4331 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004332{
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004334}
4335
Gilles Peskine449bd832023-01-11 14:50:10 +01004336psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4337 mbedtls_svc_key_id_t key,
4338 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004339{
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004341}
4342
Gilles Peskine449bd832023-01-11 14:50:10 +01004343psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4344 uint8_t *iv,
4345 size_t iv_size,
4346 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004347{
Ronald Cron6d051732020-10-01 14:10:20 +02004348 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004349 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004350 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004351
Gilles Peskine449bd832023-01-11 14:50:10 +01004352 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004353 status = PSA_ERROR_BAD_STATE;
4354 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004355 }
4356
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004358 status = PSA_ERROR_BAD_STATE;
4359 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004360 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004361
Ronald Cron2fb90522021-07-05 12:31:44 +02004362 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004364 status = PSA_ERROR_BUFFER_TOO_SMALL;
4365 goto exit;
4366 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004367
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004369 status = PSA_ERROR_GENERIC_ERROR;
4370 goto exit;
4371 }
4372
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 status = psa_generate_random(local_iv, default_iv_length);
4374 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004375 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 }
Ronald Cron5618a392021-03-26 09:52:26 +01004377
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 status = psa_driver_wrapper_cipher_set_iv(operation,
4379 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004380
4381exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (status == PSA_SUCCESS) {
4383 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004384 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004385 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004387 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004389 }
Ronald Cron6d051732020-10-01 14:10:20 +02004390
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004392}
4393
Gilles Peskine449bd832023-01-11 14:50:10 +01004394psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4395 const uint8_t *iv,
4396 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004397{
Ronald Cron6d051732020-10-01 14:10:20 +02004398 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004401 status = PSA_ERROR_BAD_STATE;
4402 goto exit;
4403 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004404
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004406 status = PSA_ERROR_BAD_STATE;
4407 goto exit;
4408 }
Ronald Crona0d68172021-03-26 10:15:08 +01004409
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004411 status = PSA_ERROR_INVALID_ARGUMENT;
4412 goto exit;
4413 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004414
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 status = psa_driver_wrapper_cipher_set_iv(operation,
4416 iv,
4417 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004418
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004419exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004421 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 } else {
4423 psa_cipher_abort(operation);
4424 }
4425 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004426}
4427
Gilles Peskine449bd832023-01-11 14:50:10 +01004428psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4429 const uint8_t *input,
4430 size_t input_length,
4431 uint8_t *output,
4432 size_t output_size,
4433 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004434{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004435 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004438 status = PSA_ERROR_BAD_STATE;
4439 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004440 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004443 status = PSA_ERROR_BAD_STATE;
4444 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004445 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 status = psa_driver_wrapper_cipher_update(operation,
4448 input,
4449 input_length,
4450 output,
4451 output_size,
4452 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004453
4454exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 if (status != PSA_SUCCESS) {
4456 psa_cipher_abort(operation);
4457 }
Ronald Cron6d051732020-10-01 14:10:20 +02004458
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004460}
4461
Gilles Peskine449bd832023-01-11 14:50:10 +01004462psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4463 uint8_t *output,
4464 size_t output_size,
4465 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004466{
David Saadab4ecc272019-02-14 13:48:10 +02004467 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004468
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004470 status = PSA_ERROR_BAD_STATE;
4471 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004472 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004473
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004475 status = PSA_ERROR_BAD_STATE;
4476 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004477 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004478
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 status = psa_driver_wrapper_cipher_finish(operation,
4480 output,
4481 output_size,
4482 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004483
4484exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 if (status == PSA_SUCCESS) {
4486 return psa_cipher_abort(operation);
4487 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004488 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004490
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004492 }
mohammad1603503973b2018-03-12 15:59:30 +02004493}
4494
Gilles Peskine449bd832023-01-11 14:50:10 +01004495psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004496{
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004498 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004499 * in use. It's ok to call abort on such an object, and there's
4500 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004502 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004503
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004505
Ronald Cron49fafa92021-03-10 08:34:23 +01004506 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004507 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004508 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004509
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004511}
4512
Gilles Peskine449bd832023-01-11 14:50:10 +01004513psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4514 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004515 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004517 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 size_t output_size,
4519 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004520{
4521 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004522 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004523 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004524 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4525 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004526 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004527
David Horstmann62a56d92023-12-14 18:12:47 +00004528 LOCAL_INPUT_DECLARE(input_external, input);
4529 LOCAL_OUTPUT_DECLARE(output_external, output);
4530
David Horstmann36df4b22023-12-13 15:55:25 +00004531 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004532 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004533
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004535 status = PSA_ERROR_INVALID_ARGUMENT;
4536 goto exit;
4537 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004538
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4540 PSA_KEY_USAGE_ENCRYPT,
4541 alg);
4542 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004543 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004545
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004546 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004548 };
4549
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4551 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004552 status = PSA_ERROR_GENERIC_ERROR;
4553 goto exit;
4554 }
4555
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 if (default_iv_length > 0) {
4557 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004558 status = PSA_ERROR_BUFFER_TOO_SMALL;
4559 goto exit;
4560 }
4561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 status = psa_generate_random(local_iv, default_iv_length);
4563 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004564 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004566 }
4567
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004568 status = psa_driver_wrapper_cipher_encrypt(
4569 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004570 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004571 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004573
4574exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004575 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004577 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004578 }
Ronald Cron23919522021-07-08 19:00:07 +02004579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (status == PSA_SUCCESS) {
4581 if (default_iv_length > 0) {
4582 memcpy(output, local_iv, default_iv_length);
4583 }
4584 *output_length += default_iv_length;
4585 } else {
4586 *output_length = 0;
4587 }
4588
David Horstmann62a56d92023-12-14 18:12:47 +00004589 LOCAL_INPUT_FREE(input_external, input);
4590 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004591
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004593}
4594
Gilles Peskine449bd832023-01-11 14:50:10 +01004595psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4596 psa_algorithm_t alg,
4597 const uint8_t *input,
4598 size_t input_length,
4599 uint8_t *output,
4600 size_t output_size,
4601 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004602{
4603 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004604 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004605 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004606 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004607
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004609 status = PSA_ERROR_INVALID_ARGUMENT;
4610 goto exit;
4611 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004612
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4614 PSA_KEY_USAGE_DECRYPT,
4615 alg);
4616 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004617 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004619
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004620 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004622 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4625 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004626 status = PSA_ERROR_INVALID_ARGUMENT;
4627 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004629 status = PSA_ERROR_INVALID_ARGUMENT;
4630 goto exit;
4631 }
4632
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004633 status = psa_driver_wrapper_cipher_decrypt(
4634 &attributes, slot->key.data, slot->key.bytes,
4635 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004636 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004637
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004638exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004639 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004641 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004643
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004645 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 }
Ronald Cron23919522021-07-08 19:00:07 +02004647
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004649}
4650
4651
mohammad16035955c982018-04-26 00:53:03 +03004652/****************************************************************/
4653/* AEAD */
4654/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004655
Paul Elliottbaff51c2021-09-28 17:44:45 +01004656/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004657static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004658{
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004660}
4661
4662/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004663static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4664 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004665{
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004667
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004669#if defined(PSA_WANT_ALG_GCM)
4670 case PSA_ALG_GCM:
4671 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 * arbitrarily large nonces. Please note that we do not generally
4673 * recommend the usage of nonces of greater length than
4674 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4675 * size, which can then lead to collisions if you encrypt a very
4676 * large number of messages.*/
4677 if (nonce_length != 0) {
4678 return PSA_SUCCESS;
4679 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004680 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004681#endif /* PSA_WANT_ALG_GCM */
4682#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004683 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 if (nonce_length >= 7 && nonce_length <= 13) {
4685 return PSA_SUCCESS;
4686 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004687 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004688#endif /* PSA_WANT_ALG_CCM */
4689#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004690 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004691 if (nonce_length == 12) {
4692 return PSA_SUCCESS;
4693 } else if (nonce_length == 8) {
4694 return PSA_ERROR_NOT_SUPPORTED;
4695 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004696 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004697#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004698 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004699 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004701 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004702
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004704}
4705
Gilles Peskine449bd832023-01-11 14:50:10 +01004706static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004707{
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4709 return PSA_ERROR_INVALID_ARGUMENT;
4710 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004713}
4714
Gilles Peskine449bd832023-01-11 14:50:10 +01004715psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4716 psa_algorithm_t alg,
David Horstmann9d09a022023-11-28 19:25:00 +00004717 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 size_t nonce_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004719 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 size_t additional_data_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004721 const uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 size_t plaintext_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004723 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 size_t ciphertext_size,
4725 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004726{
Ronald Cron215633c2021-03-16 17:15:37 +01004727 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4728 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004729
David Horstmann9d09a022023-11-28 19:25:00 +00004730 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4731 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4732 LOCAL_INPUT_DECLARE(plaintext_external, plaintext);
4733 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
4734
mohammad1603f08a5502018-06-03 15:05:47 +03004735 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004736
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 status = psa_aead_check_algorithm(alg);
4738 if (status != PSA_SUCCESS) {
4739 return status;
4740 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004741
Ronald Cron9a986162021-03-26 12:40:07 +01004742 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4744 if (status != PSA_SUCCESS) {
4745 return status;
4746 }
mohammad16035955c982018-04-26 00:53:03 +03004747
Ronald Cron215633c2021-03-16 17:15:37 +01004748 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004750 };
mohammad16035955c982018-04-26 00:53:03 +03004751
David Horstmann9d09a022023-11-28 19:25:00 +00004752 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4753 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length, additional_data);
4754 LOCAL_INPUT_ALLOC(plaintext_external, plaintext_length, plaintext);
4755 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
4756
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 status = psa_aead_check_nonce_length(alg, nonce_length);
4758 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004759 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004761
Ronald Cronde822812021-03-17 16:08:20 +01004762 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004763 &attributes, slot->key.data, slot->key.bytes,
4764 alg,
4765 nonce, nonce_length,
4766 additional_data, additional_data_length,
4767 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004769
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4771 memset(ciphertext, 0, ciphertext_size);
4772 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004773
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004774exit:
David Horstmann9d09a022023-11-28 19:25:00 +00004775 LOCAL_INPUT_FREE(nonce_external, nonce);
4776 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4777 LOCAL_INPUT_FREE(plaintext_external, plaintext);
4778 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
4779
Ryan Everett1b70a072024-01-04 10:32:49 +00004780 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004781
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004783}
4784
Gilles Peskine449bd832023-01-11 14:50:10 +01004785psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4786 psa_algorithm_t alg,
David Horstmann7f2e0402023-11-28 19:43:53 +00004787 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 size_t nonce_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004789 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 size_t additional_data_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004791 const uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 size_t ciphertext_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004793 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 size_t plaintext_size,
4795 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004796{
Ronald Cron215633c2021-03-16 17:15:37 +01004797 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4798 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004799
David Horstmann7f2e0402023-11-28 19:43:53 +00004800 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4801 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4802 LOCAL_INPUT_DECLARE(ciphertext_external, ciphertext);
4803 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
4804
Gilles Peskineee652a32018-06-01 19:23:52 +02004805 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004806
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 status = psa_aead_check_algorithm(alg);
4808 if (status != PSA_SUCCESS) {
4809 return status;
4810 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004811
Ronald Cron9a986162021-03-26 12:40:07 +01004812 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4814 if (status != PSA_SUCCESS) {
4815 return status;
4816 }
mohammad16035955c982018-04-26 00:53:03 +03004817
Ronald Cron215633c2021-03-16 17:15:37 +01004818 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004820 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004821
David Horstmann7f2e0402023-11-28 19:43:53 +00004822 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4823 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length,
4824 additional_data);
4825 LOCAL_INPUT_ALLOC(ciphertext_external, ciphertext_length, ciphertext);
4826 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
4827
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 status = psa_aead_check_nonce_length(alg, nonce_length);
4829 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004830 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004832
Ronald Cronde822812021-03-17 16:08:20 +01004833 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004834 &attributes, slot->key.data, slot->key.bytes,
4835 alg,
4836 nonce, nonce_length,
4837 additional_data, additional_data_length,
4838 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004840
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (status != PSA_SUCCESS && plaintext_size != 0) {
4842 memset(plaintext, 0, plaintext_size);
4843 }
mohammad160360a64d02018-06-03 17:20:42 +03004844
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004845exit:
David Horstmann7f2e0402023-11-28 19:43:53 +00004846 LOCAL_INPUT_FREE(nonce_external, nonce);
4847 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4848 LOCAL_INPUT_FREE(ciphertext_external, ciphertext);
4849 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
4850
Ryan Everett1b70a072024-01-04 10:32:49 +00004851 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004852
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 return status;
mohammad16035955c982018-04-26 00:53:03 +03004854}
4855
Gilles Peskine449bd832023-01-11 14:50:10 +01004856static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4857{
4858 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004859
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004861#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004863 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4865 return PSA_ERROR_INVALID_ARGUMENT;
4866 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004867 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004868#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004869
Przemek Stekiel86679c72022-10-06 17:06:56 +02004870#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004872 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4874 return PSA_ERROR_INVALID_ARGUMENT;
4875 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004876 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004877#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004878
Przemek Stekiel86679c72022-10-06 17:06:56 +02004879#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004881 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 if (tag_len != 16) {
4883 return PSA_ERROR_INVALID_ARGUMENT;
4884 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004885 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004886#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004887
4888 default:
4889 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004891 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004893}
4894
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004895/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004896static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4897 int is_encrypt,
4898 mbedtls_svc_key_id_t key,
4899 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004900{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004901 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4902 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4903 psa_key_slot_t *slot = NULL;
4904 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004905 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 status = psa_aead_check_algorithm(alg);
4908 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004909 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004911
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004913 status = PSA_ERROR_BAD_STATE;
4914 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004915 }
4916
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 if (operation->nonce_set || operation->lengths_set ||
4918 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004919 status = PSA_ERROR_BAD_STATE;
4920 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004921 }
4922
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004924 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004926 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004928
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4930 alg);
4931 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004932 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004934
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004935 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004936 .core = slot->attr
4937 };
4938
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004940 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004942
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 if (is_encrypt) {
4944 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4945 &attributes,
4946 slot->key.data,
4947 slot->key.bytes,
4948 alg);
4949 } else {
4950 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4951 &attributes,
4952 slot->key.data,
4953 slot->key.bytes,
4954 alg);
4955 }
4956 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004957 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004959
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004961
4962exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004963 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004964
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004966 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004968 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 } else {
4970 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004971 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004972
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004974}
4975
Paul Elliott302ff6b2021-04-20 18:10:30 +01004976/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004977psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4978 mbedtls_svc_key_id_t key,
4979 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004980{
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004982}
4983
4984/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004985psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4986 mbedtls_svc_key_id_t key,
4987 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004988{
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004990}
4991
David Horstmannfed23772023-12-19 17:49:20 +00004992static psa_status_t psa_aead_set_nonce_internal(psa_aead_operation_t *operation,
4993 const uint8_t *nonce,
4994 size_t nonce_length)
4995{
4996 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4997
4998 if (operation->id == 0) {
4999 status = PSA_ERROR_BAD_STATE;
5000 goto exit;
5001 }
5002
5003 if (operation->nonce_set) {
5004 status = PSA_ERROR_BAD_STATE;
5005 goto exit;
5006 }
5007
5008 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5009 if (status != PSA_SUCCESS) {
5010 status = PSA_ERROR_INVALID_ARGUMENT;
5011 goto exit;
5012 }
5013
5014 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5015 nonce_length);
5016
5017exit:
5018 if (status == PSA_SUCCESS) {
5019 operation->nonce_set = 1;
5020 } else {
5021 psa_aead_abort(operation);
5022 }
5023
5024 return status;
5025}
5026
Paul Elliott302ff6b2021-04-20 18:10:30 +01005027/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01005028psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
David Horstmannd3cad8b2023-12-11 14:46:04 +00005029 uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 size_t nonce_size,
5031 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005032{
5033 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01005034 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07005035 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005036
David Horstmannd3cad8b2023-12-11 14:46:04 +00005037 LOCAL_OUTPUT_DECLARE(nonce_external, nonce);
5038 LOCAL_OUTPUT_ALLOC(nonce_external, nonce_size, nonce);
5039
Paul Elliott8eb9daf2021-06-04 16:42:21 +01005040 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005043 status = PSA_ERROR_BAD_STATE;
5044 goto exit;
5045 }
5046
Gilles Peskine449bd832023-01-11 14:50:10 +01005047 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005048 status = PSA_ERROR_BAD_STATE;
5049 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005050 }
5051
Paul Elliotte193ea82021-10-01 13:00:16 +01005052 /* For CCM, this size may not be correct according to the PSA
5053 * specification. The PSA Crypto 1.0.1 specification states:
5054 *
5055 * CCM encodes the plaintext length pLen in L octets, with L the smallest
5056 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
5057 *
5058 * However this restriction that L has to be the smallest integer is not
5059 * applied in practice, and it is not implementable here since the
5060 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
5062 operation->alg);
5063 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005064 status = PSA_ERROR_BUFFER_TOO_SMALL;
5065 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005066 }
5067
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 status = psa_generate_random(local_nonce, required_nonce_size);
5069 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005070 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005072
David Horstmannfed23772023-12-19 17:49:20 +00005073 status = psa_aead_set_nonce_internal(operation, local_nonce,
5074 required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005075
Paul Elliott39dc6b82021-05-11 19:16:09 +01005076exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if (status == PSA_SUCCESS) {
5078 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005079 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 } else {
5081 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005082 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005083
David Horstmannd3cad8b2023-12-11 14:46:04 +00005084 LOCAL_OUTPUT_FREE(nonce_external, nonce);
5085
Gilles Peskine449bd832023-01-11 14:50:10 +01005086 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005087}
5088
5089/* Set the nonce for a multipart authenticated encryption or decryption
5090 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005091psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
David Horstmann8f0ef512023-12-11 15:17:11 +00005092 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005094{
David Horstmannfed23772023-12-19 17:49:20 +00005095 psa_status_t status;
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005096
David Horstmann8f0ef512023-12-11 15:17:11 +00005097 LOCAL_INPUT_DECLARE(nonce_external, nonce);
5098 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
Paul Elliottcee785c2021-05-20 14:29:20 +01005099
David Horstmannfed23772023-12-19 17:49:20 +00005100 status = psa_aead_set_nonce_internal(operation, nonce, nonce_length);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005101
David Horstmann18dc0322023-12-20 16:16:43 +00005102/* Exit label is only needed for buffer copying, prevent unused warnings. */
5103#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Paul Elliott39dc6b82021-05-11 19:16:09 +01005104exit:
David Horstmann18dc0322023-12-20 16:16:43 +00005105#endif
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005106
David Horstmann8f0ef512023-12-11 15:17:11 +00005107 LOCAL_INPUT_FREE(nonce_external, nonce);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005108
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005110}
5111
5112/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005113psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5114 size_t ad_length,
5115 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005116{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005117 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5118
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005120 status = PSA_ERROR_BAD_STATE;
5121 goto exit;
5122 }
5123
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 if (operation->lengths_set || operation->ad_started ||
5125 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005126 status = PSA_ERROR_BAD_STATE;
5127 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005128 }
5129
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005131#if defined(PSA_WANT_ALG_GCM)
5132 case PSA_ALG_GCM:
5133 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 * bits. Without the guard this code will generate warnings on 32bit
5135 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005136#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 if (((uint64_t) ad_length) >> 61 != 0 ||
5138 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005139 status = PSA_ERROR_INVALID_ARGUMENT;
5140 goto exit;
5141 }
Paul Elliott325d3742021-09-27 17:56:28 +01005142#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005143 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005144#endif /* PSA_WANT_ALG_GCM */
5145#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005146 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005148 status = PSA_ERROR_INVALID_ARGUMENT;
5149 goto exit;
5150 }
5151 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005152#endif /* PSA_WANT_ALG_CCM */
5153#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005154 case PSA_ALG_CHACHA20_POLY1305:
5155 /* No length restrictions for ChaChaPoly. */
5156 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005157#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005158 default:
5159 break;
5160 }
Paul Elliott325d3742021-09-27 17:56:28 +01005161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5163 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005164
Paul Elliott39dc6b82021-05-11 19:16:09 +01005165exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005167 operation->ad_remaining = ad_length;
5168 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005169 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 } else {
5171 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005172 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005173
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005175}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005176
5177/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005178psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
David Horstmann25dac6e2023-12-11 15:23:13 +00005179 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005181{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5183
David Horstmann25dac6e2023-12-11 15:23:13 +00005184 LOCAL_INPUT_DECLARE(input_external, input);
5185 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5186
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005188 status = PSA_ERROR_BAD_STATE;
5189 goto exit;
5190 }
5191
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005193 status = PSA_ERROR_BAD_STATE;
5194 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005195 }
5196
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 if (operation->lengths_set) {
5198 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005199 status = PSA_ERROR_INVALID_ARGUMENT;
5200 goto exit;
5201 }
5202
5203 operation->ad_remaining -= input_length;
5204 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005205#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005207 status = PSA_ERROR_BAD_STATE;
5208 goto exit;
5209 }
5210#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005211
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 status = psa_driver_wrapper_aead_update_ad(operation, input,
5213 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005214
Paul Elliott39dc6b82021-05-11 19:16:09 +01005215exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005216 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005217 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 } else {
5219 psa_aead_abort(operation);
5220 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005221
David Horstmann25dac6e2023-12-11 15:23:13 +00005222 LOCAL_INPUT_FREE(input_external, input);
5223
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005225}
5226
5227/* Encrypt or decrypt a message fragment in an active multipart AEAD
5228 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005229psa_status_t psa_aead_update(psa_aead_operation_t *operation,
David Horstmann2914fac2023-12-11 15:28:37 +00005230 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 size_t input_length,
David Horstmann2914fac2023-12-11 15:28:37 +00005232 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 size_t output_size,
5234 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005235{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005236 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005237
David Horstmann2914fac2023-12-11 15:28:37 +00005238
5239 LOCAL_INPUT_DECLARE(input_external, input);
5240 LOCAL_OUTPUT_DECLARE(output_external, output);
5241
5242 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5243 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
5244
Paul Elliott302ff6b2021-04-20 18:10:30 +01005245 *output_length = 0;
5246
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005248 status = PSA_ERROR_BAD_STATE;
5249 goto exit;
5250 }
5251
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005253 status = PSA_ERROR_BAD_STATE;
5254 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005255 }
5256
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005258 /* Additional data length was supplied, but not all the additional
5259 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005261 status = PSA_ERROR_INVALID_ARGUMENT;
5262 goto exit;
5263 }
5264
5265 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005267 status = PSA_ERROR_INVALID_ARGUMENT;
5268 goto exit;
5269 }
5270
5271 operation->body_remaining -= input_length;
5272 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005273#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005275 status = PSA_ERROR_BAD_STATE;
5276 goto exit;
5277 }
5278#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005279
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5281 output, output_size,
5282 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005283
Paul Elliott39dc6b82021-05-11 19:16:09 +01005284exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005286 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 } else {
5288 psa_aead_abort(operation);
5289 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005290
David Horstmann2914fac2023-12-11 15:28:37 +00005291 LOCAL_INPUT_FREE(input_external, input);
5292 LOCAL_OUTPUT_FREE(output_external, output);
5293
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005295}
5296
Gilles Peskine449bd832023-01-11 14:50:10 +01005297static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005298{
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 if (operation->id == 0 || !operation->nonce_set) {
5300 return PSA_ERROR_BAD_STATE;
5301 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005302
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5304 operation->body_remaining != 0)) {
5305 return PSA_ERROR_INVALID_ARGUMENT;
5306 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005307
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005309}
5310
Paul Elliott302ff6b2021-04-20 18:10:30 +01005311/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005312psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
David Horstmann6db0e732023-12-11 15:35:59 +00005313 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 size_t ciphertext_size,
5315 size_t *ciphertext_length,
David Horstmann6db0e732023-12-11 15:35:59 +00005316 uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 size_t tag_size,
5318 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005319{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005320 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5321
David Horstmann6db0e732023-12-11 15:35:59 +00005322 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
5323 LOCAL_OUTPUT_DECLARE(tag_external, tag);
5324
5325 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
5326 LOCAL_OUTPUT_ALLOC(tag_external, tag_size, tag);
5327
Paul Elliott302ff6b2021-04-20 18:10:30 +01005328 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005329 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005330
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 status = psa_aead_final_checks(operation);
5332 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005333 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005335
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005337 status = PSA_ERROR_BAD_STATE;
5338 goto exit;
5339 }
5340
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5342 ciphertext_size,
5343 ciphertext_length,
5344 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005345
Paul Elliott39dc6b82021-05-11 19:16:09 +01005346exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005347
5348
Paul Elliottf47b0952021-05-21 18:02:33 +01005349 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005350 * the zero tag size, make sure the tag is set to something implausible.
5351 * Even if the operation succeeds, make sure we clear the rest of the
5352 * buffer to prevent potential leakage of anything previously placed in
5353 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005354 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005355
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005357
David Horstmann6db0e732023-12-11 15:35:59 +00005358 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
5359 LOCAL_OUTPUT_FREE(tag_external, tag);
5360
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005362}
5363
5364/* Finish authenticating and decrypting a message in a multipart AEAD
5365 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005366psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
David Horstmanne000a0a2023-12-11 16:37:04 +00005367 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 size_t plaintext_size,
5369 size_t *plaintext_length,
David Horstmanne000a0a2023-12-11 16:37:04 +00005370 const uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005372{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005373 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5374
David Horstmanne000a0a2023-12-11 16:37:04 +00005375 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
5376 LOCAL_INPUT_DECLARE(tag_external, tag);
5377
5378 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
5379 LOCAL_INPUT_ALLOC(tag_external, tag_length, tag);
5380
Paul Elliott302ff6b2021-04-20 18:10:30 +01005381 *plaintext_length = 0;
5382
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 status = psa_aead_final_checks(operation);
5384 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005385 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005389 status = PSA_ERROR_BAD_STATE;
5390 goto exit;
5391 }
5392
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5394 plaintext_size,
5395 plaintext_length,
5396 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005397
5398exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005400
David Horstmanne000a0a2023-12-11 16:37:04 +00005401 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
5402 LOCAL_INPUT_FREE(tag_external, tag);
5403
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005405}
5406
5407/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005408psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005409{
5410 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5411
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005413 /* The object has (apparently) been initialized but it is not (yet)
5414 * in use. It's ok to call abort on such an object, and there's
5415 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005417 }
5418
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005420
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005422
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005424}
5425
Gilles Peskinee59236f2018-01-27 23:32:46 +01005426/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005427/* Generators */
5428/****************************************************************/
5429
Przemek Stekiel69c46792022-06-10 12:59:51 +02005430#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005431 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005432 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305433 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305434 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005435#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005436#endif /* At least one builtin KDF */
5437
Przemek Stekiel69c46792022-06-10 12:59:51 +02005438#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005439 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5440 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5441static psa_status_t psa_key_derivation_start_hmac(
5442 psa_mac_operation_t *operation,
5443 psa_algorithm_t hash_alg,
5444 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005446{
5447 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5448 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5450 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5451 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005452
Steven Cooreman72f736a2021-05-07 14:14:37 +02005453 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005455
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 status = psa_driver_wrapper_mac_sign_setup(operation,
5457 &attributes,
5458 hmac_key, hmac_key_length,
5459 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005460
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 psa_reset_key_attributes(&attributes);
5462 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005463}
5464#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005465
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005466#define HKDF_STATE_INIT 0 /* no input yet */
5467#define HKDF_STATE_STARTED 1 /* got salt */
5468#define HKDF_STATE_KEYED 2 /* got key */
5469#define HKDF_STATE_OUTPUT 3 /* output started */
5470
Gilles Peskinecbe66502019-05-16 16:59:18 +02005471static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005473{
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5475 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5476 } else {
5477 return operation->alg;
5478 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005479}
5480
Gilles Peskine449bd832023-01-11 14:50:10 +01005481psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005482{
5483 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5485 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005486 /* The object has (apparently) been initialized but it is not
5487 * in use. It's ok to call abort on such an object, and there's
5488 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005490#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5492 mbedtls_free(operation->ctx.hkdf.info);
5493 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5494 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005495#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005496#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5497 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5499 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5500 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5501 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005502 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005504 }
5505
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005507 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005509 }
5510
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005512 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005514 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005515#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005517 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005519 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005520#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005521 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005522
5523 /* We leave the fields Ai and output_block to be erased safely by the
5524 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005526#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5527 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005528#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5530 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5531 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5532 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005533#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305534#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305535 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305536 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005537 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305538 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305539 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305540
5541 status = PSA_SUCCESS;
5542 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305543#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005544 {
5545 status = PSA_ERROR_BAD_STATE;
5546 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 mbedtls_platform_zeroize(operation, sizeof(*operation));
5548 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005549}
5550
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005551psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005553{
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005555 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005557 }
5558
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005559 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005561}
5562
Gilles Peskine449bd832023-01-11 14:50:10 +01005563psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5564 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005565{
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 if (operation->alg == 0) {
5567 return PSA_ERROR_BAD_STATE;
5568 }
5569 if (capacity > operation->capacity) {
5570 return PSA_ERROR_INVALID_ARGUMENT;
5571 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005572 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005574}
5575
Przemek Stekiel69c46792022-06-10 12:59:51 +02005576#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005577/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005578static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5579 psa_algorithm_t kdf_alg,
5580 uint8_t *output,
5581 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005582{
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5584 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005585 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005586 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005587#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005589#else
5590 const uint8_t last_block = 0xff;
5591#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005592
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 if (hkdf->state < HKDF_STATE_KEYED ||
5594 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005595#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005597#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 )) {
5599 return PSA_ERROR_BAD_STATE;
5600 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005601 hkdf->state = HKDF_STATE_OUTPUT;
5602
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005604 /* Copy what remains of the current block */
5605 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005607 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 }
5609 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005610 output += n;
5611 output_length -= n;
5612 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005614 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005616 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005617 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005618 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005619 * object was corrupted or if this function is called directly
5620 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 if (hkdf->block_number == last_block) {
5622 return PSA_ERROR_BAD_STATE;
5623 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005624
5625 /* We need a new block */
5626 ++hkdf->block_number;
5627 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005628
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5630 hash_alg,
5631 hkdf->prk,
5632 hash_length);
5633 if (status != PSA_SUCCESS) {
5634 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005635 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005636
5637 if (hkdf->block_number != 1) {
5638 status = psa_mac_update(&hkdf->hmac,
5639 hkdf->output_block,
5640 hash_length);
5641 if (status != PSA_SUCCESS) {
5642 return status;
5643 }
5644 }
5645 status = psa_mac_update(&hkdf->hmac,
5646 hkdf->info,
5647 hkdf->info_length);
5648 if (status != PSA_SUCCESS) {
5649 return status;
5650 }
5651 status = psa_mac_update(&hkdf->hmac,
5652 &hkdf->block_number, 1);
5653 if (status != PSA_SUCCESS) {
5654 return status;
5655 }
5656 status = psa_mac_sign_finish(&hkdf->hmac,
5657 hkdf->output_block,
5658 sizeof(hkdf->output_block),
5659 &hmac_output_length);
5660 if (status != PSA_SUCCESS) {
5661 return status;
5662 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005663 }
5664
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005666}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005667#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005668
John Durkop07cc04a2020-11-16 22:08:34 -08005669#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5670 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005671static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5672 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005674{
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5676 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005677 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5678 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005679 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005680
Janos Follath7742fee2019-06-17 12:58:10 +01005681 /* We can't be wanting more output after block 0xff, otherwise
5682 * the capacity check in psa_key_derivation_output_bytes() would have
5683 * prevented this call. It could happen only if the operation
5684 * object was corrupted or if this function is called directly
5685 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 if (tls12_prf->block_number == 0xff) {
5687 return PSA_ERROR_CORRUPTION_DETECTED;
5688 }
Janos Follath7742fee2019-06-17 12:58:10 +01005689
5690 /* We need a new block */
5691 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005692 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005693
5694 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5695 *
5696 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5697 *
5698 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5699 * HMAC_hash(secret, A(2) + seed) +
5700 * HMAC_hash(secret, A(3) + seed) + ...
5701 *
5702 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005703 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005704 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005705 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005706 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005707 * is currently extracted as `output_block` and where i is
5708 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005709 */
5710
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 status = psa_key_derivation_start_hmac(&hmac,
5712 hash_alg,
5713 tls12_prf->secret,
5714 tls12_prf->secret_length);
5715 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005716 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005718
5719 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005721 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5722 * the variable seed and in this instance means it in the context of the
5723 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 status = psa_mac_update(&hmac,
5725 tls12_prf->label,
5726 tls12_prf->label_length);
5727 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005728 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 }
5730 status = psa_mac_update(&hmac,
5731 tls12_prf->seed,
5732 tls12_prf->seed_length);
5733 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005734 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 }
5736 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005737 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5739 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005740 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005742 }
5743
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 status = psa_mac_sign_finish(&hmac,
5745 tls12_prf->Ai, hash_length,
5746 &hmac_output_length);
5747 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005748 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 }
5750 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005751 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005753
5754 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 status = psa_key_derivation_start_hmac(&hmac,
5756 hash_alg,
5757 tls12_prf->secret,
5758 tls12_prf->secret_length);
5759 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005760 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 }
5762 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5763 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005764 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 }
5766 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5767 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005768 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 }
5770 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5771 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005772 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 }
5774 status = psa_mac_sign_finish(&hmac,
5775 tls12_prf->output_block, hash_length,
5776 &hmac_output_length);
5777 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005778 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005780
Janos Follath7742fee2019-06-17 12:58:10 +01005781
5782cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005783 cleanup_status = psa_mac_abort(&hmac);
5784 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005785 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005787
Gilles Peskine449bd832023-01-11 14:50:10 +01005788 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005789}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005790
Janos Follath844eb0e2019-06-19 12:10:49 +01005791static psa_status_t psa_key_derivation_tls12_prf_read(
5792 psa_tls12_prf_key_derivation_t *tls12_prf,
5793 psa_algorithm_t alg,
5794 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005796{
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5798 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005799 psa_status_t status;
5800 uint8_t offset, length;
5801
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005803 case PSA_TLS12_PRF_STATE_LABEL_SET:
5804 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5805 break;
5806 case PSA_TLS12_PRF_STATE_OUTPUT:
5807 break;
5808 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005810 }
5811
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005813 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 if (tls12_prf->left_in_block == 0) {
5815 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5816 alg);
5817 if (status != PSA_SUCCESS) {
5818 return status;
5819 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005820
5821 continue;
5822 }
5823
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005825 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005827 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005829
5830 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005832 output += length;
5833 output_length -= length;
5834 tls12_prf->left_in_block -= length;
5835 }
5836
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005838}
John Durkop07cc04a2020-11-16 22:08:34 -08005839#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5840 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005841
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005842#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5843static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5844 psa_tls12_ecjpake_to_pms_t *ecjpake,
5845 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005847{
5848 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005849 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005850
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 if (output_length != 32) {
5852 return PSA_ERROR_INVALID_ARGUMENT;
5853 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005854
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5856 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5857 &output_size);
5858 if (status != PSA_SUCCESS) {
5859 return status;
5860 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005861
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 if (output_size != output_length) {
5863 return PSA_ERROR_GENERIC_ERROR;
5864 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005865
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005867}
5868#endif
5869
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305870#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305871static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5872 psa_pbkdf2_key_derivation_t *pbkdf2,
5873 psa_algorithm_t prf_alg,
5874 uint8_t prf_output_length,
5875 psa_key_attributes_t *attributes)
5876{
5877 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305878 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305879 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305880 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305881 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305882 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305883 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305884
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305885 mac_operation.is_sign = 1;
5886 mac_operation.mac_size = prf_output_length;
5887 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305888
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305889 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5890 attributes,
5891 pbkdf2->password,
5892 pbkdf2->password_length,
5893 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305894 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305895 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305896 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305897 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5898 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305899 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305900 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305901 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305902 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305903 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305904 }
5905 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5906 &mac_output_length);
5907 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305908 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305909 }
5910
5911 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305912 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305913 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305914 }
5915
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305916 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305917
5918 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305919 /* We are passing prf_output_length as mac_size because the driver
5920 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305921 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305922 status = psa_driver_wrapper_mac_compute(attributes,
5923 pbkdf2->password,
5924 pbkdf2->password_length,
5925 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305926 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305927 &mac_output_length);
5928 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305929 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305930 }
5931
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305932 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305933 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305934
5935cleanup:
5936 /* Zeroise buffers to clear sensitive data from memory. */
5937 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5938 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305939}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305940
5941static psa_status_t psa_key_derivation_pbkdf2_read(
5942 psa_pbkdf2_key_derivation_t *pbkdf2,
5943 psa_algorithm_t kdf_alg,
5944 uint8_t *output,
5945 size_t output_length)
5946{
5947 psa_status_t status;
5948 psa_algorithm_t prf_alg;
5949 uint8_t prf_output_length;
5950 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5951 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5952 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5953
5954 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5955 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5956 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5957 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305958 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5959 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305960 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305961 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305962 } else {
5963 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305964 }
5965
5966 switch (pbkdf2->state) {
5967 case PSA_PBKDF2_STATE_PASSWORD_SET:
5968 /* Initially we need a new block so bytes_used is equal to block size*/
5969 pbkdf2->bytes_used = prf_output_length;
5970 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5971 break;
5972 case PSA_PBKDF2_STATE_OUTPUT:
5973 break;
5974 default:
5975 return PSA_ERROR_BAD_STATE;
5976 }
5977
5978 while (output_length != 0) {
5979 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5980 if (n > output_length) {
5981 n = (uint8_t) output_length;
5982 }
5983 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5984 output += n;
5985 output_length -= n;
5986 pbkdf2->bytes_used += n;
5987
5988 if (output_length == 0) {
5989 break;
5990 }
5991
5992 /* We need a new block */
5993 pbkdf2->bytes_used = 0;
5994 pbkdf2->block_number++;
5995
5996 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5997 prf_output_length,
5998 &attributes);
5999 if (status != PSA_SUCCESS) {
6000 return status;
6001 }
6002 }
6003
6004 return PSA_SUCCESS;
6005}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306006#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306007
Janos Follath6c6c8fc2019-06-17 12:38:20 +01006008psa_status_t psa_key_derivation_output_bytes(
6009 psa_key_derivation_operation_t *operation,
Ryan Everettf943e222024-01-19 14:46:39 +00006010 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006012{
6013 psa_status_t status;
Ryan Everettf943e222024-01-19 14:46:39 +00006014 LOCAL_OUTPUT_DECLARE(output_external, output);
6015
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02006017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006019 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006021 }
6022
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006024 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006025 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02006026 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
6027 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006028 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02006029 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006031 }
Ryan Everettf943e222024-01-19 14:46:39 +00006032
6033 LOCAL_OUTPUT_ALLOC(output_external, output_length, output);
Ryan Everettda9227d2024-01-25 11:37:22 +00006034 if (output_length > operation->capacity) {
6035 operation->capacity = 0;
6036 /* Go through the error path to wipe all confidential data now
6037 * that the operation object is useless. */
6038 status = PSA_ERROR_INSUFFICIENT_DATA;
6039 goto exit;
6040 }
6041
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006042 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006043
Przemek Stekiel69c46792022-06-10 12:59:51 +02006044#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6046 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
6047 output, output_length);
6048 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006049#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006050#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6051 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6053 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6054 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
6055 kdf_alg, output,
6056 output_length);
6057 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006058#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
6059 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006060#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006062 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
6064 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006065#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306066#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306067 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306068 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
6069 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05306070 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306071#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006072
Gilles Peskineeab56e42018-07-12 17:12:33 +02006073 {
Steven Cooreman74afe472021-02-10 17:19:22 +01006074 (void) kdf_alg;
Ryan Everettf943e222024-01-19 14:46:39 +00006075 status = PSA_ERROR_BAD_STATE;
6076 LOCAL_OUTPUT_FREE(output_external, output);
6077
6078 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006079 }
6080
6081exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006083 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006084 * This allows us to differentiate between exhausted operations and
6085 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
6086 * operations. */
6087 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006089 operation->alg = alg;
Ryan Everettee5920a2024-02-09 15:09:28 +00006090 if (output != NULL) {
6091 memset(output, '!', output_length);
6092 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006093 }
Ryan Everettda9227d2024-01-25 11:37:22 +00006094
6095 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006097}
6098
David Brown7807bf72021-02-09 16:28:23 -07006099#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006100static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02006101{
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 if (data_size >= 8) {
6103 mbedtls_des_key_set_parity(data);
6104 }
6105 if (data_size >= 16) {
6106 mbedtls_des_key_set_parity(data + 8);
6107 }
6108 if (data_size >= 24) {
6109 mbedtls_des_key_set_parity(data + 16);
6110 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006111}
David Brown7807bf72021-02-09 16:28:23 -07006112#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006113
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006114/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 * ECC keys on a Weierstrass elliptic curve require the generation
6116 * of a private key which is an integer
6117 * in the range [1, N - 1], where N is the boundary of the private key domain:
6118 * N is the prime p for Diffie-Hellman, or the order of the
6119 * curve’s base point for ECC.
6120 *
6121 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6122 * This function generates the private key using the following process:
6123 *
6124 * 1. Draw a byte string of length ceiling(m/8) bytes.
6125 * 2. If m is not a multiple of 8, set the most significant
6126 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6127 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6128 * 4. If k > N - 2, discard the result and return to step 1.
6129 * 5. Output k + 1 as the private key.
6130 *
6131 * This method allows compliance to NIST standards, specifically the methods titled
6132 * Key-Pair Generation by Testing Candidates in the following publications:
6133 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6134 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6135 * Diffie-Hellman keys.
6136 *
6137 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6138 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6139 *
6140 * Note: Function allocates memory for *data buffer, so given *data should be
6141 * always NULL.
6142 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006143#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6144#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006145static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006146 psa_key_slot_t *slot,
6147 size_t bits,
6148 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006149 uint8_t **data
6150 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006151{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006152 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006153 mbedtls_mpi k;
6154 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006155 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006156 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006157 size_t m;
6158 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006159
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 mbedtls_mpi_init(&k);
6161 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006162
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006163 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006165 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01006166 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006167
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006169 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006170 goto cleanup;
6171 }
6172
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006173 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006175
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006177
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006178 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006179 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006180 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006181
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006182 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006183
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006184 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006186
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006187 /* Note: This function is always called with *data == NULL and it
6188 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 *data = mbedtls_calloc(1, m_bytes);
6190 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006191 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006192 goto cleanup;
6193 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006194
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006196 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006198 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006200
6201 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006203 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006204 * (8 * ceiling(m/8) - m) bits of the first byte in
6205 * the string to zero.
6206 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006208 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006209 }
6210
6211 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 * big-endian byte string.
6213 */
6214 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006215
6216 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 * Result of comparison is returned. When it indicates error
6218 * then this function is called again.
6219 */
6220 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006221 }
6222
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006223 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6225 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006226cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 if (ret != 0) {
6228 status = mbedtls_to_psa_error(ret);
6229 }
6230 if (status != PSA_SUCCESS) {
6231 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006232 *data = NULL;
6233 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 mbedtls_mpi_free(&k);
6235 mbedtls_mpi_free(&diff_N_2);
6236 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006237}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006238
6239/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6240 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6241 *
6242 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6243 * draw a 32-byte string and process it as specified in
6244 * Elliptic Curves for Security [RFC7748] §5.
6245 *
6246 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6247 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6248 *
6249 * Note: Function allocates memory for *data buffer, so given *data should be
6250 * always NULL.
6251 */
6252
6253static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6254 size_t bits,
6255 psa_key_derivation_operation_t *operation,
6256 uint8_t **data
6257 )
6258{
6259 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006260 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006261
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006263 case 255:
6264 output_length = 32;
6265 break;
6266 case 448:
6267 output_length = 56;
6268 break;
6269 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006271 break;
6272 }
6273
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006275
Gilles Peskine449bd832023-01-11 14:50:10 +01006276 if (*data == NULL) {
6277 return PSA_ERROR_INSUFFICIENT_MEMORY;
6278 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006279
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006281
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006283 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006285
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006287 case 255:
6288 (*data)[0] &= 248;
6289 (*data)[31] &= 127;
6290 (*data)[31] |= 64;
6291 break;
6292 case 448:
6293 (*data)[0] &= 252;
6294 (*data)[55] |= 128;
6295 break;
6296 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006298 break;
6299 }
6300
6301 return status;
6302}
Valerio Setti86587ab2023-06-27 13:09:30 +02006303#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6304static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6305 psa_key_slot_t *slot, size_t bits,
6306 psa_key_derivation_operation_t *operation, uint8_t **data)
6307{
6308 (void) slot;
6309 (void) bits;
6310 (void) operation;
6311 (void) data;
6312 return PSA_ERROR_NOT_SUPPORTED;
6313}
6314
6315static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6316 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6317{
6318 (void) bits;
6319 (void) operation;
6320 (void) data;
6321 return PSA_ERROR_NOT_SUPPORTED;
6322}
6323#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6324#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006325
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006326static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006327 psa_key_slot_t *slot,
6328 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006330{
6331 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306333 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006334 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006335 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006336
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6338 return PSA_ERROR_INVALID_ARGUMENT;
6339 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006340
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006341#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006342 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6344 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6345 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006346 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6348 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006349 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 }
6351 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006352 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006353 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6354 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006355 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006357 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006358 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006359#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006360 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006361 if (key_type_is_raw_bytes(slot->attr.type)) {
6362 if (bits % 8 != 0) {
6363 return PSA_ERROR_INVALID_ARGUMENT;
6364 }
6365 data = mbedtls_calloc(1, bytes);
6366 if (data == NULL) {
6367 return PSA_ERROR_INSUFFICIENT_MEMORY;
6368 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006369
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 status = psa_key_derivation_output_bytes(operation, data, bytes);
6371 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006372 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 }
David Brown12ca5032021-02-11 11:02:00 -07006374#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6376 psa_des_set_key_parity(data, bytes);
6377 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006378#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 } else {
6380 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006381 }
Ronald Crondd04d422020-11-28 15:14:42 +01006382
Ronald Cronbf33c932020-11-28 18:06:53 +01006383 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006384 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006385 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006386 };
6387
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6389 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6390 &storage_size);
6391 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306392 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 }
Archanad8a83dc2021-06-14 10:04:16 +05306394 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 status = psa_allocate_buffer_to_slot(slot, storage_size);
6396 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306397 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006398 }
Archanad8a83dc2021-06-14 10:04:16 +05306399
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 status = psa_driver_wrapper_import_key(&attributes,
6401 data, bytes,
6402 slot->key.data,
6403 slot->key.bytes,
6404 &slot->key.bytes, &bits);
6405 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006406 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006408
6409exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 mbedtls_free(data);
6411 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006412}
6413
Gilles Peskine449bd832023-01-11 14:50:10 +01006414psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6415 psa_key_derivation_operation_t *operation,
6416 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006417{
6418 psa_status_t status;
6419 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006420 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006421
Ronald Cron81709fc2020-11-14 12:10:32 +01006422 *key = MBEDTLS_SVC_KEY_ID_INIT;
6423
Gilles Peskine0f84d622019-09-12 19:03:13 +02006424 /* Reject any attempt to create a zero-length key so that we don't
6425 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 if (psa_get_key_bits(attributes) == 0) {
6427 return PSA_ERROR_INVALID_ARGUMENT;
6428 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006429
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 if (operation->alg == PSA_ALG_NONE) {
6431 return PSA_ERROR_BAD_STATE;
6432 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006433
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 if (!operation->can_output_key) {
6435 return PSA_ERROR_NOT_PERMITTED;
6436 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006437
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6439 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006440#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006442 /* Deriving a key in a secure element is not implemented yet. */
6443 status = PSA_ERROR_NOT_SUPPORTED;
6444 }
6445#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 if (status == PSA_SUCCESS) {
6447 status = psa_generate_derived_key_internal(slot,
6448 attributes->core.bits,
6449 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006450 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006451 if (status == PSA_SUCCESS) {
6452 status = psa_finish_key_creation(slot, driver, key);
6453 }
6454 if (status != PSA_SUCCESS) {
6455 psa_fail_key_creation(slot, driver);
6456 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006457
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006459}
6460
Gilles Peskineeab56e42018-07-12 17:12:33 +02006461
6462
6463/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006464/* Key derivation */
6465/****************************************************************/
6466
Steven Cooreman932ffb72021-02-15 12:14:32 +01006467#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006468static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006469{
6470#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6472 return 1;
6473 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006474#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006475#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6477 return 1;
6478 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006479#endif
6480#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6482 return 1;
6483 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006484#endif
6485#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6487 return 1;
6488 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006489#endif
6490#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6492 return 1;
6493 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006494#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006495#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6497 return 1;
6498 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006499#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306500#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6501 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6502 return 1;
6503 }
6504#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306505#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6506 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6507 return 1;
6508 }
6509#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006510 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006511}
6512
Gilles Peskine449bd832023-01-11 14:50:10 +01006513static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006514{
6515 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 psa_status_t status = psa_hash_setup(&operation, alg);
6517 psa_hash_abort(&operation);
6518 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006519}
6520
Gilles Peskine969c5d62019-01-16 15:53:06 +01006521static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006522 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006524{
Janos Follath5fe19732019-06-20 15:09:30 +01006525 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6526 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006527 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006528
Gilles Peskine969c5d62019-01-16 15:53:06 +01006529 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 if (!is_kdf_alg_supported(kdf_alg)) {
6531 return PSA_ERROR_NOT_SUPPORTED;
6532 }
John Durkop07cc04a2020-11-16 22:08:34 -08006533
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006534 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306535 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6537 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306538 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6539 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6540 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306541 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306542 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 if (hash_size == 0) {
6544 return PSA_ERROR_NOT_SUPPORTED;
6545 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006546
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006547 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6548 * we might fail later, which is somewhat unfriendly and potentially
6549 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 psa_status_t status = psa_hash_try_support(hash_alg);
6551 if (status != PSA_SUCCESS) {
6552 return status;
6553 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006554 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006555
Gilles Peskine449bd832023-01-11 14:50:10 +01006556 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6557 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6558 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6559 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006560 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006561#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006562 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6564 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006565 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006567#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6568 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006569 operation->capacity = 255 * hash_size;
6570 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006571}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006572
Gilles Peskine449bd832023-01-11 14:50:10 +01006573static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006574{
6575#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 if (alg == PSA_ALG_ECDH) {
6577 return PSA_SUCCESS;
6578 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006579#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006580#if defined(PSA_WANT_ALG_FFDH)
6581 if (alg == PSA_ALG_FFDH) {
6582 return PSA_SUCCESS;
6583 }
6584#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006585 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006586 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006587}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006588
6589static int psa_key_derivation_allows_free_form_secret_input(
6590 psa_algorithm_t kdf_alg)
6591{
6592#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6593 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6594 return 0;
6595 }
6596#endif
6597 (void) kdf_alg;
6598 return 1;
6599}
John Durkop07cc04a2020-11-16 22:08:34 -08006600#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006601
Gilles Peskine449bd832023-01-11 14:50:10 +01006602psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6603 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006604{
6605 psa_status_t status;
6606
Gilles Peskine449bd832023-01-11 14:50:10 +01006607 if (operation->alg != 0) {
6608 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006609 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006610
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6612 return PSA_ERROR_INVALID_ARGUMENT;
6613 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6614#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6615 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6616 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6617 status = psa_key_agreement_try_support(ka_alg);
6618 if (status != PSA_SUCCESS) {
6619 return status;
6620 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006621 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6622 return PSA_ERROR_INVALID_ARGUMENT;
6623 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6625#else
6626 return PSA_ERROR_NOT_SUPPORTED;
6627#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6628 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6629#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6630 status = psa_key_derivation_setup_kdf(operation, alg);
6631#else
6632 return PSA_ERROR_NOT_SUPPORTED;
6633#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6634 } else {
6635 return PSA_ERROR_INVALID_ARGUMENT;
6636 }
6637
6638 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006639 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 }
6641 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006642}
6643
Przemek Stekiel69c46792022-06-10 12:59:51 +02006644#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006645static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6646 psa_algorithm_t kdf_alg,
6647 psa_key_derivation_step_t step,
6648 const uint8_t *data,
6649 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006650{
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006652 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006654 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006655#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6657 return PSA_ERROR_INVALID_ARGUMENT;
6658 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006659#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006660 if (hkdf->state != HKDF_STATE_INIT) {
6661 return PSA_ERROR_BAD_STATE;
6662 } else {
6663 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6664 hash_alg,
6665 data, data_length);
6666 if (status != PSA_SUCCESS) {
6667 return status;
6668 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006669 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006671 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006672 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006673#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006675 /* We shouldn't be in different state as HKDF_EXPAND only allows
6676 * two inputs: SECRET (this case) and INFO which does not modify
6677 * the state. It could happen only if the hkdf
6678 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 if (hkdf->state != HKDF_STATE_INIT) {
6680 return PSA_ERROR_BAD_STATE;
6681 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006682
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006683 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006684 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6685 return PSA_ERROR_INVALID_ARGUMENT;
6686 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006687
Gilles Peskine449bd832023-01-11 14:50:10 +01006688 memcpy(hkdf->prk, data, data_length);
6689 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006690#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006691 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006692 /* HKDF: If no salt was provided, use an empty salt.
6693 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006694 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006695#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006696 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6697 return PSA_ERROR_BAD_STATE;
6698 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006699#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6701 hash_alg,
6702 NULL, 0);
6703 if (status != PSA_SUCCESS) {
6704 return status;
6705 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006706 hkdf->state = HKDF_STATE_STARTED;
6707 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 if (hkdf->state != HKDF_STATE_STARTED) {
6709 return PSA_ERROR_BAD_STATE;
6710 }
6711 status = psa_mac_update(&hkdf->hmac,
6712 data, data_length);
6713 if (status != PSA_SUCCESS) {
6714 return status;
6715 }
6716 status = psa_mac_sign_finish(&hkdf->hmac,
6717 hkdf->prk,
6718 sizeof(hkdf->prk),
6719 &data_length);
6720 if (status != PSA_SUCCESS) {
6721 return status;
6722 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006723 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006724
Gilles Peskine2b522db2019-04-12 15:11:49 +02006725 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006726 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006727#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006729 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006731 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006733#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006734 {
6735 /* Block 0 is empty, and the next block will be
6736 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006737 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006738 }
6739
Gilles Peskine449bd832023-01-11 14:50:10 +01006740 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006741 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006742#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6744 return PSA_ERROR_INVALID_ARGUMENT;
6745 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006746#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006747#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006748 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6749 hkdf->state == HKDF_STATE_INIT) {
6750 return PSA_ERROR_BAD_STATE;
6751 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006752#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006753 if (hkdf->state == HKDF_STATE_OUTPUT) {
6754 return PSA_ERROR_BAD_STATE;
6755 }
6756 if (hkdf->info_set) {
6757 return PSA_ERROR_BAD_STATE;
6758 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006759 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 if (data_length != 0) {
6761 hkdf->info = mbedtls_calloc(1, data_length);
6762 if (hkdf->info == NULL) {
6763 return PSA_ERROR_INSUFFICIENT_MEMORY;
6764 }
6765 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006766 }
6767 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006769 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006770 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006771 }
6772}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006773#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006774
John Durkop07cc04a2020-11-16 22:08:34 -08006775#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6776 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006777static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6778 const uint8_t *data,
6779 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006780{
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6782 return PSA_ERROR_BAD_STATE;
6783 }
Janos Follathf08e2652019-06-13 09:05:41 +01006784
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 if (data_length != 0) {
6786 prf->seed = mbedtls_calloc(1, data_length);
6787 if (prf->seed == NULL) {
6788 return PSA_ERROR_INSUFFICIENT_MEMORY;
6789 }
Janos Follathf08e2652019-06-13 09:05:41 +01006790
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006792 prf->seed_length = data_length;
6793 }
Janos Follathf08e2652019-06-13 09:05:41 +01006794
Gilles Peskine43f958b2020-12-13 14:55:14 +01006795 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006796
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006798}
6799
Gilles Peskine449bd832023-01-11 14:50:10 +01006800static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6801 const uint8_t *data,
6802 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006803{
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6805 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6806 return PSA_ERROR_BAD_STATE;
6807 }
Janos Follath81550542019-06-13 14:26:34 +01006808
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 if (data_length != 0) {
6810 prf->secret = mbedtls_calloc(1, data_length);
6811 if (prf->secret == NULL) {
6812 return PSA_ERROR_INSUFFICIENT_MEMORY;
6813 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006814
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006816 prf->secret_length = data_length;
6817 }
Janos Follath81550542019-06-13 14:26:34 +01006818
Gilles Peskine43f958b2020-12-13 14:55:14 +01006819 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006822}
6823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6825 const uint8_t *data,
6826 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006827{
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6829 return PSA_ERROR_BAD_STATE;
6830 }
Janos Follath63028dd2019-06-13 09:15:47 +01006831
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 if (data_length != 0) {
6833 prf->label = mbedtls_calloc(1, data_length);
6834 if (prf->label == NULL) {
6835 return PSA_ERROR_INSUFFICIENT_MEMORY;
6836 }
Janos Follath63028dd2019-06-13 09:15:47 +01006837
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006839 prf->label_length = data_length;
6840 }
Janos Follath63028dd2019-06-13 09:15:47 +01006841
Gilles Peskine43f958b2020-12-13 14:55:14 +01006842 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006843
Gilles Peskine449bd832023-01-11 14:50:10 +01006844 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006845}
6846
Gilles Peskine449bd832023-01-11 14:50:10 +01006847static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6848 psa_key_derivation_step_t step,
6849 const uint8_t *data,
6850 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006851{
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006853 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006855 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006857 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006859 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006861 }
6862}
John Durkop07cc04a2020-11-16 22:08:34 -08006863#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6864 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6865
6866#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6867static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6868 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006869 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006871{
6872 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6874 4 + data_length + prf->other_secret_length :
6875 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006876
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6878 return PSA_ERROR_INVALID_ARGUMENT;
6879 }
John Durkop07cc04a2020-11-16 22:08:34 -08006880
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 uint8_t *pms = mbedtls_calloc(1, pms_len);
6882 if (pms == NULL) {
6883 return PSA_ERROR_INSUFFICIENT_MEMORY;
6884 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006885 uint8_t *cur = pms;
6886
6887 /* pure-PSK:
6888 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006889 *
6890 * The premaster secret is formed as follows: if the PSK is N octets
6891 * long, concatenate a uint16 with the value N, N zero octets, a second
6892 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006893 *
6894 * mixed-PSK:
6895 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6896 * follows: concatenate a uint16 with the length of the other secret,
6897 * the other secret itself, uint16 with the length of PSK, and the
6898 * PSK itself.
6899 * For details please check:
6900 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6901 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6902 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006903 */
6904
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6906 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6907 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6908 if (prf->other_secret_length != 0) {
6909 memcpy(cur, prf->other_secret, prf->other_secret_length);
6910 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006911 cur += prf->other_secret_length;
6912 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 } else {
6914 *cur++ = MBEDTLS_BYTE_1(data_length);
6915 *cur++ = MBEDTLS_BYTE_0(data_length);
6916 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006917 cur += data_length;
6918 }
6919
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 *cur++ = MBEDTLS_BYTE_1(data_length);
6921 *cur++ = MBEDTLS_BYTE_0(data_length);
6922 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006923 cur += data_length;
6924
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006925 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006926
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006927 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006929}
Janos Follath6660f0e2019-06-17 08:44:03 +01006930
Przemek Stekiele47201b2022-04-19 13:53:28 +02006931static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6932 psa_tls12_prf_key_derivation_t *prf,
6933 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006935{
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6937 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006938 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006939
6940 if (data_length != 0) {
6941 prf->other_secret = mbedtls_calloc(1, data_length);
6942 if (prf->other_secret == NULL) {
6943 return PSA_ERROR_INSUFFICIENT_MEMORY;
6944 }
6945
6946 memcpy(prf->other_secret, data, data_length);
6947 prf->other_secret_length = data_length;
6948 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006949 prf->other_secret_length = 0;
6950 }
6951
6952 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6953
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006955}
6956
Janos Follath6660f0e2019-06-17 08:44:03 +01006957static psa_status_t psa_tls12_prf_psk_to_ms_input(
6958 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006959 psa_key_derivation_step_t step,
6960 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006961 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006962{
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006964 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 return psa_tls12_prf_psk_to_ms_set_key(prf,
6966 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006967 break;
6968 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6970 data,
6971 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006972 break;
6973 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006975 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006976
Przemek Stekiele47201b2022-04-19 13:53:28 +02006977 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006978}
John Durkop07cc04a2020-11-16 22:08:34 -08006979#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006980
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006981#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6982static psa_status_t psa_tls12_ecjpake_to_pms_input(
6983 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006984 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006985 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006987{
Gilles Peskine449bd832023-01-11 14:50:10 +01006988 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6989 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6990 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006991 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006992
6993 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 if (data[0] != 0x04) {
6995 return PSA_ERROR_INVALID_ARGUMENT;
6996 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006997
6998 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007000
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007002}
7003#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307004
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307005#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307006static psa_status_t psa_pbkdf2_set_input_cost(
7007 psa_pbkdf2_key_derivation_t *pbkdf2,
7008 psa_key_derivation_step_t step,
7009 uint64_t data)
7010{
7011 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
7012 return PSA_ERROR_INVALID_ARGUMENT;
7013 }
7014
7015 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
7016 return PSA_ERROR_BAD_STATE;
7017 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307018
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307019 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307020 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307021 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307022
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307023 if (data == 0) {
7024 return PSA_ERROR_INVALID_ARGUMENT;
7025 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307026
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307027 pbkdf2->input_cost = data;
7028 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
7029
7030 return PSA_SUCCESS;
7031}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307032
7033static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
7034 const uint8_t *data,
7035 size_t data_length)
7036{
Gilles Peskineead17662023-08-20 22:02:51 +02007037 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
7038 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
7039 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
7040 /* Appending to existing salt. No state change. */
7041 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307042 return PSA_ERROR_BAD_STATE;
7043 }
7044
Gilles Peskineca57d782023-07-20 19:08:06 +02007045 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02007046 /* Appending an empty string, nothing to do. */
7047 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307048 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05307049
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307050 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
7051 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307052 return PSA_ERROR_INSUFFICIENT_MEMORY;
7053 }
7054
Gilles Peskineead17662023-08-20 22:02:51 +02007055 if (pbkdf2->salt_length != 0) {
7056 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
7057 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307058 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307059 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307060 mbedtls_free(pbkdf2->salt);
7061 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307062 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307063 return PSA_SUCCESS;
7064}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307065
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307066#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307067static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307068 const uint8_t *input,
7069 size_t input_len,
7070 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05307071 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307072{
7073 psa_status_t status = PSA_SUCCESS;
7074 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007075 return psa_hash_compute(hash_alg, input, input_len, output,
7076 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
7077 } else if (input_len > 0) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307078 memcpy(output, input, input_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307079 }
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007080 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307081 return status;
7082}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307083#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307084
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307085#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307086static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
7087 size_t input_len,
7088 uint8_t *output,
7089 size_t *output_len)
7090{
7091 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307092 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307093 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05307094 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307095 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
7096 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
7097 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307098 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05307099 * mac_size as the driver function sets mac_output_length = mac_size
7100 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307101 status = psa_driver_wrapper_mac_compute(&attributes,
7102 zeros, sizeof(zeros),
7103 PSA_ALG_CMAC, input, input_len,
7104 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307105 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7106 128U,
7107 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307108 output_len);
7109 } else {
7110 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307111 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307112 }
7113 return status;
7114}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307115#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307116
7117static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307118 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307119 const uint8_t *data,
7120 size_t data_length)
7121{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307122 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307123 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7124 return PSA_ERROR_BAD_STATE;
7125 }
7126
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307127#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307128 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7129 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7130 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7131 pbkdf2->password,
7132 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307133 } else
7134#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7135#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7136 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307137 status = psa_pbkdf2_cmac_set_password(data, data_length,
7138 pbkdf2->password,
7139 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307140 } else
7141#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7142 {
7143 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307144 }
7145
7146 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7147
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307148 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307149}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307150
7151static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307152 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307153 psa_key_derivation_step_t step,
7154 const uint8_t *data,
7155 size_t data_length)
7156{
7157 switch (step) {
7158 case PSA_KEY_DERIVATION_INPUT_SALT:
7159 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7160 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307161 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307162 default:
7163 return PSA_ERROR_INVALID_ARGUMENT;
7164 }
7165}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307166#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307167
Gilles Peskineb8965192019-09-24 16:21:10 +02007168/** Check whether the given key type is acceptable for the given
7169 * input step of a key derivation.
7170 *
7171 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7172 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7173 * Both secret and non-secret inputs can alternatively have the type
7174 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7175 * that the input was passed as a buffer rather than via a key object.
7176 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007177static int psa_key_derivation_check_input_type(
7178 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007180{
Gilles Peskine449bd832023-01-11 14:50:10 +01007181 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007182 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 if (key_type == PSA_KEY_TYPE_DERIVE) {
7184 return PSA_SUCCESS;
7185 }
7186 if (key_type == PSA_KEY_TYPE_NONE) {
7187 return PSA_SUCCESS;
7188 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007189 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007190 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 if (key_type == PSA_KEY_TYPE_DERIVE) {
7192 return PSA_SUCCESS;
7193 }
7194 if (key_type == PSA_KEY_TYPE_NONE) {
7195 return PSA_SUCCESS;
7196 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007197 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007198 case PSA_KEY_DERIVATION_INPUT_LABEL:
7199 case PSA_KEY_DERIVATION_INPUT_SALT:
7200 case PSA_KEY_DERIVATION_INPUT_INFO:
7201 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7203 return PSA_SUCCESS;
7204 }
7205 if (key_type == PSA_KEY_TYPE_NONE) {
7206 return PSA_SUCCESS;
7207 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007208 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307209 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7210 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7211 return PSA_SUCCESS;
7212 }
7213 if (key_type == PSA_KEY_TYPE_DERIVE) {
7214 return PSA_SUCCESS;
7215 }
7216 if (key_type == PSA_KEY_TYPE_NONE) {
7217 return PSA_SUCCESS;
7218 }
7219 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007220 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007221 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007222}
7223
Janos Follathb80a94e2019-06-12 15:54:46 +01007224static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007225 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007226 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007227 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007228 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007230{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007231 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007232 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007233
Gilles Peskine449bd832023-01-11 14:50:10 +01007234 status = psa_key_derivation_check_input_type(step, key_type);
7235 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007236 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007238
Przemek Stekiel69c46792022-06-10 12:59:51 +02007239#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7241 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7242 step, data, data_length);
7243 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007244#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007245#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007246 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7247 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7248 step, data, data_length);
7249 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007250#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7251#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7253 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7254 step, data, data_length);
7255 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007256#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007257#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007259 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7261 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007262#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307263#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307264 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307265 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7266 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307267 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307268#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007269 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007270 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007271 (void) data;
7272 (void) data_length;
7273 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007274 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007275 }
7276
Gilles Peskine224b0d62019-09-23 18:13:17 +02007277exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 if (status != PSA_SUCCESS) {
7279 psa_key_derivation_abort(operation);
7280 }
7281 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007282}
7283
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307284static psa_status_t psa_key_derivation_input_integer_internal(
7285 psa_key_derivation_operation_t *operation,
7286 psa_key_derivation_step_t step,
7287 uint64_t value)
7288{
7289 psa_status_t status;
7290 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7291
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307292#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307293 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307294 status = psa_pbkdf2_set_input_cost(
7295 &operation->ctx.pbkdf2, step, value);
7296 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307297#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307298 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307299 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307300 (void) value;
7301 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307302 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307303 }
7304
7305 if (status != PSA_SUCCESS) {
7306 psa_key_derivation_abort(operation);
7307 }
7308 return status;
7309}
7310
Janos Follath51f4a0f2019-06-14 11:35:55 +01007311psa_status_t psa_key_derivation_input_bytes(
7312 psa_key_derivation_operation_t *operation,
7313 psa_key_derivation_step_t step,
Ryan Everettd1e398c2024-01-19 14:46:00 +00007314 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007316{
Ryan Everettd1e398c2024-01-19 14:46:00 +00007317 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7318 LOCAL_INPUT_DECLARE(data_external, data);
7319
7320 LOCAL_INPUT_ALLOC(data_external, data_length, data);
7321
7322 status = psa_key_derivation_input_internal(operation, step,
7323 PSA_KEY_TYPE_NONE,
7324 data, data_length);
Ryan Everettb41c3c92024-01-25 11:56:35 +00007325#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everettd1e398c2024-01-19 14:46:00 +00007326exit:
Ryan Everettb41c3c92024-01-25 11:56:35 +00007327#endif
Ryan Everettd1e398c2024-01-19 14:46:00 +00007328 LOCAL_INPUT_FREE(data_external, data);
7329 return status;
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007330}
7331
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307332psa_status_t psa_key_derivation_input_integer(
7333 psa_key_derivation_operation_t *operation,
7334 psa_key_derivation_step_t step,
7335 uint64_t value)
7336{
7337 return psa_key_derivation_input_integer_internal(operation, step, value);
7338}
7339
Janos Follath51f4a0f2019-06-14 11:35:55 +01007340psa_status_t psa_key_derivation_input_key(
7341 psa_key_derivation_operation_t *operation,
7342 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007344{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007345 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007346 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007347 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007348
Ronald Cron5c522922020-11-14 16:35:34 +01007349 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007350 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7351 if (status != PSA_SUCCESS) {
7352 psa_key_derivation_abort(operation);
7353 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007354 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007355
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307356 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7357 * permission to output to a key object. */
7358 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7359 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007360 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007362
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 status = psa_key_derivation_input_internal(operation,
7364 step, slot->attr.type,
7365 slot->key.data,
7366 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007367
Ryan Everett1b70a072024-01-04 10:32:49 +00007368 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007369
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007371}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007372
7373
7374
7375/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007376/* Key agreement */
7377/****************************************************************/
7378
Gilles Peskine449bd832023-01-11 14:50:10 +01007379psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7380 const uint8_t *key_buffer,
7381 size_t key_buffer_size,
7382 psa_algorithm_t alg,
7383 const uint8_t *peer_key,
7384 size_t peer_key_length,
7385 uint8_t *shared_secret,
7386 size_t shared_secret_size,
7387 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007388{
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007390#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007391 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7393 key_buffer_size, alg,
7394 peer_key, peer_key_length,
7395 shared_secret,
7396 shared_secret_size,
7397 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007398#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007399
7400#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7401 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007402 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007403 peer_key,
7404 peer_key_length,
7405 key_buffer,
7406 key_buffer_size,
7407 shared_secret,
7408 shared_secret_size,
7409 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007410#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7411
Gilles Peskine01d718c2018-09-18 12:01:02 +02007412 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007413 (void) attributes;
7414 (void) key_buffer;
7415 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007416 (void) peer_key;
7417 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007418 (void) shared_secret;
7419 (void) shared_secret_size;
7420 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007422 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007423}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007424
Aditya Deshpande17845b82022-10-13 17:21:01 +01007425/** Internal function for raw key agreement
7426 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007427 * to the driver's implementation if a driver is present.
7428 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007429 * (psa_key_agreement_raw_builtin).
7430 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007431static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7432 psa_key_slot_t *private_key,
7433 const uint8_t *peer_key,
7434 size_t peer_key_length,
7435 uint8_t *shared_secret,
7436 size_t shared_secret_size,
7437 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007438{
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7440 return PSA_ERROR_NOT_SUPPORTED;
7441 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007442
7443 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007445 };
7446
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 return psa_driver_wrapper_key_agreement(&attributes,
7448 private_key->key.data,
7449 private_key->key.bytes, alg,
7450 peer_key, peer_key_length,
7451 shared_secret,
7452 shared_secret_size,
7453 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007454}
7455
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007456/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007457 * to potentially free embedded data structures and wipe confidential data.
7458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007459static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7460 psa_key_derivation_step_t step,
7461 psa_key_slot_t *private_key,
7462 const uint8_t *peer_key,
7463 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007464{
7465 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007466 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007467 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007469
7470 /* Step 1: run the secret agreement algorithm to generate the shared
7471 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 status = psa_key_agreement_raw_internal(ka_alg,
7473 private_key,
7474 peer_key, peer_key_length,
7475 shared_secret,
7476 sizeof(shared_secret),
7477 &shared_secret_length);
7478 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007479 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007481
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007482 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007483 * the shared secret. A shared secret is permitted wherever a key
7484 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 status = psa_key_derivation_input_internal(operation, step,
7486 PSA_KEY_TYPE_DERIVE,
7487 shared_secret,
7488 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007489exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7491 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007492}
7493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7495 psa_key_derivation_step_t step,
7496 mbedtls_svc_key_id_t private_key,
7497 const uint8_t *peer_key,
7498 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007499{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007500 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007501 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007502 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7505 return PSA_ERROR_INVALID_ARGUMENT;
7506 }
Ronald Cron5c522922020-11-14 16:35:34 +01007507 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7509 if (status != PSA_SUCCESS) {
7510 return status;
7511 }
7512 status = psa_key_agreement_internal(operation, step,
7513 slot,
7514 peer_key, peer_key_length);
7515 if (status != PSA_SUCCESS) {
7516 psa_key_derivation_abort(operation);
7517 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007518 /* If a private key has been added as SECRET, we allow the derived
7519 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007521 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007523 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007524
Ryan Everett1b70a072024-01-04 10:32:49 +00007525 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007526
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007528}
7529
Gilles Peskine449bd832023-01-11 14:50:10 +01007530psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7531 mbedtls_svc_key_id_t private_key,
7532 const uint8_t *peer_key,
7533 size_t peer_key_length,
7534 uint8_t *output,
7535 size_t output_size,
7536 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007537{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007538 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007539 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007540 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007541 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007542
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007544 status = PSA_ERROR_INVALID_ARGUMENT;
7545 goto exit;
7546 }
Ronald Cron5c522922020-11-14 16:35:34 +01007547 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7549 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007550 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007552
Gilles Peskine3e561302022-04-14 00:17:15 +02007553 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7554 * for the output size. The PSA specification only guarantees that this
7555 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7556 * but it might be nice to allow smaller buffers if the output fits.
7557 * At the time of writing this comment, with only ECDH implemented,
7558 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7559 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7560 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007561 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7563 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007564 status = PSA_ERROR_BUFFER_TOO_SMALL;
7565 goto exit;
7566 }
7567
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 status = psa_key_agreement_raw_internal(alg, slot,
7569 peer_key, peer_key_length,
7570 output, output_size,
7571 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007572
7573exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007575 /* If an error happens and is not handled properly, the output
7576 * may be used as a key to protect sensitive data. Arrange for such
7577 * a key to be random, which is likely to result in decryption or
7578 * verification errors. This is better than filling the buffer with
7579 * some constant data such as zeros, which would result in the data
7580 * being protected with a reproducible, easily knowable key.
7581 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007583 *output_length = output_size;
7584 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007585
Ryan Everett1b70a072024-01-04 10:32:49 +00007586 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007587
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007589}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007590
7591
Gilles Peskine30524eb2020-11-13 17:02:26 +01007592
Gilles Peskine86a440b2018-11-12 18:39:40 +01007593/****************************************************************/
7594/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007595/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007596
Gilles Peskine672a7712023-04-28 21:00:28 +02007597#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7598#include "entropy_poll.h"
7599#endif
7600
Gilles Peskine30524eb2020-11-13 17:02:26 +01007601/** Initialize the PSA random generator.
7602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007603static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007604{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007605#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007607#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7608
Gilles Peskine30524eb2020-11-13 17:02:26 +01007609 /* Set default configuration if
7610 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007612 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 }
7614 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007615 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007617
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007619#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7620 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7621 /* The PSA entropy injection feature depends on using NV seed as an entropy
7622 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 mbedtls_entropy_add_source(&rng->entropy,
7624 mbedtls_nv_seed_poll, NULL,
7625 MBEDTLS_ENTROPY_BLOCK_SIZE,
7626 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007627#endif
7628
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007630#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007631}
7632
7633/** Deinitialize the PSA random generator.
7634 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007635static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007636{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007637#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007638 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007639#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007640 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7641 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007642#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007643}
7644
7645/** Seed the PSA random generator.
7646 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007647static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007648{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007649#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7650 /* Do nothing: the external RNG seeds itself. */
7651 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007653#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007654 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7656 drbg_seed, sizeof(drbg_seed) - 1);
7657 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007658#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007659}
7660
Gilles Peskine449bd832023-01-11 14:50:10 +01007661psa_status_t psa_generate_random(uint8_t *output,
7662 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007663{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007664 GUARD_MODULE_INITIALIZED;
7665
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007666#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7667
7668 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7670 output, output_size,
7671 &output_length);
7672 if (status != PSA_SUCCESS) {
7673 return status;
7674 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007675 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007676 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 if (output_length != output_size) {
7678 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7679 }
7680 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007681
7682#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7683
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007685 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7687 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7688 output_size);
7689 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7690 output, request_size);
7691 if (ret != 0) {
7692 return mbedtls_to_psa_error(ret);
7693 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007694 output_size -= request_size;
7695 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007696 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007698#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007699}
7700
Gilles Peskine8814fc42020-12-14 15:33:44 +01007701/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007702 *
7703 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7704 * `psa_generate_random(...)`. The state parameter is ignored since the
7705 * PSA API doesn't support passing an explicit state.
7706 *
7707 * In the non-external case, psa_generate_random() calls an
7708 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7709 * and semantics as mbedtls_psa_get_random(). As an optimization,
7710 * instead of doing this back-and-forth between the PSA API and the
7711 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7712 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007713 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007714#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7715int mbedtls_psa_get_random(void *p_rng,
7716 unsigned char *output,
7717 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007718{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007719 /* This function takes a pointer to the RNG state because that's what
7720 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7721 * its own state internally and doesn't let the caller access that state.
7722 * So we just ignore the state parameter, and in practice we'll pass
7723 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007724 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 psa_status_t status = psa_generate_random(output, output_size);
7726 if (status == PSA_SUCCESS) {
7727 return 0;
7728 } else {
7729 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7730 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007731}
7732#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7733
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007734#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007735psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7736 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007737{
Gilles Peskine449bd832023-01-11 14:50:10 +01007738 if (global_data.initialized) {
7739 return PSA_ERROR_NOT_PERMITTED;
7740 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007741
Gilles Peskine449bd832023-01-11 14:50:10 +01007742 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7743 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7744 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7745 return PSA_ERROR_INVALID_ARGUMENT;
7746 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007747
Gilles Peskine449bd832023-01-11 14:50:10 +01007748 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007749}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007750#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007751
Ronald Cron3772afe2021-02-08 16:10:05 +01007752/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007753 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007754 * \param type The key type
7755 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007756 *
7757 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007758 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007759 * \retval #PSA_ERROR_INVALID_ARGUMENT
7760 * The size in bits of the key is not valid.
7761 * \retval #PSA_ERROR_NOT_SUPPORTED
7762 * The type and/or the size in bits of the key or the combination of
7763 * the two is not supported.
7764 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007765static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007767{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007768 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007769
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 if (key_type_is_raw_bytes(type)) {
7771 status = psa_validate_unstructured_key_bit_size(type, bits);
7772 if (status != PSA_SUCCESS) {
7773 return status;
7774 }
7775 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007776#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007777 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7778 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7779 return PSA_ERROR_NOT_SUPPORTED;
7780 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007781 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007782 return PSA_ERROR_NOT_SUPPORTED;
7783 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007784
Ronald Cron01b2aba2020-10-05 09:42:02 +02007785 /* Accept only byte-aligned keys, for the same reasons as
7786 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 if (bits % 8 != 0) {
7788 return PSA_ERROR_NOT_SUPPORTED;
7789 }
7790 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007791#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007792
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007793#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007795 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 return PSA_SUCCESS;
7797 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007798#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007799
Valerio Settia55f0422023-07-10 15:34:41 +02007800#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007801 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007802 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007803 return PSA_ERROR_NOT_SUPPORTED;
7804 }
7805 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007806#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007807 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007809 }
7810
Gilles Peskine449bd832023-01-11 14:50:10 +01007811 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007812}
7813
Ronald Cron55ed0592020-10-05 10:30:40 +02007814psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007815 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007817{
7818 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007819 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007820
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 if ((attributes->domain_parameters == NULL) &&
7822 (attributes->domain_parameters_size != 0)) {
7823 return PSA_ERROR_INVALID_ARGUMENT;
7824 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007825
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 if (key_type_is_raw_bytes(type)) {
7827 status = psa_generate_random(key_buffer, key_buffer_size);
7828 if (status != PSA_SUCCESS) {
7829 return status;
7830 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007831
David Brown12ca5032021-02-11 11:02:00 -07007832#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 if (type == PSA_KEY_TYPE_DES) {
7834 psa_des_set_key_parity(key_buffer, key_buffer_size);
7835 }
David Brown8107e312021-02-12 08:08:46 -07007836#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007837 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007838
Valerio Setti76df8c12023-07-11 14:11:28 +02007839#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7841 return mbedtls_psa_rsa_generate_key(attributes,
7842 key_buffer,
7843 key_buffer_size,
7844 key_buffer_length);
7845 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007846#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007847
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007848#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7850 return mbedtls_psa_ecp_generate_key(attributes,
7851 key_buffer,
7852 key_buffer_size,
7853 key_buffer_length);
7854 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007855#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007856
Valerio Settia55f0422023-07-10 15:34:41 +02007857#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007858 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7859 return mbedtls_psa_ffdh_generate_key(attributes,
7860 key_buffer,
7861 key_buffer_size,
7862 key_buffer_length);
7863 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007864#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007865 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 (void) key_buffer_length;
7867 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007868 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007869
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007871}
Darryl Green0c6575a2018-11-07 16:05:30 +00007872
Gilles Peskine449bd832023-01-11 14:50:10 +01007873psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7874 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007875{
7876 psa_status_t status;
7877 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007878 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007879 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007880
Ronald Cron81709fc2020-11-14 12:10:32 +01007881 *key = MBEDTLS_SVC_KEY_ID_INIT;
7882
Gilles Peskine0f84d622019-09-12 19:03:13 +02007883 /* Reject any attempt to create a zero-length key so that we don't
7884 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 if (psa_get_key_bits(attributes) == 0) {
7886 return PSA_ERROR_INVALID_ARGUMENT;
7887 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007888
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007889 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7891 return PSA_ERROR_INVALID_ARGUMENT;
7892 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007893
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7895 &slot, &driver);
7896 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007897 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 }
Gilles Peskine11792082019-08-06 18:36:36 +02007899
Ronald Cron977c2472020-10-13 08:32:21 +02007900 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307901 * storage ( thus not in the case of generating a key in a secure element
7902 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7903 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007904 if (slot->key.data == NULL) {
7905 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7906 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007907 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007908 attributes->core.type, attributes->core.bits);
7909 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007910 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007912
7913 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 attributes->core.type,
7915 attributes->core.bits);
7916 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007917 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 attributes, &key_buffer_size);
7919 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007920 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 }
Ronald Cron977c2472020-10-13 08:32:21 +02007922 }
Ronald Cron977c2472020-10-13 08:32:21 +02007923
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7925 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007926 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007927 }
Ronald Cron977c2472020-10-13 08:32:21 +02007928 }
7929
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 status = psa_driver_wrapper_generate_key(attributes,
7931 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007932
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 if (status != PSA_SUCCESS) {
7934 psa_remove_key_data_from_memory(slot);
7935 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007936
Gilles Peskine11792082019-08-06 18:36:36 +02007937exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 if (status == PSA_SUCCESS) {
7939 status = psa_finish_key_creation(slot, driver, key);
7940 }
7941 if (status != PSA_SUCCESS) {
7942 psa_fail_key_creation(slot, driver);
7943 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007944
Gilles Peskine449bd832023-01-11 14:50:10 +01007945 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007946}
7947
Gilles Peskinee59236f2018-01-27 23:32:46 +01007948/****************************************************************/
7949/* Module setup */
7950/****************************************************************/
7951
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007952#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007953psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007954 void (* entropy_init)(mbedtls_entropy_context *ctx),
7955 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007956{
Gilles Peskine449bd832023-01-11 14:50:10 +01007957 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7958 return PSA_ERROR_BAD_STATE;
7959 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007960 global_data.rng.entropy_init = entropy_init;
7961 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007963}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007964#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007965
Gilles Peskine449bd832023-01-11 14:50:10 +01007966void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007967{
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007969 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7970 mbedtls_psa_random_free(&global_data.rng);
7971 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007972 /* Wipe all remaining data, including configuration.
7973 * In particular, this sets all state indicator to the value
7974 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007976
7977 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007979}
7980
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007981#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7982/** Recover a transaction that was interrupted by a power failure.
7983 *
7984 * This function is called during initialization, before psa_crypto_init()
7985 * returns. If this function returns a failure status, the initialization
7986 * fails.
7987 */
7988static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007990{
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007992 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7993 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 /* TODO - fall through to the failure case until this
7995 * is implemented.
7996 * https://github.com/ARMmbed/mbed-crypto/issues/218
7997 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007998 default:
7999 /* We found an unsupported transaction in the storage.
8000 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008002 }
8003}
8004#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
8005
Gilles Peskine449bd832023-01-11 14:50:10 +01008006psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008007{
Gilles Peskine66fb1262018-12-10 16:29:04 +01008008 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008009
Gilles Peskinec6b69072018-11-20 21:42:52 +01008010 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 if (global_data.initialized != 0) {
8012 return PSA_SUCCESS;
8013 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008014
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01008015 /* Init drivers */
8016 status = psa_driver_wrapper_init();
8017 if (status != PSA_SUCCESS) {
8018 goto exit;
8019 }
8020 global_data.drivers_initialized = 1;
8021
Valerio Setti402cfba2023-11-13 10:24:32 +01008022 status = psa_initialize_key_slots();
8023 if (status != PSA_SUCCESS) {
8024 goto exit;
8025 }
8026
Gilles Peskine30524eb2020-11-13 17:02:26 +01008027 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01008029 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 status = mbedtls_psa_random_seed(&global_data.rng);
8031 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01008032 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01008034 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008035
Gilles Peskine4b734222019-07-24 15:56:31 +02008036#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 status = psa_crypto_load_transaction();
8038 if (status == PSA_SUCCESS) {
8039 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
8040 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008041 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 }
8043 status = psa_crypto_stop_transaction();
8044 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02008045 /* There's no transaction to complete. It's all good. */
8046 status = PSA_SUCCESS;
8047 }
Gilles Peskine4b734222019-07-24 15:56:31 +02008048#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02008049
Gilles Peskinec6b69072018-11-20 21:42:52 +01008050 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01008051 global_data.initialized = 1;
8052
8053exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 if (status != PSA_SUCCESS) {
8055 mbedtls_psa_crypto_free();
8056 }
8057 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008058}
8059
Yanray Wangffc3c482023-07-11 12:01:04 +08008060#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008061psa_status_t psa_crypto_driver_pake_get_password_len(
8062 const psa_crypto_driver_pake_inputs_t *inputs,
8063 size_t *password_len)
8064{
8065 if (inputs->password_len == 0) {
8066 return PSA_ERROR_BAD_STATE;
8067 }
8068
8069 *password_len = inputs->password_len;
8070
8071 return PSA_SUCCESS;
8072}
8073
8074psa_status_t psa_crypto_driver_pake_get_password(
8075 const psa_crypto_driver_pake_inputs_t *inputs,
8076 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
8077{
8078 if (inputs->password_len == 0) {
8079 return PSA_ERROR_BAD_STATE;
8080 }
8081
8082 if (buffer_size < inputs->password_len) {
8083 return PSA_ERROR_BUFFER_TOO_SMALL;
8084 }
8085
8086 memcpy(buffer, inputs->password, inputs->password_len);
8087 *buffer_length = inputs->password_len;
8088
8089 return PSA_SUCCESS;
8090}
8091
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008092psa_status_t psa_crypto_driver_pake_get_user_len(
8093 const psa_crypto_driver_pake_inputs_t *inputs,
8094 size_t *user_len)
8095{
8096 if (inputs->user_len == 0) {
8097 return PSA_ERROR_BAD_STATE;
8098 }
8099
8100 *user_len = inputs->user_len;
8101
8102 return PSA_SUCCESS;
8103}
8104
8105psa_status_t psa_crypto_driver_pake_get_user(
8106 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008107 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008108{
8109 if (inputs->user_len == 0) {
8110 return PSA_ERROR_BAD_STATE;
8111 }
8112
Przemek Stekielc0e62502023-03-14 11:49:36 +01008113 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008114 return PSA_ERROR_BUFFER_TOO_SMALL;
8115 }
8116
Przemek Stekielc0e62502023-03-14 11:49:36 +01008117 memcpy(user_id, inputs->user, inputs->user_len);
8118 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008119
8120 return PSA_SUCCESS;
8121}
8122
8123psa_status_t psa_crypto_driver_pake_get_peer_len(
8124 const psa_crypto_driver_pake_inputs_t *inputs,
8125 size_t *peer_len)
8126{
8127 if (inputs->peer_len == 0) {
8128 return PSA_ERROR_BAD_STATE;
8129 }
8130
8131 *peer_len = inputs->peer_len;
8132
8133 return PSA_SUCCESS;
8134}
8135
8136psa_status_t psa_crypto_driver_pake_get_peer(
8137 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008138 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008139{
8140 if (inputs->peer_len == 0) {
8141 return PSA_ERROR_BAD_STATE;
8142 }
8143
Przemek Stekielc0e62502023-03-14 11:49:36 +01008144 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008145 return PSA_ERROR_BUFFER_TOO_SMALL;
8146 }
8147
Przemek Stekielc0e62502023-03-14 11:49:36 +01008148 memcpy(peer_id, inputs->peer, inputs->peer_len);
8149 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008150
8151 return PSA_SUCCESS;
8152}
8153
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008154psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8155 const psa_crypto_driver_pake_inputs_t *inputs,
8156 psa_pake_cipher_suite_t *cipher_suite)
8157{
8158 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8159 return PSA_ERROR_BAD_STATE;
8160 }
8161
8162 *cipher_suite = inputs->cipher_suite;
8163
8164 return PSA_SUCCESS;
8165}
8166
Neil Armstronga7d08c32022-06-01 18:21:20 +02008167psa_status_t psa_pake_setup(
8168 psa_pake_operation_t *operation,
8169 const psa_pake_cipher_suite_t *cipher_suite)
8170{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008171 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008172
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008173 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008174 status = PSA_ERROR_BAD_STATE;
8175 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008176 }
8177
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008178 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008179 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008180 status = PSA_ERROR_INVALID_ARGUMENT;
8181 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008182 }
8183
Przemek Stekiel51eac532022-12-07 11:04:51 +01008184 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8185
Przemek Stekiele12ed362022-12-21 12:54:46 +01008186 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008187 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8188 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008189 operation->data.inputs.cipher_suite = *cipher_suite;
8190
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008191#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008192 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008193 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008194 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008195
David Horstmann16f01512023-06-14 17:21:07 +01008196 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008197 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008198 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008199#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008200 {
8201 status = PSA_ERROR_NOT_SUPPORTED;
8202 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008203 }
8204
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008205 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8206
Przemek Stekiel51eac532022-12-07 11:04:51 +01008207 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008208exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008209 psa_pake_abort(operation);
8210 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008211}
8212
8213psa_status_t psa_pake_set_password_key(
8214 psa_pake_operation_t *operation,
8215 mbedtls_svc_key_id_t password)
8216{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008217 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008218 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8219 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008220 psa_key_attributes_t attributes;
8221 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008222
Przemek Stekiel51eac532022-12-07 11:04:51 +01008223 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008224 status = PSA_ERROR_BAD_STATE;
8225 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008226 }
8227
Przemek Stekiel6c764412022-11-22 14:05:12 +01008228 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8229 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008230 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008231 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008232 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008233 }
8234
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008235 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008236 .core = slot->attr
8237 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008238
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008239 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008240
Przemek Stekiel51eac532022-12-07 11:04:51 +01008241 if (type != PSA_KEY_TYPE_PASSWORD &&
8242 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8243 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008244 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008245 }
8246
Przemek Stekiel51eac532022-12-07 11:04:51 +01008247 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8248 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008249 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008250 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008251 }
8252
8253 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8254 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008255 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008256exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008257 if (status != PSA_SUCCESS) {
8258 psa_pake_abort(operation);
8259 }
Ryan Everett1b70a072024-01-04 10:32:49 +00008260 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008261 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008262}
8263
8264psa_status_t psa_pake_set_user(
8265 psa_pake_operation_t *operation,
8266 const uint8_t *user_id,
8267 size_t user_id_len)
8268{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008269 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008270
8271 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008272 status = PSA_ERROR_BAD_STATE;
8273 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008274 }
8275
Przemek Stekiel51eac532022-12-07 11:04:51 +01008276 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008277 status = PSA_ERROR_INVALID_ARGUMENT;
8278 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008279 }
8280
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008281 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008282 status = PSA_ERROR_BAD_STATE;
8283 goto exit;
8284 }
8285
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008286 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8287 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008288 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8289 goto exit;
8290 }
8291
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008292 memcpy(operation->data.inputs.user, user_id, user_id_len);
8293 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008294
8295 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008296exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008297 psa_pake_abort(operation);
8298 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008299}
8300
8301psa_status_t psa_pake_set_peer(
8302 psa_pake_operation_t *operation,
8303 const uint8_t *peer_id,
8304 size_t peer_id_len)
8305{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008306 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008307
8308 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008309 status = PSA_ERROR_BAD_STATE;
8310 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008311 }
8312
Przemek Stekiel51eac532022-12-07 11:04:51 +01008313 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008314 status = PSA_ERROR_INVALID_ARGUMENT;
8315 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008316 }
8317
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008318 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008319 status = PSA_ERROR_BAD_STATE;
8320 goto exit;
8321 }
8322
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008323 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8324 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008325 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8326 goto exit;
8327 }
8328
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008329 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8330 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008331
8332 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008333exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008334 psa_pake_abort(operation);
8335 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008336}
8337
8338psa_status_t psa_pake_set_role(
8339 psa_pake_operation_t *operation,
8340 psa_pake_role_t role)
8341{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008342 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008343
Przemek Stekiel51eac532022-12-07 11:04:51 +01008344 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008345 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008346 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008347 }
8348
Przemek Stekiel09104b82023-03-06 14:11:51 +01008349 switch (operation->alg) {
8350#if defined(PSA_WANT_ALG_JPAKE)
8351 case PSA_ALG_JPAKE:
8352 if (role == PSA_PAKE_ROLE_NONE) {
8353 return PSA_SUCCESS;
8354 }
8355 status = PSA_ERROR_INVALID_ARGUMENT;
8356 break;
8357#endif
8358 default:
8359 (void) role;
8360 status = PSA_ERROR_NOT_SUPPORTED;
8361 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008362 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008363exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008364 psa_pake_abort(operation);
8365 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008366}
8367
David Horstmanne7f21e62023-05-12 18:17:21 +01008368/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008369#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008370static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008371 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008372{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008373 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008374 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008375 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008376
David Horstmann024e5c52023-06-14 15:48:21 +01008377 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008378 is_x1 = (stage->outputs < 1);
8379 } else {
8380 is_x1 = (stage->inputs < 1);
8381 }
8382
David Horstmann74a3d8c2023-06-14 18:28:19 +01008383 key_share_step = is_x1 ?
8384 PSA_JPAKE_X1_STEP_KEY_SHARE :
8385 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008386 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008387 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8388 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8389 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8390 } else {
8391 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008392 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008393 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008394}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008395#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008396
Przemek Stekiel2797d372022-12-22 11:19:22 +01008397static psa_status_t psa_pake_complete_inputs(
8398 psa_pake_operation_t *operation)
8399{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008400 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008401 /* Create copy of the inputs on stack as inputs share memory
8402 with the driver context which will be setup by the driver. */
8403 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008404
Przemek Stekielfde11282023-03-13 16:06:09 +01008405 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008406 return PSA_ERROR_BAD_STATE;
8407 }
8408
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008409 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008410 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8411 return PSA_ERROR_BAD_STATE;
8412 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008413 }
8414
Przemek Stekiel18620a32023-01-17 16:34:52 +01008415 /* Clear driver context */
8416 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8417
8418 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008419
8420 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008421 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008422
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008423 /* User and peer are translated to role. */
8424 mbedtls_free(inputs.user);
8425 mbedtls_free(inputs.peer);
8426
Przemek Stekiel2797d372022-12-22 11:19:22 +01008427 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008428#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008429 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008430 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008431 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008432#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008433 {
8434 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008435 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008436 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008437 return status;
8438}
8439
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008440#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008441static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008442 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008443 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008444 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008445{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008446 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8447 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8448 step != PSA_PAKE_STEP_ZK_PROOF) {
8449 return PSA_ERROR_INVALID_ARGUMENT;
8450 }
8451
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008452 psa_jpake_computation_stage_t *computation_stage =
8453 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008454
David Horstmann5da95602023-06-08 15:37:12 +01008455 if (computation_stage->round != PSA_JPAKE_FIRST &&
8456 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008457 return PSA_ERROR_BAD_STATE;
8458 }
8459
David Horstmanne7f21e62023-05-12 18:17:21 +01008460 /* Check that the step we are given is the one we were expecting */
8461 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008462 return PSA_ERROR_BAD_STATE;
8463 }
8464
David Horstmanne7f21e62023-05-12 18:17:21 +01008465 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8466 computation_stage->inputs == 0 &&
8467 computation_stage->outputs == 0) {
8468 /* Start of the round, so function decides whether we are inputting
8469 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008470 computation_stage->io_mode = io_mode;
8471 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008472 /* Middle of the round so the mode we are in must match the function
8473 * called by the user */
8474 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008475 }
8476
8477 return PSA_SUCCESS;
8478}
8479
David Horstmanne7f21e62023-05-12 18:17:21 +01008480static psa_status_t psa_jpake_epilogue(
8481 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008482 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008483{
David Horstmanne7f21e62023-05-12 18:17:21 +01008484 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008485 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008486
David Horstmanne7f21e62023-05-12 18:17:21 +01008487 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8488 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008489 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008490 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008491 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008492 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008493 }
8494 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008495 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008496 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008497 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008498 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008499 }
8500 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008501 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8502 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008503 /* End of a round, move to the next round */
8504 stage->inputs = 0;
8505 stage->outputs = 0;
8506 stage->round++;
8507 }
8508 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008509 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008510 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008511 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008512 return PSA_SUCCESS;
8513}
David Horstmanne7f21e62023-05-12 18:17:21 +01008514
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008515#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008516
Neil Armstronga7d08c32022-06-01 18:21:20 +02008517psa_status_t psa_pake_output(
8518 psa_pake_operation_t *operation,
8519 psa_pake_step_t step,
8520 uint8_t *output,
8521 size_t output_size,
8522 size_t *output_length)
8523{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008524 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008525 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008526 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008527
8528 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008529 status = psa_pake_complete_inputs(operation);
8530 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008531 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008532 }
8533 }
8534
8535 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008536 status = PSA_ERROR_BAD_STATE;
8537 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008538 }
8539
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008540 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008541 status = PSA_ERROR_INVALID_ARGUMENT;
8542 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008543 }
8544
Przemek Stekiele12ed362022-12-21 12:54:46 +01008545 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008546#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008547 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008548 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008549 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008550 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008551 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008552 driver_step = convert_jpake_computation_stage_to_driver_step(
8553 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008554 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008555#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008556 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008557 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008558 status = PSA_ERROR_NOT_SUPPORTED;
8559 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008560 }
8561
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008562 status = psa_driver_wrapper_pake_output(operation, driver_step,
8563 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008564
8565 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008566 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008567 }
8568
8569 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008570#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008571 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008572 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008573 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008574 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008575 }
8576 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008577#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008578 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008579 status = PSA_ERROR_NOT_SUPPORTED;
8580 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008581 }
8582
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008583 return PSA_SUCCESS;
8584exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008585 psa_pake_abort(operation);
8586 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008587}
8588
8589psa_status_t psa_pake_input(
8590 psa_pake_operation_t *operation,
8591 psa_pake_step_t step,
8592 const uint8_t *input,
8593 size_t input_length)
8594{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008595 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008596 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008597 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8598 operation->primitive,
8599 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008600
8601 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008602 status = psa_pake_complete_inputs(operation);
8603 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008604 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008605 }
8606 }
8607
8608 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008609 status = PSA_ERROR_BAD_STATE;
8610 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008611 }
8612
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008613 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008614 status = PSA_ERROR_INVALID_ARGUMENT;
8615 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008616 }
8617
Przemek Stekiele12ed362022-12-21 12:54:46 +01008618 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008619#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008620 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008621 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008622 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008623 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008624 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008625 driver_step = convert_jpake_computation_stage_to_driver_step(
8626 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008627 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008628#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008629 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008630 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008631 status = PSA_ERROR_NOT_SUPPORTED;
8632 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008633 }
8634
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008635 status = psa_driver_wrapper_pake_input(operation, driver_step,
8636 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008637
8638 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008639 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008640 }
8641
8642 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008643#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008644 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008645 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008646 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008647 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008648 }
8649 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008650#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008651 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008652 status = PSA_ERROR_NOT_SUPPORTED;
8653 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008654 }
8655
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008656 return PSA_SUCCESS;
8657exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008658 psa_pake_abort(operation);
8659 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008660}
8661
8662psa_status_t psa_pake_get_implicit_key(
8663 psa_pake_operation_t *operation,
8664 psa_key_derivation_operation_t *output)
8665{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008666 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008667 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008668 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008669 size_t shared_key_len = 0;
8670
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008671 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008672 status = PSA_ERROR_BAD_STATE;
8673 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008674 }
8675
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008676#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008677 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008678 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008679 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008680 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008681 status = PSA_ERROR_BAD_STATE;
8682 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008683 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008684 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008685#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008686 {
8687 status = PSA_ERROR_NOT_SUPPORTED;
8688 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008689 }
8690
Przemek Stekiel0c781802022-11-29 14:53:13 +01008691 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8692 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008693 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008694 &shared_key_len);
8695
8696 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008697 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008698 }
8699
8700 status = psa_key_derivation_input_bytes(output,
8701 PSA_KEY_DERIVATION_INPUT_SECRET,
8702 shared_key,
8703 shared_key_len);
8704
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008705 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008706exit:
8707 abort_status = psa_pake_abort(operation);
8708 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008709}
8710
8711psa_status_t psa_pake_abort(
8712 psa_pake_operation_t *operation)
8713{
Przemek Stekield69dca92023-01-31 19:59:20 +01008714 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008715
Przemek Stekield69dca92023-01-31 19:59:20 +01008716 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008717 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008718 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008719
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008720 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8721 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008722 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008723 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008724 }
8725 if (operation->data.inputs.user != NULL) {
8726 mbedtls_free(operation->data.inputs.user);
8727 }
8728 if (operation->data.inputs.peer != NULL) {
8729 mbedtls_free(operation->data.inputs.peer);
8730 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008731 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008732 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008733
Przemek Stekield69dca92023-01-31 19:59:20 +01008734 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008735}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008736#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008737
David Horstmann00d7a042023-12-07 18:39:17 +00008738/* Memory copying test hooks. These are called before input copy, after input
8739 * copy, before output copy and after output copy, respectively.
8740 * They are used by memory-poisoning tests to temporarily unpoison buffers
8741 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008742#if defined(MBEDTLS_TEST_HOOKS)
8743void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8744void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8745void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8746void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8747#endif
David Horstmannfde97392023-10-30 20:29:43 +00008748
David Horstmann1b7279a2023-11-15 15:18:30 +00008749/** Copy from an input buffer to a local copy.
8750 *
8751 * \param[in] input Pointer to input buffer.
8752 * \param[in] input_len Length of the input buffer.
8753 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8754 * \param[out] input_copy_len Length of the local copy buffer.
8755 * \return #PSA_SUCCESS, if the buffer was successfully
8756 * copied.
8757 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8758 * copy is too small to hold contents of the
8759 * input buffer.
8760 */
8761MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008762psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8763 uint8_t *input_copy, size_t input_copy_len)
8764{
8765 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008766 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008767 }
8768
David Horstmann372b8bb2023-11-24 16:21:04 +00008769#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008770 if (psa_input_pre_copy_hook != NULL) {
8771 psa_input_pre_copy_hook(input, input_len);
8772 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008773#endif
8774
David Horstmann777e7412023-11-15 17:33:47 +00008775 if (input_len > 0) {
8776 memcpy(input_copy, input, input_len);
8777 }
David Horstmannfde97392023-10-30 20:29:43 +00008778
David Horstmann372b8bb2023-11-24 16:21:04 +00008779#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008780 if (psa_input_post_copy_hook != NULL) {
8781 psa_input_post_copy_hook(input, input_len);
8782 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008783#endif
8784
David Horstmannfde97392023-10-30 20:29:43 +00008785 return PSA_SUCCESS;
8786}
8787
David Horstmann1b7279a2023-11-15 15:18:30 +00008788/** Copy from a local output buffer into a user-supplied one.
8789 *
8790 * \param[in] output_copy Pointer to a local buffer containing the output.
8791 * \param[in] output_copy_len Length of the local buffer.
8792 * \param[out] output Pointer to user-supplied output buffer.
8793 * \param[out] output_len Length of the user-supplied output buffer.
8794 * \return #PSA_SUCCESS, if the buffer was successfully
8795 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008796 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008797 * user-supplied output buffer is too small to
8798 * hold the contents of the local buffer.
8799 */
8800MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008801psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8802 uint8_t *output, size_t output_len)
8803{
8804 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008805 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008806 }
David Horstmann777e7412023-11-15 17:33:47 +00008807
David Horstmann372b8bb2023-11-24 16:21:04 +00008808#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008809 if (psa_output_pre_copy_hook != NULL) {
8810 psa_output_pre_copy_hook(output, output_len);
8811 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008812#endif
8813
David Horstmann777e7412023-11-15 17:33:47 +00008814 if (output_copy_len > 0) {
8815 memcpy(output, output_copy, output_copy_len);
8816 }
8817
David Horstmann372b8bb2023-11-24 16:21:04 +00008818#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008819 if (psa_output_post_copy_hook != NULL) {
8820 psa_output_post_copy_hook(output, output_len);
8821 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008822#endif
8823
David Horstmann8978f5c2023-10-30 20:37:12 +00008824 return PSA_SUCCESS;
8825}
8826
David Horstmannf1734052023-11-20 17:15:32 +00008827psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8828 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008829{
8830 psa_status_t status;
8831
David Horstmann9db14482023-11-23 15:50:37 +00008832 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008833
David Horstmannc5cc1c32023-11-15 18:11:26 +00008834 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008835 return PSA_SUCCESS;
8836 }
8837
David Horstmannf1734052023-11-20 17:15:32 +00008838 local_input->buffer = mbedtls_calloc(input_len, 1);
8839 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008840 /* Since we dealt with the zero-length case above, we know that
8841 * a NULL return value means a failure of allocation. */
8842 return PSA_ERROR_INSUFFICIENT_MEMORY;
8843 }
David Horstmannf1734052023-11-20 17:15:32 +00008844 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008845
David Horstmannf1734052023-11-20 17:15:32 +00008846 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008847
8848 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008849 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008850 if (status != PSA_SUCCESS) {
8851 goto error;
8852 }
8853
8854 return PSA_SUCCESS;
8855
8856error:
David Horstmannf1734052023-11-20 17:15:32 +00008857 mbedtls_free(local_input->buffer);
8858 local_input->buffer = NULL;
8859 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008860 return status;
8861}
8862
David Horstmannf1734052023-11-20 17:15:32 +00008863void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008864{
David Horstmannf1734052023-11-20 17:15:32 +00008865 mbedtls_free(local_input->buffer);
8866 local_input->buffer = NULL;
8867 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008868}
8869
David Horstmann89875a42023-11-20 12:54:09 +00008870psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8871 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008872{
David Horstmann9db14482023-11-23 15:50:37 +00008873 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008874
David Horstmannc5cc1c32023-11-15 18:11:26 +00008875 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008876 return PSA_SUCCESS;
8877 }
David Horstmann89875a42023-11-20 12:54:09 +00008878 local_output->buffer = mbedtls_calloc(output_len, 1);
8879 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008880 /* Since we dealt with the zero-length case above, we know that
8881 * a NULL return value means a failure of allocation. */
8882 return PSA_ERROR_INSUFFICIENT_MEMORY;
8883 }
David Horstmann89875a42023-11-20 12:54:09 +00008884 local_output->length = output_len;
8885 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008886
8887 return PSA_SUCCESS;
8888}
8889
Gabor Mezei1882c512024-01-24 13:07:17 +01008890psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8891 psa_crypto_local_output_t *local_output)
8892{
8893 psa_status_t status;
8894 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8895
8896 if (output_len == 0) {
8897 return PSA_SUCCESS;
8898 }
8899 local_output->buffer = mbedtls_calloc(output_len, 1);
8900 if (local_output->buffer == NULL) {
8901 /* Since we dealt with the zero-length case above, we know that
8902 * a NULL return value means a failure of allocation. */
8903 return PSA_ERROR_INSUFFICIENT_MEMORY;
8904 }
8905 local_output->length = output_len;
8906 local_output->original = output;
8907
8908 status = psa_crypto_copy_input(output, output_len,
8909 local_output->buffer, local_output->length);
8910 if (status != PSA_SUCCESS) {
8911 goto error;
8912 }
8913
8914 return PSA_SUCCESS;
8915
8916error:
8917 mbedtls_free(local_output->buffer);
8918 local_output->buffer = NULL;
8919 local_output->length = 0;
8920 return status;
8921}
8922
David Horstmann89875a42023-11-20 12:54:09 +00008923psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008924{
David Horstmannc335a4e2023-11-15 15:57:32 +00008925 psa_status_t status;
8926
David Horstmann89875a42023-11-20 12:54:09 +00008927 if (local_output->buffer == NULL) {
8928 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008929 return PSA_SUCCESS;
8930 }
David Horstmann89875a42023-11-20 12:54:09 +00008931 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008932 /* We have an internal copy but nothing to copy back to. */
8933 return PSA_ERROR_CORRUPTION_DETECTED;
8934 }
8935
David Horstmann89875a42023-11-20 12:54:09 +00008936 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8937 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008938 if (status != PSA_SUCCESS) {
8939 return status;
8940 }
David Horstmann9467ea32023-11-08 17:44:18 +00008941
David Horstmann89875a42023-11-20 12:54:09 +00008942 mbedtls_free(local_output->buffer);
8943 local_output->buffer = NULL;
8944 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008945
8946 return PSA_SUCCESS;
8947}
8948
Gilles Peskinee59236f2018-01-27 23:32:46 +01008949#endif /* MBEDTLS_PSA_CRYPTO_C */