blob: 3bcc408e625dee10b577beacac5f2f5ef246b8f7 [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;
Gabor Mezei4892d752024-01-29 17:27:44 +0100237#define LOCAL_OUTPUT_ALLOC_WITH_COPY(output, length, output_copy) \
238 output_copy = output;
David Horstmann62a56d92023-12-14 18:12:47 +0000239#define LOCAL_OUTPUT_FREE(output, output_copy) \
240 output_copy = NULL;
David Horstmann513101b2023-11-29 17:24:08 +0000241#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000242
243
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100244int psa_can_do_hash(psa_algorithm_t hash_alg)
245{
246 (void) hash_alg;
247 return global_data.drivers_initialized;
248}
Valerio Settic6f004f2023-12-12 11:27:36 +0100249
Valerio Setti1fff4f22023-12-28 14:19:34 +0100250int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg)
Valerio Settic6f004f2023-12-12 11:27:36 +0100251{
Valerio Setti1fff4f22023-12-28 14:19:34 +0100252 (void) key_type;
Valerio Settic6f004f2023-12-12 11:27:36 +0100253 (void) cipher_alg;
254 return global_data.drivers_initialized;
255}
256
257
Valerio Settia55f0422023-07-10 15:34:41 +0200258#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200259 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200260 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200261static int psa_is_dh_key_size_valid(size_t bits)
262{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200263 if (bits != 2048 && bits != 3072 && bits != 4096 &&
264 bits != 6144 && bits != 8192) {
265 return 0;
266 }
267
268 return 1;
269}
Valerio Settia55f0422023-07-10 15:34:41 +0200270#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200271 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200272 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100273
Gilles Peskine449bd832023-01-11 14:50:10 +0100274psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100275{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100276 /* Mbed TLS error codes can combine a high-level error code and a
277 * low-level error code. The low-level error usually reflects the
278 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 int low_level_ret = -(-ret & 0x007f);
280 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100281 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100282 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100283
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100284#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100285 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
286 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100288 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
289 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100290#endif
291
292#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200293 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
294 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
295 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
296 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
297 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200299 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200301 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100303#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200304
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100305#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000306 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100307 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100309#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100310
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100311#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100312 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100313 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100314 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100316#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100317
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100318#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200319 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100321#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200322
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100323#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200324 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200326 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100328#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200329
Dave Rodgman509b5672023-08-16 19:26:23 +0100330#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100331 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100333 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100335 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100336 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100337 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100339 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100341 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100343 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100345#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100346
Gilles Peskine449bd832023-01-11 14:50:10 +0100347#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
348 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100349 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
350 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100351 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100353 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
354 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100356 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100358#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100359
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100360#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100361 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100363#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100364
Gilles Peskinee59236f2018-01-27 23:32:46 +0100365 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
366 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
367 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100369
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100370#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100371 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200373 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100375 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100377#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100378
Gilles Peskine82e57d12020-11-13 21:31:17 +0100379#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100380 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100381 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
382 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100383 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100385 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
386 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100388 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100389 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100390#endif
391
Dave Rodgmandea266f2023-08-31 11:52:43 +0100392#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100393 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100394 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100395 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100396 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100397 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100399#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100400 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100401 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100402#endif
403#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100404
Dave Rodgman509b5672023-08-16 19:26:23 +0100405#if defined(MBEDTLS_BIGNUM_C)
406#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100407 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100408 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100409#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100410 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
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_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100414 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100416 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
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_DIVISION_BY_ZERO:
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_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100422 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100424#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100425
Dave Rodgman509b5672023-08-16 19:26:23 +0100426#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100427 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100429 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
430 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100432#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
433 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100434 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100436#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100437 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
438 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100440 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100442 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
443 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100444 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100445 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100447 case MBEDTLS_ERR_PK_INVALID_ALG:
448 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
449 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100451 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200453 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100454 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100455#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100456
Gilles Peskineff2d2002019-05-06 15:26:23 +0200457 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200459 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200461
Dave Rodgman509b5672023-08-16 19:26:23 +0100462#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100463 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100465 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100466 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100467 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100469 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100471 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
472 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100474 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100476 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100478 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100480#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200481
Dave Rodgman1dab4452023-09-01 09:59:51 +0100482#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300483 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300484 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300486 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300488 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300490 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
491 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300493 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100495 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100496 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100497
Dave Rodgman509b5672023-08-16 19:26:23 +0100498#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000499 case MBEDTLS_ERR_ECP_IN_PROGRESS:
500 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100501#endif
502#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000503
Janos Follatha13b9052019-11-22 12:48:59 +0000504 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300506
Gilles Peskinee59236f2018-01-27 23:32:46 +0100507 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100508 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100509 }
510}
511
Paul Elliottdc42ca82023-02-24 18:11:59 +0000512/**
513 * \brief For output buffers which contain "tags"
514 * (outputs that may be checked for validity like
515 * hashes, MACs and signatures), fill the unused
516 * part of the output buffer (the whole buffer on
517 * error, the trailing part on success) with
518 * something that isn't a valid tag (barring an
519 * attack on the tag and deliberately-crafted
520 * input), in case the caller doesn't check the
521 * return status properly.
522 *
523 * \param output_buffer Pointer to buffer to wipe. May not be NULL
524 * unless \p output_buffer_size is zero.
525 * \param status Status of function called to generate
526 * output_buffer originally
527 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
528 * could be NULL.
529 * \param output_buffer_length Length of data written to output_buffer, must be
530 * less than \p output_buffer_size
531 */
532static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000533 size_t output_buffer_size, size_t output_buffer_length)
534{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000535 size_t offset = 0;
536
537 if (output_buffer_size == 0) {
538 /* If output_buffer_size is 0 then we have nothing to do. We must not
539 call memset because output_buffer may be NULL in this case */
540 return;
541 }
542
543 if (status == PSA_SUCCESS) {
544 offset = output_buffer_length;
545 }
546
547 memset(output_buffer + offset, '!', output_buffer_size - offset);
548}
549
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200550
Gilles Peskine449bd832023-01-11 14:50:10 +0100551psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
552 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200553{
554 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200556 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200557 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200558 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200559 case PSA_KEY_TYPE_PASSWORD:
560 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200561 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100562#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200563 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 if (bits != 128 && bits != 192 && bits != 256) {
565 return PSA_ERROR_INVALID_ARGUMENT;
566 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200567 break;
568#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200569#if defined(PSA_WANT_KEY_TYPE_ARIA)
570 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 if (bits != 128 && bits != 192 && bits != 256) {
572 return PSA_ERROR_INVALID_ARGUMENT;
573 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200574 break;
575#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100576#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200577 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 if (bits != 128 && bits != 192 && bits != 256) {
579 return PSA_ERROR_INVALID_ARGUMENT;
580 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200581 break;
582#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100583#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200584 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 if (bits != 64 && bits != 128 && bits != 192) {
586 return PSA_ERROR_INVALID_ARGUMENT;
587 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200588 break;
589#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100590#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200591 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 if (bits != 256) {
593 return PSA_ERROR_INVALID_ARGUMENT;
594 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200595 break;
596#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200597 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200599 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 if (bits % 8 != 0) {
601 return PSA_ERROR_INVALID_ARGUMENT;
602 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200605}
606
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100607/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100608 *
Steven Cooremancd640932021-03-08 12:00:27 +0100609 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
610 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100611 *
612 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100613 * \param[in] key_type The key type of the key to be used with the
614 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100615 *
616 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100617 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100618 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100619 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100620 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100621MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100622 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100624{
Gilles Peskine449bd832023-01-11 14:50:10 +0100625 if (PSA_ALG_IS_HMAC(algorithm)) {
626 if (key_type == PSA_KEY_TYPE_HMAC) {
627 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100628 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100629 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100630
Gilles Peskine449bd832023-01-11 14:50:10 +0100631 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
632 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
633 * key. */
634 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
635 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
636 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
637 * the block length (larger than 1) for block ciphers. */
638 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
639 return PSA_SUCCESS;
640 }
641 }
642 }
643
644 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100645}
646
Gilles Peskine449bd832023-01-11 14:50:10 +0100647psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
648 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200649{
Gilles Peskine449bd832023-01-11 14:50:10 +0100650 if (slot->key.data != NULL) {
651 return PSA_ERROR_ALREADY_EXISTS;
652 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200653
Gilles Peskine449bd832023-01-11 14:50:10 +0100654 slot->key.data = mbedtls_calloc(1, buffer_length);
655 if (slot->key.data == NULL) {
656 return PSA_ERROR_INSUFFICIENT_MEMORY;
657 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200658
Ronald Cronea0f8a62020-11-25 17:52:23 +0100659 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100660 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200661}
662
Gilles Peskine449bd832023-01-11 14:50:10 +0100663psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
664 const uint8_t *data,
665 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200666{
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 psa_status_t status = psa_allocate_buffer_to_slot(slot,
668 data_length);
669 if (status != PSA_SUCCESS) {
670 return status;
671 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200672
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 memcpy(slot->key.data, data, data_length);
674 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200675}
676
Ronald Crona0fe59f2020-11-29 11:14:53 +0100677psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100678 const psa_key_attributes_t *attributes,
679 const uint8_t *data, size_t data_length,
680 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100682{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100683 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
684 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100685
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200686 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 if (data_length == 0) {
688 return PSA_ERROR_NOT_SUPPORTED;
689 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200690
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 if (key_type_is_raw_bytes(type)) {
692 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200693
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
695 *bits);
696 if (status != PSA_SUCCESS) {
697 return status;
698 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200699
Ronald Crondd04d422020-11-28 15:14:42 +0100700 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100702 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200704
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 return PSA_SUCCESS;
706 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200707#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200708 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100709 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200710 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100711 return PSA_ERROR_INVALID_ARGUMENT;
712 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200713 return mbedtls_psa_ffdh_import_key(attributes,
714 data, data_length,
715 key_buffer, key_buffer_size,
716 key_buffer_length,
717 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100718 }
Valerio Settia55f0422023-07-10 15:34:41 +0200719#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200720 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200721#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
723 if (PSA_KEY_TYPE_IS_ECC(type)) {
724 return mbedtls_psa_ecp_import_key(attributes,
725 data, data_length,
726 key_buffer, key_buffer_size,
727 key_buffer_length,
728 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100729 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200730#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800731 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200732#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
733 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100734 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
735 if (PSA_KEY_TYPE_IS_RSA(type)) {
736 return mbedtls_psa_rsa_import_key(attributes,
737 data, data_length,
738 key_buffer, key_buffer_size,
739 key_buffer_length,
740 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200741 }
Valerio Settife478902023-07-25 12:27:19 +0200742#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
743 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800744 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100745 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100746
Gilles Peskine449bd832023-01-11 14:50:10 +0100747 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100748}
749
Gilles Peskinef603c712019-01-19 13:40:11 +0100750/** Calculate the intersection of two algorithm usage policies.
751 *
752 * Return 0 (which allows no operation) on incompatibility.
753 */
754static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100755 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100756 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100757 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100758{
Gilles Peskine549ea862019-05-22 11:45:59 +0200759 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 if (alg1 == alg2) {
761 return alg1;
762 }
Steven Cooreman03488022021-02-18 12:07:20 +0100763 /* If the policies are from the same hash-and-sign family, check
764 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
766 PSA_ALG_IS_SIGN_HASH(alg2) &&
767 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
768 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
769 return alg2;
770 }
771 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
772 return alg1;
773 }
Steven Cooreman03488022021-02-18 12:07:20 +0100774 }
775 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100776 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100777 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
779 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
780 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
781 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
782 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100783 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100784
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100785 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
787 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
788 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
789 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100790 }
791 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
793 (alg1_len <= alg2_len)) {
794 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100795 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
797 (alg2_len <= alg1_len)) {
798 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100799 }
800 }
801 /* If the policies are from the same MAC family, check whether one
802 * of them is a minimum-MAC-length policy. Calculate the most
803 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100804 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
805 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
806 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100807 /* Validate the combination of key type and algorithm. Since the base
808 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
810 return 0;
811 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100812
Steven Cooreman31a876d2021-03-03 20:47:40 +0100813 /* Get the (exact or at-least) output lengths for both sides of the
814 * requested intersection. None of the currently supported algorithms
815 * have an output length dependent on the actual key size, so setting it
816 * to a bogus value of 0 is currently OK.
817 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100818 * Note that for at-least-this-length wildcard algorithms, the output
819 * length is set to the shortest allowed length, which allows us to
820 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100821 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
822 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100823 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100824
Steven Cooremana1d83222021-02-25 10:20:29 +0100825 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100826 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
827 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
828 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100829 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100830
831 /* If only one is an at-least-this-length policy, the intersection would
832 * be the other (fixed-length) policy as long as said fixed length is
833 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100834 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
835 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100836 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100837 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
838 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100839 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100840
Steven Cooremancd640932021-03-08 12:00:27 +0100841 /* If none of them are wildcards, check whether they define the same tag
842 * length. This is still possible here when one is default-length and
843 * the other specific-length. Ensure to always return the
844 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 if (alg1_len == alg2_len) {
846 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
847 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100848 }
849 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100851}
852
Gilles Peskine449bd832023-01-11 14:50:10 +0100853static int psa_key_algorithm_permits(psa_key_type_t key_type,
854 psa_algorithm_t policy_alg,
855 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200856{
Gilles Peskine549ea862019-05-22 11:45:59 +0200857 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100858 if (requested_alg == policy_alg) {
859 return 1;
860 }
Steven Cooreman03488022021-02-18 12:07:20 +0100861 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
862 * and requested_alg is the same hash-and-sign family with any hash,
863 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100864 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
865 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
866 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
867 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100868 }
869 /* If policy_alg is a wildcard AEAD algorithm of the same base as
870 * the requested algorithm, check the requested tag length to be
871 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100872 if (PSA_ALG_IS_AEAD(policy_alg) &&
873 PSA_ALG_IS_AEAD(requested_alg) &&
874 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
875 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
876 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
877 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
878 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100879 }
Steven Cooremancd640932021-03-08 12:00:27 +0100880 /* If policy_alg is a MAC algorithm of the same base as the requested
881 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100882 if (PSA_ALG_IS_MAC(policy_alg) &&
883 PSA_ALG_IS_MAC(requested_alg) &&
884 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
885 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100886 /* Validate the combination of key type and algorithm. Since the policy
887 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100888 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
889 return 0;
890 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100891
Steven Cooreman31a876d2021-03-03 20:47:40 +0100892 /* Get both the requested output length for the algorithm which is to be
893 * verified, and the default output length for the base algorithm.
894 * Note that none of the currently supported algorithms have an output
895 * length dependent on actual key size, so setting it to a bogus value
896 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100897 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100899 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100900 key_type, 0,
901 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100902
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100903 /* If the policy is default-length, only allow an algorithm with
904 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100905 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
906 return requested_output_length == default_output_length;
907 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100908
909 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100910 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
912 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
913 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100914 }
915
Steven Cooremancd640932021-03-08 12:00:27 +0100916 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
917 * check for the requested MAC length to be equal to or longer than the
918 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
920 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
921 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100922 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200923 }
Steven Cooremance48e852020-10-05 16:02:45 +0200924 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200925 * a key derivation with that key agreement should also be allowed. This
926 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
928 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
929 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
930 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200931 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100932 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100933 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200934}
935
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100936/** Test whether a policy permits an algorithm.
937 *
938 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100939 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100940 * \note This function requires providing the key type for which the policy is
941 * being validated, since some algorithm policy definitions (e.g. MAC)
942 * have different properties depending on what kind of cipher it is
943 * combined with.
944 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100945 * \retval PSA_SUCCESS When \p alg is a specific algorithm
946 * allowed by the \p policy.
947 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
948 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
949 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100950 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100951static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
952 psa_key_type_t key_type,
953 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100954{
Steven Cooremand788fab2021-02-25 11:29:17 +0100955 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 if (alg == 0) {
957 return PSA_ERROR_INVALID_ARGUMENT;
958 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100959
Steven Cooreman7e39f052021-02-23 14:18:32 +0100960 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100961 if (PSA_ALG_IS_WILDCARD(alg)) {
962 return PSA_ERROR_INVALID_ARGUMENT;
963 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100964
Gilles Peskine449bd832023-01-11 14:50:10 +0100965 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
966 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
967 return PSA_SUCCESS;
968 } else {
969 return PSA_ERROR_NOT_PERMITTED;
970 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100971}
972
Gilles Peskinef603c712019-01-19 13:40:11 +0100973/** Restrict a key policy based on a constraint.
974 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100975 * \note This function requires providing the key type for which the policy is
976 * being restricted, since some algorithm policy definitions (e.g. MAC)
977 * have different properties depending on what kind of cipher it is
978 * combined with.
979 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100980 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100981 * \param[in,out] policy The policy to restrict.
982 * \param[in] constraint The policy constraint to apply.
983 *
984 * \retval #PSA_SUCCESS
985 * \c *policy contains the intersection of the original value of
986 * \c *policy and \c *constraint.
987 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100988 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100989 * \c *policy is unchanged.
990 */
991static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100992 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100993 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100995{
996 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 psa_key_policy_algorithm_intersection(key_type, policy->alg,
998 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200999 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
1001 constraint->alg2);
1002 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1003 return PSA_ERROR_INVALID_ARGUMENT;
1004 }
1005 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1006 return PSA_ERROR_INVALID_ARGUMENT;
1007 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001008 policy->usage &= constraint->usage;
1009 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001010 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001012}
1013
Przemek Stekiel061f6942022-11-30 10:51:35 +01001014/** Get the description of a key given its identifier and policy constraints
1015 * and lock it.
1016 *
1017 * The key must have allow all the usage flags set in \p usage. If \p alg is
1018 * nonzero, the key must allow operations with this algorithm. If \p alg is
1019 * zero, the algorithm is not checked.
1020 *
1021 * In case of a persistent key, the function loads the description of the key
1022 * into a key slot if not already done.
1023 *
Ryan Everett098c6652024-01-03 13:03:36 +00001024 * On success, the returned key slot has been registered for reading.
1025 * It is the responsibility of the caller to call psa_unregister_read(slot)
1026 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +01001027 */
1028static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001029 mbedtls_svc_key_id_t key,
1030 psa_key_slot_t **p_slot,
1031 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001032 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001033{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001034 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001035 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001036
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 status = psa_get_and_lock_key_slot(key, p_slot);
1038 if (status != PSA_SUCCESS) {
1039 return status;
1040 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001041 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001042
1043 /* Enforce that usage policy for the key slot contains all the flags
1044 * required by the usage parameter. There is one exception: public
1045 * keys can always be exported, so we treat public key objects as
1046 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001048 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001050
Gilles Peskine449bd832023-01-11 14:50:10 +01001051 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001052 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001053 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001054 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001055
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001056 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 if (alg != 0) {
1058 status = psa_key_policy_permits(&slot->attr.policy,
1059 slot->attr.type,
1060 alg);
1061 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001062 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001064 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001065
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001067
1068error:
1069 *p_slot = NULL;
Ryan Everett098c6652024-01-03 13:03:36 +00001070 psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001071
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001073}
Darryl Green940d72c2018-07-13 13:18:51 +01001074
Ronald Cron5c522922020-11-14 16:35:34 +01001075/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001076 *
1077 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001078 * available, as opposed to a key in a secure element and/or to be used
1079 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001080 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001081 * This is a temporary function that may be used instead of
1082 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1083 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001084 *
Ryan Everett098c6652024-01-03 13:03:36 +00001085 * On success, the returned key slot has been registered for reading.
1086 * It is the responsibility of the caller to call psa_unregister_read(slot)
1087 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001088 */
Ronald Cron5c522922020-11-14 16:35:34 +01001089static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1090 mbedtls_svc_key_id_t key,
1091 psa_key_slot_t **p_slot,
1092 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001094{
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1096 usage, alg);
1097 if (status != PSA_SUCCESS) {
1098 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001099 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001100
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everett098c6652024-01-03 13:03:36 +00001102 psa_unregister_read(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 *p_slot = NULL;
1104 return PSA_ERROR_NOT_SUPPORTED;
1105 }
1106
1107 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001108}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001109
Gilles Peskine449bd832023-01-11 14:50:10 +01001110psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001111{
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001113 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001115
Ronald Cronea0f8a62020-11-25 17:52:23 +01001116 slot->key.data = NULL;
1117 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001118
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001120}
1121
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001122/** Completely wipe a slot in memory, including its policy.
1123 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001124psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001125{
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001127
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 /*
1129 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001130 * do our best to report an unexpected amount of registered readers or
1131 * an unexpected state.
1132 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1133 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1135 * function is called as part of the execution of a test suite, the
1136 * execution of the test suite is stopped in error if the assertion fails.
1137 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001138 switch (slot->state) {
1139 case PSA_SLOT_FULL:
1140 /* In this state psa_wipe_key_slot() must only be called if the
1141 * caller is the last reader. */
1142 case PSA_SLOT_PENDING_DELETION:
1143 /* In this state psa_wipe_key_slot() must only be called if the
1144 * caller is the last reader. */
1145 if (slot->registered_readers != 1) {
1146 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1147 status = PSA_ERROR_CORRUPTION_DETECTED;
1148 }
1149 break;
1150 case PSA_SLOT_FILLING:
1151 /* In this state registered_readers must be 0. */
1152 if (slot->registered_readers != 0) {
1153 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1154 status = PSA_ERROR_CORRUPTION_DETECTED;
1155 }
1156 break;
1157 case PSA_SLOT_EMPTY:
1158 /* The slot is already empty, it cannot be wiped. */
1159 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1160 status = PSA_ERROR_CORRUPTION_DETECTED;
1161 break;
1162 default:
1163 /* The slot's state is invalid. */
1164 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001165 }
1166
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001167 /* Multipart operations may still be using the key. This is safe
1168 * because all multipart operation objects are independent from
1169 * the key slot: if they need to access the key after the setup
1170 * phase, they have a copy of the key. Note that this means that
1171 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001172 /* At this point, key material and other type-specific content has
1173 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001174 * zeroize because the metadata is not particularly sensitive.
1175 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 memset(slot, 0, sizeof(*slot));
1177 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001178}
1179
Gilles Peskine449bd832023-01-11 14:50:10 +01001180psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001181{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001182 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001183 psa_status_t status; /* status of the last operation */
1184 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001185#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1186 psa_se_drv_table_entry_t *driver;
1187#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001188
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 if (mbedtls_svc_key_id_is_null(key)) {
1190 return PSA_SUCCESS;
1191 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001192
Ronald Cronf2911112020-10-29 17:51:10 +01001193 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001194 * Get the description of the key in a key slot, and register to read it.
1195 * In the case of a persistent key, this will load the key description
1196 * from persistent memory if not done yet.
1197 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001198 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001199 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 status = psa_get_and_lock_key_slot(key, &slot);
1201 if (status != PSA_SUCCESS) {
1202 return status;
1203 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001204
Ryan Everett7ed542e2024-01-17 11:39:09 +00001205 /* Set the key slot containing the key description's state to
1206 * PENDING_DELETION. This stops new operations from registering
1207 * to read the slot. Current readers can safely continue to access
1208 * the key within the slot; the last registered reader will
1209 * automatically wipe the slot when they call psa_unregister_read().
1210 * If the key is persistent, we can now delete the copy of the key
1211 * from memory. If the key is opaque, we require the driver to
1212 * deal with the deletion. */
Ryan Everettc70ce572024-01-03 16:04:33 +00001213 slot->state = PSA_SLOT_PENDING_DELETION;
Ronald Cronf2911112020-10-29 17:51:10 +01001214
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001216 /* Refuse the destruction of a read-only key (which may or may not work
1217 * if we attempt it, depending on whether the key is merely read-only
1218 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001219 * Just do the best we can, which is to wipe the copy in memory
1220 * (done in this function's cleanup code). */
1221 overall_status = PSA_ERROR_NOT_PERMITTED;
1222 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001223 }
1224
Gilles Peskine354f7672019-07-12 23:46:38 +02001225#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1227 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001228 /* For a key in a secure element, we need to do three things:
1229 * remove the key file in internal storage, destroy the
1230 * key inside the secure element, and update the driver's
1231 * persistent data. Start a transaction that will encompass these
1232 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001234 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001236 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 status = psa_crypto_save_transaction();
1238 if (status != PSA_SUCCESS) {
1239 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001240 /* We should still try to destroy the key in the secure
1241 * element and the key metadata in storage. This is especially
1242 * important if the error is that the storage is full.
1243 * But how to do it exactly without risking an inconsistent
1244 * state after a reset?
1245 * https://github.com/ARMmbed/mbed-crypto/issues/215
1246 */
1247 overall_status = status;
1248 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001249 }
1250
Gilles Peskine449bd832023-01-11 14:50:10 +01001251 status = psa_destroy_se_key(driver,
1252 psa_key_slot_get_slot_number(slot));
1253 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001254 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001255 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001256 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001257#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1258
Darryl Greend49a4992018-06-18 17:27:26 +01001259#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001261 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001262 * The slot will still hold a copy of the key until the last reader
1263 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 status = psa_destroy_persistent_key(slot->attr.id);
1265 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001266 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001267 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001268
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001269 /* TODO: other slots may have a copy of the same key. We should
1270 * invalidate them.
1271 * https://github.com/ARMmbed/mbed-crypto/issues/214
1272 */
Darryl Greend49a4992018-06-18 17:27:26 +01001273 }
1274#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001275
Gilles Peskinefc762652019-07-22 19:30:34 +02001276#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001277 if (driver != NULL) {
1278 status = psa_save_se_persistent_data(driver);
1279 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001280 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 }
1282 status = psa_crypto_stop_transaction();
1283 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001284 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001286 }
1287#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1288
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001289exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001290 /* Unregister from reading the slot. If we are the last active reader
1291 * then this will wipe the slot. */
1292 status = psa_unregister_read(slot);
1293 /* Prioritize CORRUPTION_DETECTED from unregistering over
1294 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001296 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001297 }
1298 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001299}
1300
Valerio Settib2bcedb2023-07-10 11:24:00 +02001301#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001302 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001303static psa_status_t psa_get_rsa_public_exponent(
1304 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001306{
1307 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001308 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001309 uint8_t *buffer = NULL;
1310 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001312
Gilles Peskine449bd832023-01-11 14:50:10 +01001313 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1314 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001315 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 }
1317 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001318 /* It's the default value, which is reported as an empty string,
1319 * so there's nothing to do. */
1320 goto exit;
1321 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001322
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 buflen = mbedtls_mpi_size(&mpi);
1324 buffer = mbedtls_calloc(1, buflen);
1325 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001326 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1327 goto exit;
1328 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1330 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001331 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001333 attributes->domain_parameters = buffer;
1334 attributes->domain_parameters_size = buflen;
1335
1336exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 mbedtls_mpi_free(&mpi);
1338 if (ret != 0) {
1339 mbedtls_free(buffer);
1340 }
1341 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001342}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001343#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001344 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001345
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001346/** Retrieve all the publicly-accessible attributes of a key.
1347 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001348psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1349 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001350{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001351 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001352 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001353 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001354
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001356
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1358 if (status != PSA_SUCCESS) {
1359 return status;
1360 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001361
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001362 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1364 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001365
1366#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001367 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1368 psa_set_key_slot_number(attributes,
1369 psa_key_slot_get_slot_number(slot));
1370 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001371#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001372
Gilles Peskine449bd832023-01-11 14:50:10 +01001373 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001374#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1375 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001376 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001377 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001378 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001379 /* TODO: This is a temporary situation where domain parameters are deprecated,
1380 * but we need it for namely generating an RSA key with a non-default exponent.
1381 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001382 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001383 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001384 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001385
Ronald Cron90857082020-11-25 14:58:33 +01001386 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 slot->attr.type,
1388 slot->key.data,
1389 slot->key.bytes,
1390 &rsa);
1391 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001392 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001394
Gilles Peskine449bd832023-01-11 14:50:10 +01001395 status = psa_get_rsa_public_exponent(rsa,
1396 attributes);
1397 mbedtls_rsa_free(rsa);
1398 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001399 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001400 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001401#else
1402 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1403 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1404 attributes->domain_parameters = NULL;
1405 attributes->domain_parameters_size = SIZE_MAX;
1406 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001407#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1408 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001409 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001410 default:
1411 /* Nothing else to do. */
1412 break;
1413 }
1414
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 if (status != PSA_SUCCESS) {
1416 psa_reset_key_attributes(attributes);
1417 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001418
Ryan Everett1b70a072024-01-04 10:32:49 +00001419 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001420
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001422}
1423
Gilles Peskinec8000c02019-08-02 20:15:51 +02001424#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1425psa_status_t psa_get_key_slot_number(
1426 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001428{
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001430 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 return PSA_SUCCESS;
1432 } else {
1433 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001434 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001435}
1436#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1437
Gilles Peskine449bd832023-01-11 14:50:10 +01001438static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1439 size_t key_buffer_size,
1440 uint8_t *data,
1441 size_t data_size,
1442 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001443{
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 if (key_buffer_size > data_size) {
1445 return PSA_ERROR_BUFFER_TOO_SMALL;
1446 }
1447 memcpy(data, key_buffer, key_buffer_size);
1448 memset(data + key_buffer_size, 0,
1449 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001450 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001452}
1453
Ronald Cron7285cda2020-11-26 14:46:37 +01001454psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001455 const psa_key_attributes_t *attributes,
1456 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001458{
Ronald Crond18b5f82020-11-25 16:46:05 +01001459 psa_key_type_t type = attributes->core.type;
1460
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 if (key_type_is_raw_bytes(type) ||
1462 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001463 PSA_KEY_TYPE_IS_ECC(type) ||
1464 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001465 return psa_export_key_buffer_internal(
1466 key_buffer, key_buffer_size,
1467 data, data_size, data_length);
1468 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001469 /* This shouldn't happen in the reference implementation, but
1470 it is valid for a special-purpose implementation to omit
1471 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001473 }
1474}
1475
Gilles Peskine449bd832023-01-11 14:50:10 +01001476psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
Ryan Everett45ac5262024-01-08 17:15:19 +00001477 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001478 size_t data_size,
1479 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001480{
1481 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1482 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1483 psa_key_slot_t *slot;
Ryan Everett45ac5262024-01-08 17:15:19 +00001484 LOCAL_OUTPUT_DECLARE(data_external, data);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001485
Ronald Crone907e552021-01-18 13:22:38 +01001486 /* Reject a zero-length output buffer now, since this can never be a
1487 * valid key representation. This way we know that data must be a valid
1488 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001489 if (data_size == 0) {
1490 return PSA_ERROR_BUFFER_TOO_SMALL;
1491 }
Ronald Crone907e552021-01-18 13:22:38 +01001492
Ronald Cron9486f9d2020-11-26 13:36:23 +01001493 /* Set the key to empty now, so that even when there are errors, we always
1494 * set data_length to a value between 0 and data_size. On error, setting
1495 * the key to empty is a good choice because an empty key representation is
1496 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001497 *data_length = 0;
1498
Ronald Cron9486f9d2020-11-26 13:36:23 +01001499 /* Export requires the EXPORT flag. There is an exception for public keys,
1500 * which don't require any flag, but
1501 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1502 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1504 PSA_KEY_USAGE_EXPORT, 0);
1505 if (status != PSA_SUCCESS) {
1506 return status;
1507 }
mohammad160306e79202018-03-28 13:17:44 +03001508
Ryan Everett45ac5262024-01-08 17:15:19 +00001509 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1510
Ronald Crond18b5f82020-11-25 16:46:05 +01001511 psa_key_attributes_t attributes = {
1512 .core = slot->attr
1513 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 status = psa_driver_wrapper_export_key(&attributes,
1515 slot->key.data, slot->key.bytes,
1516 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001517
Ryan Everett35f68532024-01-25 12:02:03 +00001518#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everett45ac5262024-01-08 17:15:19 +00001519exit:
Ryan Everett35f68532024-01-25 12:02:03 +00001520#endif
Ryan Everett1b70a072024-01-04 10:32:49 +00001521 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001522
Ryan Everett45ac5262024-01-08 17:15:19 +00001523 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001525}
1526
Ronald Cron7285cda2020-11-26 14:46:37 +01001527psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001528 const psa_key_attributes_t *attributes,
1529 const uint8_t *key_buffer,
1530 size_t key_buffer_size,
1531 uint8_t *data,
1532 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001534{
Ronald Crond18b5f82020-11-25 16:46:05 +01001535 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001536
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001537 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001538 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1539 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001540 /* Exporting public -> public */
1541 return psa_export_key_buffer_internal(
1542 key_buffer, key_buffer_size,
1543 data, data_size, data_length);
1544 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001545#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001546 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1547 return mbedtls_psa_rsa_export_public_key(attributes,
1548 key_buffer,
1549 key_buffer_size,
1550 data,
1551 data_size,
1552 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001553#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001554 /* We don't know how to convert a private RSA key to public. */
1555 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001556#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001557 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001558 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001559#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001560 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1561 return mbedtls_psa_ecp_export_public_key(attributes,
1562 key_buffer,
1563 key_buffer_size,
1564 data,
1565 data_size,
1566 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001567#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001568 /* We don't know how to convert a private ECC key to public */
1569 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001570#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001571 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001572 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001573#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001574 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001575 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001576 key_buffer,
1577 key_buffer_size,
1578 data, data_size,
1579 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001580#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001581 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001582#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001583 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001585 (void) key_buffer;
1586 (void) key_buffer_size;
1587 (void) data;
1588 (void) data_size;
1589 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001591 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001592}
Ronald Crond18b5f82020-11-25 16:46:05 +01001593
Gilles Peskine449bd832023-01-11 14:50:10 +01001594psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
Ryan Everettb1d2c672024-01-08 17:19:30 +00001595 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 size_t data_size,
1597 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001598{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001599 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001600 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001601 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001602 psa_key_attributes_t attributes;
Ryan Everettb1d2c672024-01-08 17:19:30 +00001603 LOCAL_OUTPUT_DECLARE(data_external, data);
Darryl Greendd8fb772018-11-07 16:00:44 +00001604
Ronald Crone907e552021-01-18 13:22:38 +01001605 /* Reject a zero-length output buffer now, since this can never be a
1606 * valid key representation. This way we know that data must be a valid
1607 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001608 if (data_size == 0) {
1609 return PSA_ERROR_BUFFER_TOO_SMALL;
1610 }
Ronald Crone907e552021-01-18 13:22:38 +01001611
Darryl Greendd8fb772018-11-07 16:00:44 +00001612 /* Set the key to empty now, so that even when there are errors, we always
1613 * set data_length to a value between 0 and data_size. On error, setting
1614 * the key to empty is a good choice because an empty key representation is
1615 * unlikely to be accepted anywhere. */
1616 *data_length = 0;
1617
1618 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001619 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1620 if (status != PSA_SUCCESS) {
1621 return status;
1622 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001623
Ryan Everettb1d2c672024-01-08 17:19:30 +00001624 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1625
Gilles Peskine449bd832023-01-11 14:50:10 +01001626 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1627 status = PSA_ERROR_INVALID_ARGUMENT;
1628 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001629 }
1630
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001631 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001632 .core = slot->attr
1633 };
Ronald Cron67227982020-11-26 15:16:05 +01001634 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001635 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001636 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001637
1638exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001639 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001640
Ryan Everettb1d2c672024-01-08 17:19:30 +00001641 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001642 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001643}
1644
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001645MBEDTLS_STATIC_ASSERT(
1646 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1647 "One or more key attribute flag is listed as both external-only and dual-use")
1648MBEDTLS_STATIC_ASSERT(
1649 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1650 "One or more key attribute flag is listed as both internal-only and dual-use")
1651MBEDTLS_STATIC_ASSERT(
1652 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1653 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001654
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001655/** Validate that a key policy is internally well-formed.
1656 *
1657 * This function only rejects invalid policies. It does not validate the
1658 * consistency of the policy with respect to other attributes of the key
1659 * such as the key type.
1660 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001661static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001662{
Gilles Peskine449bd832023-01-11 14:50:10 +01001663 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1664 PSA_KEY_USAGE_COPY |
1665 PSA_KEY_USAGE_ENCRYPT |
1666 PSA_KEY_USAGE_DECRYPT |
1667 PSA_KEY_USAGE_SIGN_MESSAGE |
1668 PSA_KEY_USAGE_VERIFY_MESSAGE |
1669 PSA_KEY_USAGE_SIGN_HASH |
1670 PSA_KEY_USAGE_VERIFY_HASH |
1671 PSA_KEY_USAGE_VERIFY_DERIVATION |
1672 PSA_KEY_USAGE_DERIVE)) != 0) {
1673 return PSA_ERROR_INVALID_ARGUMENT;
1674 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001675
Gilles Peskine449bd832023-01-11 14:50:10 +01001676 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001677}
1678
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001679/** Validate the internal consistency of key attributes.
1680 *
1681 * This function only rejects invalid attribute values. If does not
1682 * validate the consistency of the attributes with any key data that may
1683 * be involved in the creation of the key.
1684 *
1685 * Call this function early in the key creation process.
1686 *
1687 * \param[in] attributes Key attributes for the new key.
1688 * \param[out] p_drv On any return, the driver for the key, if any.
1689 * NULL for a transparent key.
1690 *
1691 */
1692static psa_status_t psa_validate_key_attributes(
1693 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001695{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001696 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1698 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001699
Gilles Peskine449bd832023-01-11 14:50:10 +01001700 status = psa_validate_key_location(lifetime, p_drv);
1701 if (status != PSA_SUCCESS) {
1702 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001703 }
1704
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 status = psa_validate_key_persistence(lifetime);
1706 if (status != PSA_SUCCESS) {
1707 return status;
1708 }
1709
1710 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1711 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1712 return PSA_ERROR_INVALID_ARGUMENT;
1713 }
1714 } else {
1715 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1716 return PSA_ERROR_INVALID_ARGUMENT;
1717 }
1718 }
1719
1720 status = psa_validate_key_policy(&attributes->core.policy);
1721 if (status != PSA_SUCCESS) {
1722 return status;
1723 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001724
1725 /* Refuse to create overly large keys.
1726 * Note that this doesn't trigger on import if the attributes don't
1727 * explicitly specify a size (so psa_get_key_bits returns 0), so
1728 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1730 return PSA_ERROR_NOT_SUPPORTED;
1731 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001732
Gilles Peskine91e8c332019-08-02 19:19:39 +02001733 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1735 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1736 return PSA_ERROR_INVALID_ARGUMENT;
1737 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001738
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001740}
1741
Gilles Peskine4747d192019-04-17 15:05:45 +02001742/** Prepare a key slot to receive key material.
1743 *
1744 * This function allocates a key slot and sets its metadata.
1745 *
1746 * If this function fails, call psa_fail_key_creation().
1747 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001748 * This function is intended to be used as follows:
1749 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001750 * it with the specified attributes, and in case of a volatile key assign it
1751 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001752 * -# Populate the slot with the key material.
1753 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1754 * In case of failure at any step, stop the sequence and call
1755 * psa_fail_key_creation().
1756 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001757 * On success, the key slot's state is PSA_SLOT_FILLING.
1758 * It is the responsibility of the caller to change the slot's state to
1759 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001760 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001761 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001762 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001763 * \param[out] p_slot On success, a pointer to the prepared slot.
1764 * \param[out] p_drv On any return, the driver for the key, if any.
1765 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001766 *
1767 * \retval #PSA_SUCCESS
1768 * The key slot is ready to receive key material.
1769 * \return If this function fails, the key slot is an invalid state.
1770 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001771 */
1772static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001773 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001774 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001775 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001777{
1778 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001779 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001780 psa_key_slot_t *slot;
1781
Gilles Peskinedf179142019-07-15 22:02:14 +02001782 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001783 *p_drv = NULL;
1784
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 status = psa_validate_key_attributes(attributes, p_drv);
1786 if (status != PSA_SUCCESS) {
1787 return status;
1788 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001789
Ryan Everettb69118e2024-01-02 15:54:32 +00001790 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 if (status != PSA_SUCCESS) {
1792 return status;
1793 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001794 slot = *p_slot;
1795
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001796 /* We're storing the declared bit-size of the key. It's up to each
1797 * creation mechanism to verify that this information is correct.
1798 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001799 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001800 * is optional (import, copy). In case of a volatile key, assign it the
1801 * volatile key identifier associated to the slot returned to contain its
1802 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001803
1804 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001806#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1807 slot->attr.id = volatile_key_id;
1808#else
1809 slot->attr.id.key_id = volatile_key_id;
1810#endif
1811 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001812
Gilles Peskine91e8c332019-08-02 19:19:39 +02001813 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001814 * external-only flags, query `attributes`. Thanks to the check
1815 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001816 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001817 * may have set. */
1818 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001819
Gilles Peskinecbaff462019-07-12 23:46:04 +02001820#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001821 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001822 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001823 * create the key file in internal storage, create the
1824 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001825 * persistent data. This is done by starting a transaction that will
1826 * encompass these three actions.
1827 * For registering a volatile key, we just need to find an appropriate
1828 * slot number inside the SE. Since the key is designated volatile, creating
1829 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001830 /* The first thing to do is to find a slot number for the new key.
1831 * We save the slot number in persistent storage as part of the
1832 * transaction data. It will be needed to recover if the power
1833 * fails during the key creation process, to clean up on the secure
1834 * element side after restarting. Obtaining a slot number from the
1835 * secure element driver updates its persistent state, but we do not yet
1836 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001837 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001839 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1841 &slot_number);
1842 if (status != PSA_SUCCESS) {
1843 return status;
1844 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1847 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001848 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001849 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001850 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 status = psa_crypto_save_transaction();
1852 if (status != PSA_SUCCESS) {
1853 (void) psa_crypto_stop_transaction();
1854 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001855 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001856 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001857
1858 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001860 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001861
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001863 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001865 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001866#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1867
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001869}
Gilles Peskine4747d192019-04-17 15:05:45 +02001870
1871/** Finalize the creation of a key once its key material has been set.
1872 *
1873 * This entails writing the key to persistent storage.
1874 *
1875 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001876 * See the documentation of psa_start_key_creation() for the intended use
1877 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001878 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001879 * If the finalization succeeds, the function sets the key slot's state to
1880 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1881 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001882 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001883 * \param[in,out] slot Pointer to the slot with key material.
1884 * \param[in] driver The secure element driver for the key,
1885 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001886 * \param[out] key On success, identifier of the key. Note that the
1887 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001888 *
1889 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001890 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001891 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1892 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1893 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1894 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1895 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1896 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001897 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001898 * \return If this function fails, the key slot is an invalid state.
1899 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001900 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001901static psa_status_t psa_finish_key_creation(
1902 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001903 psa_se_drv_table_entry_t *driver,
1904 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001905{
1906 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001907 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001908 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001909
1910#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001912#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001914 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001915 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001917
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001918 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1919 sizeof(data.slot_number),
1920 "Slot number size does not match psa_se_key_data_storage_t");
1921
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1923 status = psa_save_persistent_key(&slot->attr,
1924 (uint8_t *) &data,
1925 sizeof(data));
1926 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001927#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1928 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001929 /* Key material is saved in export representation in the slot, so
1930 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 status = psa_save_persistent_key(&slot->attr,
1932 slot->key.data,
1933 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001934 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001935 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001936#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1937
Gilles Peskinecbaff462019-07-12 23:46:04 +02001938#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001939 /* Finish the transaction for a key creation. This does not
1940 * happen when registering an existing key. Detect this case
1941 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001942 * creation of a persistent key in a secure element requires a transaction,
1943 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 if (driver != NULL &&
1945 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1946 status = psa_save_se_persistent_data(driver);
1947 if (status != PSA_SUCCESS) {
1948 psa_destroy_persistent_key(slot->attr.id);
1949 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001950 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001952 }
1953#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1954
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001956 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001957 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1958 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001960 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001962 }
Ronald Cron50972942020-11-14 11:28:25 +01001963
Gilles Peskine449bd832023-01-11 14:50:10 +01001964 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001965}
1966
1967/** Abort the creation of a key.
1968 *
1969 * You may call this function after calling psa_start_key_creation(),
1970 * or after psa_finish_key_creation() fails. In other circumstances, this
1971 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001972 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001973 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001974 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001975 * \param[in,out] slot Pointer to the slot with key material.
1976 * \param[in] driver The secure element driver for the key,
1977 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001978 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001979static void psa_fail_key_creation(psa_key_slot_t *slot,
1980 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001981{
Gilles Peskine011e4282019-06-26 18:34:38 +02001982 (void) driver;
1983
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001985 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001987
1988#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001989 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001990 * element, and the failure happened later (when saving metadata
1991 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001992 * element.
1993 * https://github.com/ARMmbed/mbed-crypto/issues/217
1994 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001995
Gilles Peskined7729582019-08-05 15:55:54 +02001996 /* Abort the ongoing transaction if any (there may not be one if
1997 * the creation process failed before starting one, or if the
1998 * key creation is a registration of a key in a secure element).
1999 * Earlier functions must already have done what it takes to undo any
2000 * partial creation. All that's left is to update the transaction data
2001 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002003#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2004
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02002006}
2007
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002008/** Validate optional attributes during key creation.
2009 *
2010 * Some key attributes are optional during key creation. If they are
2011 * specified in the attributes structure, check that they are consistent
2012 * with the data in the slot.
2013 *
2014 * This function should be called near the end of key creation, after
2015 * the slot in memory is fully populated but before saving persistent data.
2016 */
2017static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002018 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002020{
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 if (attributes->core.type != 0) {
2022 if (attributes->core.type != slot->attr.type) {
2023 return PSA_ERROR_INVALID_ARGUMENT;
2024 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002025 }
2026
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002028#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2029 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2031 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002032 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002033 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002034 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002035
Ronald Cron90857082020-11-25 14:58:33 +01002036 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 slot->attr.type,
2038 slot->key.data,
2039 slot->key.bytes,
2040 &rsa);
2041 if (status != PSA_SUCCESS) {
2042 return status;
2043 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002044
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 mbedtls_mpi_init(&actual);
2046 mbedtls_mpi_init(&required);
2047 ret = mbedtls_rsa_export(rsa,
2048 NULL, NULL, NULL, NULL, &actual);
2049 mbedtls_rsa_free(rsa);
2050 mbedtls_free(rsa);
2051 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002052 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 }
2054 ret = mbedtls_mpi_read_binary(&required,
2055 attributes->domain_parameters,
2056 attributes->domain_parameters_size);
2057 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002058 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 }
2060 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002061 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 }
2063rsa_exit:
2064 mbedtls_mpi_free(&actual);
2065 mbedtls_mpi_free(&required);
2066 if (ret != 0) {
2067 return mbedtls_to_psa_error(ret);
2068 }
2069 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002070#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2071 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002072 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002073 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002075 }
2076 }
2077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 if (attributes->core.bits != 0) {
2079 if (attributes->core.bits != slot->attr.bits) {
2080 return PSA_ERROR_INVALID_ARGUMENT;
2081 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002082 }
2083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002085}
2086
Gilles Peskine449bd832023-01-11 14:50:10 +01002087psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everettf028fe12024-01-08 17:14:44 +00002088 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 size_t data_length,
2090 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002091{
2092 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002093 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002094 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002095 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002096 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302097 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002098
Ronald Cron81709fc2020-11-14 12:10:32 +01002099 *key = MBEDTLS_SVC_KEY_ID_INIT;
2100
Gilles Peskine0f84d622019-09-12 19:03:13 +02002101 /* Reject zero-length symmetric keys (including raw data key objects).
2102 * This also rejects any key which might be encoded as an empty string,
2103 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (data_length == 0) {
2105 return PSA_ERROR_INVALID_ARGUMENT;
2106 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002107
Archana449608b2021-09-08 15:36:05 +05302108 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 if (data_length > SIZE_MAX / 8) {
2110 return PSA_ERROR_NOT_SUPPORTED;
2111 }
Archana6ed4bda2021-08-04 10:47:15 +05302112
Ryan Everettf028fe12024-01-08 17:14:44 +00002113 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2114
Gilles Peskine449bd832023-01-11 14:50:10 +01002115 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2116 &slot, &driver);
2117 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002118 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002120
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002121 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302122 * storage ( thus not in the case of importing a key in a secure element
2123 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2124 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 if (slot->key.data == NULL) {
2126 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302127 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 attributes, data, data_length, &storage_size);
2129 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302130 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 }
Archanad8a83dc2021-06-14 10:04:16 +05302132 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 status = psa_allocate_buffer_to_slot(slot, storage_size);
2134 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002135 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002137 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002138
2139 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 status = psa_driver_wrapper_import_key(attributes,
2141 data, data_length,
2142 slot->key.data,
2143 slot->key.bytes,
2144 &slot->key.bytes, &bits);
2145 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002146 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002147 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002148
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002150 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002152 status = PSA_ERROR_INVALID_ARGUMENT;
2153 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002154 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002155
Archana6ed4bda2021-08-04 10:47:15 +05302156 /* Enforce a size limit, and in particular ensure that the bit
2157 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302159 status = PSA_ERROR_NOT_SUPPORTED;
2160 goto exit;
2161 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 status = psa_validate_optional_attributes(slot, attributes);
2163 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002164 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002168exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002169 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 if (status != PSA_SUCCESS) {
2171 psa_fail_key_creation(slot, driver);
2172 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002173
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002175}
2176
Gilles Peskined7729582019-08-05 15:55:54 +02002177#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2178psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002180{
2181 psa_status_t status;
2182 psa_key_slot_t *slot = NULL;
2183 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002184 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002185
2186 /* Leaving attributes unspecified is not currently supported.
2187 * It could make sense to query the key type and size from the
2188 * secure element, but not all secure elements support this
2189 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2191 return PSA_ERROR_NOT_SUPPORTED;
2192 }
2193 if (psa_get_key_bits(attributes) == 0) {
2194 return PSA_ERROR_NOT_SUPPORTED;
2195 }
Gilles Peskined7729582019-08-05 15:55:54 +02002196
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2198 &slot, &driver);
2199 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002200 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 }
Gilles Peskined7729582019-08-05 15:55:54 +02002202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002204
2205exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 if (status != PSA_SUCCESS) {
2207 psa_fail_key_creation(slot, driver);
2208 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002209
Gilles Peskined7729582019-08-05 15:55:54 +02002210 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 psa_close_key(key);
2212 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002213}
2214#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2215
Gilles Peskine449bd832023-01-11 14:50:10 +01002216psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2217 const psa_key_attributes_t *specified_attributes,
2218 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002219{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002220 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002221 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002222 psa_key_slot_t *source_slot = NULL;
2223 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002224 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002225 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302226 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002227
Ronald Cron81709fc2020-11-14 12:10:32 +01002228 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2229
Archana8a180362021-07-05 02:18:48 +05302230 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2232 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002233 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002235
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 status = psa_validate_optional_attributes(source_slot,
2237 specified_attributes);
2238 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002239 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002241
Archana9d17bf42021-09-10 06:22:44 +05302242 /* The target key type and number of bits have been validated by
2243 * psa_validate_optional_attributes() to be either equal to zero or
2244 * equal to the ones of the source key. So it is safe to inherit
2245 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302246 * */
Archana9d17bf42021-09-10 06:22:44 +05302247 actual_attributes.core.bits = source_slot->attr.bits;
2248 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302249
2250
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 status = psa_restrict_key_policy(source_slot->attr.type,
2252 &actual_attributes.core.policy,
2253 &source_slot->attr.policy);
2254 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002255 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2259 &target_slot, &driver);
2260 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002261 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 }
2263 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2264 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302265 /*
Archana9d17bf42021-09-10 06:22:44 +05302266 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302267 * the source key would need to be exported as plaintext and re-imported
2268 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302269 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302270 * appropriate API invocations from the application, if needed.
2271 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002272 status = PSA_ERROR_NOT_SUPPORTED;
2273 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002274 }
Archana8a180362021-07-05 02:18:48 +05302275 /*
2276 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302277 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302278 * - For opaque keys this translates to an invocation of the drivers'
2279 * copy_key entry point through the dispatch layer.
2280 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2282 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2283 &storage_size);
2284 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302285 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 }
Archana374fe5b2021-09-08 15:50:28 +05302287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2289 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302290 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 }
Archana374fe5b2021-09-08 15:50:28 +05302292
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 status = psa_driver_wrapper_copy_key(&actual_attributes,
2294 source_slot->key.data,
2295 source_slot->key.bytes,
2296 target_slot->key.data,
2297 target_slot->key.bytes,
2298 &target_slot->key.bytes);
2299 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302300 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 }
2302 } else {
2303 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302304 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 source_slot->key.bytes);
2306 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302307 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 }
Archana8a180362021-07-05 02:18:48 +05302309 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002311exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 if (status != PSA_SUCCESS) {
2313 psa_fail_key_creation(target_slot, driver);
2314 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002315
Ryan Everett1b70a072024-01-04 10:32:49 +00002316 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002319}
2320
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002321
2322
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002323/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002324/* Message digests */
2325/****************************************************************/
2326
Gilles Peskine449bd832023-01-11 14:50:10 +01002327psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002328{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002329 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 if (operation->id == 0) {
2331 return PSA_SUCCESS;
2332 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002333
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002335 operation->id = 0;
2336
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002338}
2339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2341 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002342{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002343 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002344
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002345 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002347 status = PSA_ERROR_BAD_STATE;
2348 goto exit;
2349 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002350
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002352 status = PSA_ERROR_INVALID_ARGUMENT;
2353 goto exit;
2354 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002355
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002356 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2357 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002359
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002361
2362exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 if (status != PSA_SUCCESS) {
2364 psa_hash_abort(operation);
2365 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002366
2367 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002368}
2369
Gilles Peskine449bd832023-01-11 14:50:10 +01002370psa_status_t psa_hash_update(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002371 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002373{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002374 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002375 LOCAL_INPUT_DECLARE(input_external, input);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002378 status = PSA_ERROR_BAD_STATE;
2379 goto exit;
2380 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002381
Steven Cooremanc8288352021-03-04 14:02:19 +01002382 /* Don't require hash implementations to behave correctly on a
2383 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 if (input_length == 0) {
2385 return PSA_SUCCESS;
2386 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002387
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002388 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002390
2391exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 if (status != PSA_SUCCESS) {
2393 psa_hash_abort(operation);
2394 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002395
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002396 LOCAL_INPUT_FREE(input_external, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002398}
2399
Thomas Daubney31d8c0b2024-01-18 15:26:59 +00002400static psa_status_t psa_hash_finish_internal(psa_hash_operation_t *operation,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002401 uint8_t *hash,
2402 size_t hash_size,
2403 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002404{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2406
Steven Cooremanfbe09282021-03-08 18:41:12 +01002407 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 if (operation->id == 0) {
2409 return PSA_ERROR_BAD_STATE;
2410 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002411
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002412 status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 operation, hash, hash_size, hash_length);
2414 psa_hash_abort(operation);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002415
2416 return status;
2417}
2418
2419psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2420 uint8_t *hash_external,
2421 size_t hash_size,
2422 size_t *hash_length)
2423{
2424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2425 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2426
2427 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2428 status = psa_hash_finish_internal(operation, hash, hash_size, hash_length);
2429
Thomas Daubneydedd1002024-01-25 16:52:50 +00002430#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002431exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002432#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002433 LOCAL_OUTPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002435}
2436
Gilles Peskine449bd832023-01-11 14:50:10 +01002437psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002438 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002440{
Ronald Cron69a63422021-10-18 09:47:58 +02002441 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002442 size_t actual_hash_length;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002443 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2444 LOCAL_INPUT_DECLARE(hash_external, hash);
2445
2446 status = psa_hash_finish_internal(
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 operation,
2448 actual_hash, sizeof(actual_hash),
2449 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002452 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002456 status = PSA_ERROR_INVALID_SIGNATURE;
2457 goto exit;
2458 }
2459
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002460 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002461 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002462 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002464
2465exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2467 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002468 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 }
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002470 LOCAL_INPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002472}
2473
Gilles Peskine449bd832023-01-11 14:50:10 +01002474psa_status_t psa_hash_compute(psa_algorithm_t alg,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002475 const uint8_t *input_external, size_t input_length,
2476 uint8_t *hash_external, size_t hash_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002478{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002479 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2480 LOCAL_INPUT_DECLARE(input_external, input);
2481 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2482
Steven Cooremanfbe09282021-03-08 18:41:12 +01002483 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 if (!PSA_ALG_IS_HASH(alg)) {
2485 return PSA_ERROR_INVALID_ARGUMENT;
2486 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002487
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002488 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2489 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2490 status = psa_driver_wrapper_hash_compute(alg, input, input_length,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002491 hash, hash_size, hash_length);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002492
Thomas Daubneydedd1002024-01-25 16:52:50 +00002493#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002494exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002495#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002496 LOCAL_INPUT_FREE(input_external, input);
2497 LOCAL_OUTPUT_FREE(hash_external, hash);
2498 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002499}
2500
Gilles Peskine449bd832023-01-11 14:50:10 +01002501psa_status_t psa_hash_compare(psa_algorithm_t alg,
Thomas Daubney51ffac92024-01-18 15:46:26 +00002502 const uint8_t *input_external, size_t input_length,
2503 const uint8_t *hash_external, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002504{
Ronald Cron69a63422021-10-18 09:47:58 +02002505 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002506 size_t actual_hash_length;
Thomas Daubney51ffac92024-01-18 15:46:26 +00002507 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2508
2509 LOCAL_INPUT_DECLARE(input_external, input);
2510 LOCAL_INPUT_DECLARE(hash_external, hash);
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002511
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 if (!PSA_ALG_IS_HASH(alg)) {
Thomas Daubney51ffac92024-01-18 15:46:26 +00002513 status = PSA_ERROR_INVALID_ARGUMENT;
2514 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002516
Thomas Daubney51ffac92024-01-18 15:46:26 +00002517 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2518 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 alg, input, input_length,
2520 actual_hash, sizeof(actual_hash),
2521 &actual_hash_length);
2522 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002523 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 }
2525 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002526 status = PSA_ERROR_INVALID_SIGNATURE;
2527 goto exit;
2528 }
Thomas Daubney51ffac92024-01-18 15:46:26 +00002529
2530 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002531 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002532 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002534
2535exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
Thomas Daubney51ffac92024-01-18 15:46:26 +00002537
2538 LOCAL_INPUT_FREE(input_external, input);
2539 LOCAL_INPUT_FREE(hash_external, hash);
2540
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002542}
2543
Gilles Peskine449bd832023-01-11 14:50:10 +01002544psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2545 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002546{
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 if (source_operation->id == 0 ||
2548 target_operation->id != 0) {
2549 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002550 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2553 target_operation);
2554 if (status != PSA_SUCCESS) {
2555 psa_hash_abort(target_operation);
2556 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002557
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002559}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002560
2561
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002562/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002563/* MAC */
2564/****************************************************************/
2565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002567{
Steven Cooremane6804192021-03-19 18:28:56 +01002568 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 if (operation->id == 0) {
2570 return PSA_SUCCESS;
2571 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002574 operation->mac_size = 0;
2575 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002576 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002579}
2580
Ronald Cron2dff3b22021-06-17 16:33:22 +02002581static psa_status_t psa_mac_finalize_alg_and_key_validation(
2582 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002583 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002585{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002586 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 psa_key_type_t key_type = psa_get_key_type(attributes);
2588 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002589
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 if (!PSA_ALG_IS_MAC(alg)) {
2591 return PSA_ERROR_INVALID_ARGUMENT;
2592 }
Steven Cooremane6804192021-03-19 18:28:56 +01002593
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002594 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 status = psa_mac_key_can_do(alg, key_type);
2596 if (status != PSA_SUCCESS) {
2597 return status;
2598 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002599
Steven Cooremand1a68f12021-05-10 11:13:41 +02002600 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002602
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002604 /* A very short MAC is too short for security since it can be
2605 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2606 * so we make this our minimum, even though 32 bits is still
2607 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002609 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2612 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002613 /* It's impossible to "truncate" to a larger length than the full length
2614 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002616 }
2617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002619 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2620 * that is disabled in the compile-time configuration. The result can
2621 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2622 * configuration into account. In this case, force a return of
2623 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2624 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2625 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2626 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2627 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002629 }
2630
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002632}
2633
Gilles Peskine449bd832023-01-11 14:50:10 +01002634static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2635 mbedtls_svc_key_id_t key,
2636 psa_algorithm_t alg,
2637 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002638{
2639 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2640 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002641 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002642 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002643
2644 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002646 status = PSA_ERROR_BAD_STATE;
2647 goto exit;
2648 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002649
2650 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 key,
2652 &slot,
2653 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2654 alg);
2655 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002656 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002658
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002659 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002660 .core = slot->attr
2661 };
2662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2664 &operation->mac_size);
2665 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002666 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002668
2669 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002670 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 if (is_sign) {
2672 status = psa_driver_wrapper_mac_sign_setup(operation,
2673 &attributes,
2674 slot->key.data,
2675 slot->key.bytes,
2676 alg);
2677 } else {
2678 status = psa_driver_wrapper_mac_verify_setup(operation,
2679 &attributes,
2680 slot->key.data,
2681 slot->key.bytes,
2682 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002683 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002684
Gilles Peskinefbfac682018-07-08 20:51:54 +02002685exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 if (status != PSA_SUCCESS) {
2687 psa_mac_abort(operation);
2688 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002689
Ryan Everett1b70a072024-01-04 10:32:49 +00002690 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002693}
2694
Gilles Peskine449bd832023-01-11 14:50:10 +01002695psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2696 mbedtls_svc_key_id_t key,
2697 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002698{
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002700}
2701
Gilles Peskine449bd832023-01-11 14:50:10 +01002702psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2703 mbedtls_svc_key_id_t key,
2704 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002705{
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002707}
2708
Gilles Peskine449bd832023-01-11 14:50:10 +01002709psa_status_t psa_mac_update(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002710 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002712{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002713 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2714 LOCAL_INPUT_DECLARE(input_external, input);
2715
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 if (operation->id == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002717 status = PSA_ERROR_BAD_STATE;
2718 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002720
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002721 /* Don't require hash implementations to behave correctly on a
2722 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 if (input_length == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002724 status = PSA_SUCCESS;
2725 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002727
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002728 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2729 status = psa_driver_wrapper_mac_update(operation, input, input_length);
2730
Gilles Peskine449bd832023-01-11 14:50:10 +01002731 if (status != PSA_SUCCESS) {
2732 psa_mac_abort(operation);
2733 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002734
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002735#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002736exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002737#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002738 LOCAL_INPUT_FREE(input_external, input);
2739
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002741}
2742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002744 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 size_t mac_size,
2746 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002747{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002748 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2749 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002750 LOCAL_OUTPUT_DECLARE(mac_external, mac);
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002751 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002752
Gilles Peskine449bd832023-01-11 14:50:10 +01002753 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002754 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002755 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002756 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002757
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002759 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002760 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002761 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002762
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002763 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2764 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002766 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002767 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002768 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002769
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002771 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002772 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002773 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002774
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002775
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 status = psa_driver_wrapper_mac_sign_finish(operation,
2777 mac, operation->mac_size,
2778 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002779
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002780exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002781 /* In case of success, set the potential excess room in the output buffer
2782 * to an invalid value, to avoid potentially leaking a longer MAC.
2783 * In case of error, set the output length and content to a safe default,
2784 * such that in case the caller misses an error check, the output would be
2785 * an unachievable MAC.
2786 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002788 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002789 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002790 }
mohammad16036df908f2018-04-02 08:34:15 -07002791
Thomas Daubney03f1ea32024-02-01 16:16:27 +00002792 if (mac != NULL) {
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002793 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
2794 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002795
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002797 LOCAL_OUTPUT_FREE(mac_external, mac);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002798
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002800}
2801
Gilles Peskine449bd832023-01-11 14:50:10 +01002802psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002803 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002805{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002806 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2807 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002808 LOCAL_INPUT_DECLARE(mac_external, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002809
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002811 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002812 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002813 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002816 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002817 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002818 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002819
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002821 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002822 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002823 }
2824
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002825 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 status = psa_driver_wrapper_mac_verify_finish(operation,
2827 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002828
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002829exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002831 LOCAL_INPUT_FREE(mac_external, mac);
mohammad16036df908f2018-04-02 08:34:15 -07002832
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002834}
2835
Gilles Peskine449bd832023-01-11 14:50:10 +01002836static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2837 psa_algorithm_t alg,
2838 const uint8_t *input,
2839 size_t input_length,
2840 uint8_t *mac,
2841 size_t mac_size,
2842 size_t *mac_length,
2843 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002844{
2845 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002846 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2847 psa_key_slot_t *slot;
2848 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002849 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002850
Ronald Cron51131b52021-06-17 17:17:20 +02002851 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 key,
2853 &slot,
2854 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2855 alg);
2856 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002857 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002859
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002860 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002861 .core = slot->attr
2862 };
2863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2865 &operation_mac_size);
2866 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002867 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002869
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002871 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002872 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002873 }
2874
2875 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 &attributes,
2877 slot->key.data, slot->key.bytes,
2878 alg,
2879 input, input_length,
2880 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002881
2882exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002883 /* In case of success, set the potential excess room in the output buffer
2884 * to an invalid value, to avoid potentially leaking a longer MAC.
2885 * In case of error, set the output length and content to a safe default,
2886 * such that in case the caller misses an error check, the output would be
2887 * an unachievable MAC.
2888 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002890 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002891 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002892 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002893
2894 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002895
Ryan Everett1b70a072024-01-04 10:32:49 +00002896 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002899}
2900
Gilles Peskine449bd832023-01-11 14:50:10 +01002901psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002902 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002903 const uint8_t *input_external,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002904 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002905 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 size_t mac_size,
2907 size_t *mac_length)
2908{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002909 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2910 LOCAL_INPUT_DECLARE(input_external, input);
2911 LOCAL_OUTPUT_DECLARE(mac_external, mac);
2912
2913 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2914 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
2915 status = psa_mac_compute_internal(key, alg,
Thomas Daubney7480a742024-01-30 11:29:47 +00002916 input, input_length,
2917 mac, mac_size, mac_length, 1);
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002918
2919#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002920exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002921#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002922 LOCAL_INPUT_FREE(input_external, input);
2923 LOCAL_OUTPUT_FREE(mac_external, mac);
2924
2925 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002926}
2927
2928psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2929 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002930 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002932 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002934{
2935 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002936 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2937 size_t actual_mac_length;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002938 LOCAL_INPUT_DECLARE(input_external, input);
2939 LOCAL_INPUT_DECLARE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002940
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002941 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002942 status = psa_mac_compute_internal(key, alg,
2943 input, input_length,
2944 actual_mac, sizeof(actual_mac),
2945 &actual_mac_length, 0);
2946 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002947 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002949
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002951 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002952 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002953 }
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002954
2955 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Dave Rodgman78701152023-08-29 14:20:18 +01002956 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002957 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002958 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002959 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002960
2961exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002963 LOCAL_INPUT_FREE(input_external, input);
2964 LOCAL_INPUT_FREE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002965
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002967}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002968
Gilles Peskinee59236f2018-01-27 23:32:46 +01002969/****************************************************************/
2970/* Asymmetric cryptography */
2971/****************************************************************/
2972
Gilles Peskine449bd832023-01-11 14:50:10 +01002973static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2974 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002975{
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (input_is_message) {
2977 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2978 return PSA_ERROR_INVALID_ARGUMENT;
2979 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002980
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2982 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2983 return PSA_ERROR_INVALID_ARGUMENT;
2984 }
2985 }
2986 } else {
2987 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2988 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002989 }
2990 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002993}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002994
Gilles Peskine449bd832023-01-11 14:50:10 +01002995static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2996 int input_is_message,
2997 psa_algorithm_t alg,
2998 const uint8_t *input,
2999 size_t input_length,
3000 uint8_t *signature,
3001 size_t signature_size,
3002 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003003{
3004 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3005 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3006 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003007 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003008
3009 *signature_length = 0;
3010
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 status = psa_sign_verify_check_alg(input_is_message, alg);
3012 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003013 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003015
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003016 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02003017 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003018 * buffer can in principle be empty since it doesn't actually have
3019 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 if (signature_size == 0) {
3021 return PSA_ERROR_BUFFER_TOO_SMALL;
3022 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003023
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003024 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 key, &slot,
3026 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
3027 PSA_KEY_USAGE_SIGN_HASH,
3028 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003029
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003031 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003033
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003035 status = PSA_ERROR_INVALID_ARGUMENT;
3036 goto exit;
3037 }
3038
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003039 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003041 };
3042
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003044 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003045 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003046 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 signature, signature_size, signature_length);
3048 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003049
3050 status = psa_driver_wrapper_sign_hash(
3051 &attributes, slot->key.data, slot->key.bytes,
3052 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003054 }
3055
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003056
3057exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003058 psa_wipe_tag_output_buffer(signature, status, signature_size,
3059 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003060
Ryan Everett1b70a072024-01-04 10:32:49 +00003061 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003062
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003064}
3065
Gilles Peskine449bd832023-01-11 14:50:10 +01003066static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3067 int input_is_message,
3068 psa_algorithm_t alg,
3069 const uint8_t *input,
3070 size_t input_length,
3071 const uint8_t *signature,
3072 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003073{
3074 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3075 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3076 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003077
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 status = psa_sign_verify_check_alg(input_is_message, alg);
3079 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003080 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003082
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003083 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 key, &slot,
3085 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3086 PSA_KEY_USAGE_VERIFY_HASH,
3087 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003088
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 if (status != PSA_SUCCESS) {
3090 return status;
3091 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003092
3093 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003095 };
3096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003098 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003099 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003100 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 signature, signature_length);
3102 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003103 status = psa_driver_wrapper_verify_hash(
3104 &attributes, slot->key.data, slot->key.bytes,
3105 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003107 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003108
Ryan Everett1b70a072024-01-04 10:32:49 +00003109 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003110
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003112
3113}
3114
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003115psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003116 const psa_key_attributes_t *attributes,
3117 const uint8_t *key_buffer,
3118 size_t key_buffer_size,
3119 psa_algorithm_t alg,
3120 const uint8_t *input,
3121 size_t input_length,
3122 uint8_t *signature,
3123 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003125{
3126 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003127
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003129 size_t hash_length;
3130 uint8_t hash[PSA_HASH_MAX_SIZE];
3131
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003132 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 PSA_ALG_SIGN_GET_HASH(alg),
3134 input, input_length,
3135 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003136
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003138 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003140
3141 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 attributes, key_buffer, key_buffer_size,
3143 alg, hash, hash_length,
3144 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003145 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003146
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003148}
3149
Gilles Peskine449bd832023-01-11 14:50:10 +01003150psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3151 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003152 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003154 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003155 size_t signature_size,
3156 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003157{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003158 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3159 LOCAL_INPUT_DECLARE(input_external, input);
3160 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3161
3162 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3163 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3164 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3165 signature_size, signature_length);
3166
Thomas Daubney3e65f522024-01-30 12:37:25 +00003167#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003168exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003169#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003170 LOCAL_INPUT_FREE(input_external, input);
3171 LOCAL_OUTPUT_FREE(signature_external, signature);
3172 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003173}
3174
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003175psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003176 const psa_key_attributes_t *attributes,
3177 const uint8_t *key_buffer,
3178 size_t key_buffer_size,
3179 psa_algorithm_t alg,
3180 const uint8_t *input,
3181 size_t input_length,
3182 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003184{
3185 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003186
Gilles Peskine449bd832023-01-11 14:50:10 +01003187 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003188 size_t hash_length;
3189 uint8_t hash[PSA_HASH_MAX_SIZE];
3190
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003191 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 PSA_ALG_SIGN_GET_HASH(alg),
3193 input, input_length,
3194 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003195
Gilles Peskine449bd832023-01-11 14:50:10 +01003196 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003197 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003199
3200 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003201 attributes, key_buffer, key_buffer_size,
3202 alg, hash, hash_length,
3203 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003204 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003205
Gilles Peskine449bd832023-01-11 14:50:10 +01003206 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003207}
3208
Gilles Peskine449bd832023-01-11 14:50:10 +01003209psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3210 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003211 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003213 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003214 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003215{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003216 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3217 LOCAL_INPUT_DECLARE(input_external, input);
3218 LOCAL_INPUT_DECLARE(signature_external, signature);
3219
3220 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3221 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3222 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3223 signature_length);
3224
Thomas Daubney3e65f522024-01-30 12:37:25 +00003225#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003226exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003227#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003228 LOCAL_INPUT_FREE(input_external, input);
3229 LOCAL_INPUT_FREE(signature_external, signature);
3230
3231 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003232}
3233
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003234psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003235 const psa_key_attributes_t *attributes,
3236 const uint8_t *key_buffer, size_t key_buffer_size,
3237 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003239{
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3241 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3242 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003243#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3245 return mbedtls_psa_rsa_sign_hash(
3246 attributes,
3247 key_buffer, key_buffer_size,
3248 alg, hash, hash_length,
3249 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003250#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3251 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 } else {
3253 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003254 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003255 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3256 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003257#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3259 return mbedtls_psa_ecdsa_sign_hash(
3260 attributes,
3261 key_buffer, key_buffer_size,
3262 alg, hash, hash_length,
3263 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003264#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3265 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 } else {
3267 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003268 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003269 }
Ronald Cron4501c982021-03-19 20:09:32 +01003270
Gilles Peskine449bd832023-01-11 14:50:10 +01003271 (void) key_buffer;
3272 (void) key_buffer_size;
3273 (void) hash;
3274 (void) hash_length;
3275 (void) signature;
3276 (void) signature_size;
3277 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003278
Gilles Peskine449bd832023-01-11 14:50:10 +01003279 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003280}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003281
Gilles Peskine449bd832023-01-11 14:50:10 +01003282psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3283 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003284 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003286 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003287 size_t signature_size,
3288 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003289{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003290 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3291 LOCAL_INPUT_DECLARE(hash_external, hash);
3292 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3293
3294 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3295 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3296 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3297 signature_size, signature_length);
3298
Thomas Daubney3e65f522024-01-30 12:37:25 +00003299#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003300exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003301#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003302 LOCAL_INPUT_FREE(hash_external, hash);
3303 LOCAL_OUTPUT_FREE(signature_external, signature);
3304
3305 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003306}
3307
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003308psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003309 const psa_key_attributes_t *attributes,
3310 const uint8_t *key_buffer, size_t key_buffer_size,
3311 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003313{
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3315 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3316 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003317#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3319 return mbedtls_psa_rsa_verify_hash(
3320 attributes,
3321 key_buffer, key_buffer_size,
3322 alg, hash, hash_length,
3323 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003324#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3325 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 } else {
3327 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003328 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3330 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003331#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3333 return mbedtls_psa_ecdsa_verify_hash(
3334 attributes,
3335 key_buffer, key_buffer_size,
3336 alg, hash, hash_length,
3337 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003338#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3339 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 } else {
3341 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003342 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003343 }
Ronald Cron4501c982021-03-19 20:09:32 +01003344
Gilles Peskine449bd832023-01-11 14:50:10 +01003345 (void) key_buffer;
3346 (void) key_buffer_size;
3347 (void) hash;
3348 (void) hash_length;
3349 (void) signature;
3350 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003351
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003353}
3354
Gilles Peskine449bd832023-01-11 14:50:10 +01003355psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3356 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003357 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003359 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003361{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003362 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3363 LOCAL_INPUT_DECLARE(hash_external, hash);
3364 LOCAL_INPUT_DECLARE(signature_external, signature);
3365
3366 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3367 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3368 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3369 signature_length);
3370
Thomas Daubney3e65f522024-01-30 12:37:25 +00003371#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003372exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003373#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003374 LOCAL_INPUT_FREE(hash_external, hash);
3375 LOCAL_INPUT_FREE(signature_external, signature);
3376
3377 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003378}
3379
Gilles Peskine449bd832023-01-11 14:50:10 +01003380psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3381 psa_algorithm_t alg,
3382 const uint8_t *input,
3383 size_t input_length,
3384 const uint8_t *salt,
3385 size_t salt_length,
3386 uint8_t *output,
3387 size_t output_size,
3388 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003389{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003391 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003392 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003393 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003394
Darryl Green5cc689a2018-07-24 15:34:10 +01003395 (void) input;
3396 (void) input_length;
3397 (void) salt;
3398 (void) output;
3399 (void) output_size;
3400
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003401 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003402
Gilles Peskine449bd832023-01-11 14:50:10 +01003403 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3404 return PSA_ERROR_INVALID_ARGUMENT;
3405 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003406
Valerio Setti5bb454a2024-01-15 10:43:16 +01003407 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003408 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3409 if (status != PSA_SUCCESS) {
3410 return status;
3411 }
3412 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3413 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003414 status = PSA_ERROR_INVALID_ARGUMENT;
3415 goto exit;
3416 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003417
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003418 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003420 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003421
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003422 status = psa_driver_wrapper_asymmetric_encrypt(
3423 &attributes, slot->key.data, slot->key.bytes,
3424 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003425 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003426exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003427 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003428
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003430}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003431
Gilles Peskine449bd832023-01-11 14:50:10 +01003432psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3433 psa_algorithm_t alg,
3434 const uint8_t *input,
3435 size_t input_length,
3436 const uint8_t *salt,
3437 size_t salt_length,
3438 uint8_t *output,
3439 size_t output_size,
3440 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003441{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003442 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003443 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003444 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003445 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003446
Darryl Green5cc689a2018-07-24 15:34:10 +01003447 (void) input;
3448 (void) input_length;
3449 (void) salt;
3450 (void) output;
3451 (void) output_size;
3452
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003453 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003454
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3456 return PSA_ERROR_INVALID_ARGUMENT;
3457 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003458
Valerio Setti5bb454a2024-01-15 10:43:16 +01003459 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3461 if (status != PSA_SUCCESS) {
3462 return status;
3463 }
3464 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003465 status = PSA_ERROR_INVALID_ARGUMENT;
3466 goto exit;
3467 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003468
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003469 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003470 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003471 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003472
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003473 status = psa_driver_wrapper_asymmetric_decrypt(
3474 &attributes, slot->key.data, slot->key.bytes,
3475 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003476 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003477
3478exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003479 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003480
Gilles Peskine449bd832023-01-11 14:50:10 +01003481 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003482}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003483
Paul Elliott9fe12f62022-11-30 19:16:02 +00003484/****************************************************************/
3485/* Asymmetric interruptible cryptography */
3486/****************************************************************/
3487
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003488static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3489
Paul Elliott9fe12f62022-11-30 19:16:02 +00003490void psa_interruptible_set_max_ops(uint32_t max_ops)
3491{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003492 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003493}
3494
3495uint32_t psa_interruptible_get_max_ops(void)
3496{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003497 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003498}
3499
Paul Elliott9fe12f62022-11-30 19:16:02 +00003500uint32_t psa_sign_hash_get_num_ops(
3501 const psa_sign_hash_interruptible_operation_t *operation)
3502{
Paul Elliott296ede92022-12-15 17:00:30 +00003503 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003504}
3505
3506uint32_t psa_verify_hash_get_num_ops(
3507 const psa_verify_hash_interruptible_operation_t *operation)
3508{
Paul Elliott296ede92022-12-15 17:00:30 +00003509 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003510}
3511
Paul Elliott59ad9452022-12-18 15:09:02 +00003512static psa_status_t psa_sign_hash_abort_internal(
3513 psa_sign_hash_interruptible_operation_t *operation)
3514{
3515 if (operation->id == 0) {
3516 /* The object has (apparently) been initialized but it is not (yet)
3517 * in use. It's ok to call abort on such an object, and there's
3518 * nothing to do. */
3519 return PSA_SUCCESS;
3520 }
3521
3522 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3523
3524 status = psa_driver_wrapper_sign_hash_abort(operation);
3525
3526 operation->id = 0;
3527
Paul Elliotte6145dc2023-02-07 12:51:21 +00003528 /* Do not clear either the error_occurred or num_ops elements here as they
3529 * only want to be cleared by the application calling abort, not by abort
3530 * being called at completion of an operation. */
3531
Paul Elliott59ad9452022-12-18 15:09:02 +00003532 return status;
3533}
3534
Paul Elliott9fe12f62022-11-30 19:16:02 +00003535psa_status_t psa_sign_hash_start(
3536 psa_sign_hash_interruptible_operation_t *operation,
3537 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3538 const uint8_t *hash, size_t hash_length)
3539{
3540 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3541 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3542 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003543 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003544
Paul Elliottc9774412023-02-06 15:14:07 +00003545 /* Check that start has not been previously called, or operation has not
3546 * previously errored. */
3547 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003548 return PSA_ERROR_BAD_STATE;
3549 }
3550
Paul Elliott9fe12f62022-11-30 19:16:02 +00003551 status = psa_sign_verify_check_alg(0, alg);
3552 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003553 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003554 return status;
3555 }
3556
3557 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3558 PSA_KEY_USAGE_SIGN_HASH,
3559 alg);
3560
3561 if (status != PSA_SUCCESS) {
3562 goto exit;
3563 }
3564
3565 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3566 status = PSA_ERROR_INVALID_ARGUMENT;
3567 goto exit;
3568 }
3569
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003570 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003571 .core = slot->attr
3572 };
3573
Paul Elliott296ede92022-12-15 17:00:30 +00003574 /* Ensure ops count gets reset, in case of operation re-use. */
3575 operation->num_ops = 0;
3576
Paul Elliott9fe12f62022-11-30 19:16:02 +00003577 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3578 slot->key.data,
3579 slot->key.bytes, alg,
3580 hash, hash_length);
3581exit:
3582
3583 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003584 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003585 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003586 }
3587
Ryan Everett1b70a072024-01-04 10:32:49 +00003588 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003589
Paul Elliottc9774412023-02-06 15:14:07 +00003590 if (unlock_status != PSA_SUCCESS) {
3591 operation->error_occurred = 1;
3592 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003593
Paul Elliottc9774412023-02-06 15:14:07 +00003594 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003595}
3596
3597
3598psa_status_t psa_sign_hash_complete(
3599 psa_sign_hash_interruptible_operation_t *operation,
3600 uint8_t *signature, size_t signature_size,
3601 size_t *signature_length)
3602{
3603 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3604
3605 *signature_length = 0;
3606
Paul Elliottc9774412023-02-06 15:14:07 +00003607 /* Check that start has been called first, and that operation has not
3608 * previously errored. */
3609 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003610 status = PSA_ERROR_BAD_STATE;
3611 goto exit;
3612 }
3613
Paul Elliott096abc42023-02-03 18:33:23 +00003614 /* Immediately reject a zero-length signature buffer. This guarantees that
3615 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003616 if (signature_size == 0) {
3617 status = PSA_ERROR_BUFFER_TOO_SMALL;
3618 goto exit;
3619 }
3620
3621 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3622 signature_size,
3623 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003624
Paul Elliott296ede92022-12-15 17:00:30 +00003625 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003626 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003627
Paul Elliottebe225c2023-02-10 14:32:53 +00003628exit:
3629
Paul Elliott59200a22023-02-21 15:07:40 +00003630 psa_wipe_tag_output_buffer(signature, status, signature_size,
3631 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003632
Paul Elliott53bb3122023-02-10 14:22:22 +00003633 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003634 if (status != PSA_SUCCESS) {
3635 operation->error_occurred = 1;
3636 }
3637
Paul Elliott59ad9452022-12-18 15:09:02 +00003638 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003639 }
3640
3641 return status;
3642}
3643
3644psa_status_t psa_sign_hash_abort(
3645 psa_sign_hash_interruptible_operation_t *operation)
3646{
Paul Elliott59ad9452022-12-18 15:09:02 +00003647 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3648
3649 status = psa_sign_hash_abort_internal(operation);
3650
3651 /* We clear the number of ops done here, so that it is not cleared when
3652 * the operation fails or succeeds, only on manual abort. */
3653 operation->num_ops = 0;
3654
Paul Elliottc9774412023-02-06 15:14:07 +00003655 /* Likewise, failure state. */
3656 operation->error_occurred = 0;
3657
Paul Elliott59ad9452022-12-18 15:09:02 +00003658 return status;
3659}
3660
3661static psa_status_t psa_verify_hash_abort_internal(
3662 psa_verify_hash_interruptible_operation_t *operation)
3663{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003664 if (operation->id == 0) {
3665 /* The object has (apparently) been initialized but it is not (yet)
3666 * in use. It's ok to call abort on such an object, and there's
3667 * nothing to do. */
3668 return PSA_SUCCESS;
3669 }
3670
Paul Elliott59ad9452022-12-18 15:09:02 +00003671 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3672
3673 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003674
3675 operation->id = 0;
3676
Paul Elliotte6145dc2023-02-07 12:51:21 +00003677 /* Do not clear either the error_occurred or num_ops elements here as they
3678 * only want to be cleared by the application calling abort, not by abort
3679 * being called at completion of an operation. */
3680
Paul Elliott59ad9452022-12-18 15:09:02 +00003681 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003682}
3683
3684psa_status_t psa_verify_hash_start(
3685 psa_verify_hash_interruptible_operation_t *operation,
3686 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3687 const uint8_t *hash, size_t hash_length,
3688 const uint8_t *signature, size_t signature_length)
3689{
3690 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3691 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3692 psa_key_slot_t *slot;
3693
Paul Elliottc9774412023-02-06 15:14:07 +00003694 /* Check that start has not been previously called, or operation has not
3695 * previously errored. */
3696 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003697 return PSA_ERROR_BAD_STATE;
3698 }
3699
3700 status = psa_sign_verify_check_alg(0, alg);
3701 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003702 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003703 return status;
3704 }
3705
3706 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3707 PSA_KEY_USAGE_VERIFY_HASH,
3708 alg);
3709
3710 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003711 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003712 return status;
3713 }
3714
3715 psa_key_attributes_t attributes = {
3716 .core = slot->attr
3717 };
3718
Paul Elliott296ede92022-12-15 17:00:30 +00003719 /* Ensure ops count gets reset, in case of operation re-use. */
3720 operation->num_ops = 0;
3721
Paul Elliott9fe12f62022-11-30 19:16:02 +00003722 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3723 slot->key.data,
3724 slot->key.bytes,
3725 alg, hash, hash_length,
3726 signature, signature_length);
3727
3728 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003729 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003730 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003731 }
3732
Ryan Everett1b70a072024-01-04 10:32:49 +00003733 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003734
Paul Elliottc9774412023-02-06 15:14:07 +00003735 if (unlock_status != PSA_SUCCESS) {
3736 operation->error_occurred = 1;
3737 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003738
Paul Elliottc9774412023-02-06 15:14:07 +00003739 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003740}
3741
3742psa_status_t psa_verify_hash_complete(
3743 psa_verify_hash_interruptible_operation_t *operation)
3744{
3745 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3746
Paul Elliottc9774412023-02-06 15:14:07 +00003747 /* Check that start has been called first, and that operation has not
3748 * previously errored. */
3749 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003750 status = PSA_ERROR_BAD_STATE;
3751 goto exit;
3752 }
3753
3754 status = psa_driver_wrapper_verify_hash_complete(operation);
3755
Paul Elliott296ede92022-12-15 17:00:30 +00003756 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003757 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003758 operation);
3759
Paul Elliottebe225c2023-02-10 14:32:53 +00003760exit:
3761
Paul Elliott9fe12f62022-11-30 19:16:02 +00003762 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003763 if (status != PSA_SUCCESS) {
3764 operation->error_occurred = 1;
3765 }
3766
Paul Elliott59ad9452022-12-18 15:09:02 +00003767 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003768 }
3769
3770 return status;
3771}
3772
3773psa_status_t psa_verify_hash_abort(
3774 psa_verify_hash_interruptible_operation_t *operation)
3775{
Paul Elliott59ad9452022-12-18 15:09:02 +00003776 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003777
Paul Elliott59ad9452022-12-18 15:09:02 +00003778 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003779
Paul Elliott59ad9452022-12-18 15:09:02 +00003780 /* We clear the number of ops done here, so that it is not cleared when
3781 * the operation fails or succeeds, only on manual abort. */
3782 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003783
Paul Elliottc9774412023-02-06 15:14:07 +00003784 /* Likewise, failure state. */
3785 operation->error_occurred = 0;
3786
Paul Elliott59ad9452022-12-18 15:09:02 +00003787 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003788}
3789
Paul Elliott588f8ed2022-12-02 18:10:26 +00003790/****************************************************************/
3791/* Asymmetric interruptible cryptography internal */
3792/* implementations */
3793/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003794
Paul Elliott588f8ed2022-12-02 18:10:26 +00003795void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3796{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003797
Paul Elliott588f8ed2022-12-02 18:10:26 +00003798#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3799 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3800 defined(MBEDTLS_ECP_RESTARTABLE)
3801
3802 /* Internal implementation uses zero to indicate infinite number max ops,
3803 * therefore avoid this value, and set to minimum possible. */
3804 if (max_ops == 0) {
3805 max_ops = 1;
3806 }
3807
Paul Elliott588f8ed2022-12-02 18:10:26 +00003808 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003809#else
3810 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003811#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3812 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3813 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3814}
3815
Paul Elliott588f8ed2022-12-02 18:10:26 +00003816uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003817 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003818{
3819#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3820 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3821 defined(MBEDTLS_ECP_RESTARTABLE)
3822
Paul Elliott93d9ca82023-02-15 18:14:21 +00003823 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003824#else
3825 (void) operation;
3826 return 0;
3827#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3828 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3829 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3830}
3831
3832uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003833 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003834{
3835 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3836 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3837 defined(MBEDTLS_ECP_RESTARTABLE)
3838
Paul Elliott93d9ca82023-02-15 18:14:21 +00003839 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003840#else
3841 (void) operation;
3842 return 0;
3843#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3844 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3845 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3846}
3847
3848psa_status_t mbedtls_psa_sign_hash_start(
3849 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3850 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3851 size_t key_buffer_size, psa_algorithm_t alg,
3852 const uint8_t *hash, size_t hash_length)
3853{
3854 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003855 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003856
Paul Elliott068fe072023-01-16 13:59:15 +00003857 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3858 return PSA_ERROR_NOT_SUPPORTED;
3859 }
3860
3861 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003862 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003863 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003864
3865#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003866 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3867 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003868
Paul Elliotta1c94092023-02-15 16:38:04 +00003869 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3870
Paul Elliott93d9ca82023-02-15 18:14:21 +00003871 /* Ensure num_ops is zero'ed in case of context re-use. */
3872 operation->num_ops = 0;
3873
Paul Elliott068fe072023-01-16 13:59:15 +00003874 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3875 attributes->core.bits,
3876 key_buffer,
3877 key_buffer_size,
3878 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003879
Paul Elliott068fe072023-01-16 13:59:15 +00003880 if (status != PSA_SUCCESS) {
3881 return status;
3882 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003883
Paul Elliott1bc59df2023-02-05 13:41:57 +00003884 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003885 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003886
Paul Elliott068fe072023-01-16 13:59:15 +00003887 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003888 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003889 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003890
Paul Elliott0290a762023-02-09 14:30:24 +00003891 /* We only need to store the same length of hash as the private key size
3892 * here, it would be truncated by the internal implementation anyway. */
3893 required_hash_length = (hash_length < operation->coordinate_bytes ?
3894 hash_length : operation->coordinate_bytes);
3895
Paul Elliottba70ad42023-02-15 18:23:53 +00003896 if (required_hash_length > sizeof(operation->hash)) {
3897 /* Shouldn't happen, but better safe than sorry. */
3898 return PSA_ERROR_CORRUPTION_DETECTED;
3899 }
3900
Paul Elliott0290a762023-02-09 14:30:24 +00003901 memcpy(operation->hash, hash, required_hash_length);
3902 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003903
3904 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003905
3906#else
Paul Elliott068fe072023-01-16 13:59:15 +00003907 (void) operation;
3908 (void) key_buffer;
3909 (void) key_buffer_size;
3910 (void) alg;
3911 (void) hash;
3912 (void) hash_length;
3913 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003914 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003915
Paul Elliott068fe072023-01-16 13:59:15 +00003916 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003917#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3918 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3919 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003920}
3921
3922psa_status_t mbedtls_psa_sign_hash_complete(
3923 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3924 uint8_t *signature, size_t signature_size,
3925 size_t *signature_length)
3926{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003927#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3928 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3929 defined(MBEDTLS_ECP_RESTARTABLE)
3930
Paul Elliotta1c94092023-02-15 16:38:04 +00003931 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003932 mbedtls_mpi r;
3933 mbedtls_mpi s;
3934
Paul Elliott46845252023-02-03 14:59:11 +00003935 mbedtls_mpi_init(&r);
3936 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003937
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003938 /* Ensure max_ops is set to the current value (or default). */
3939 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3940
Paul Elliotta1c94092023-02-15 16:38:04 +00003941 if (signature_size < 2 * operation->coordinate_bytes) {
3942 status = PSA_ERROR_BUFFER_TOO_SMALL;
3943 goto exit;
3944 }
3945
Paul Elliott588f8ed2022-12-02 18:10:26 +00003946 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003947
Paul Elliott588f8ed2022-12-02 18:10:26 +00003948#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3949 status = mbedtls_to_psa_error(
3950 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003951 &r,
3952 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003953 &operation->ctx->d,
3954 operation->hash,
3955 operation->hash_length,
3956 operation->md_alg,
3957 mbedtls_psa_get_random,
3958 MBEDTLS_PSA_RANDOM_STATE,
3959 &operation->restart_ctx));
3960#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003961 status = PSA_ERROR_NOT_SUPPORTED;
3962 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003963#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3964 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003965 status = mbedtls_to_psa_error(
3966 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003967 &r,
3968 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003969 &operation->ctx->d,
3970 operation->hash,
3971 operation->hash_length,
3972 mbedtls_psa_get_random,
3973 MBEDTLS_PSA_RANDOM_STATE,
3974 mbedtls_psa_get_random,
3975 MBEDTLS_PSA_RANDOM_STATE,
3976 &operation->restart_ctx));
3977 }
3978
Paul Elliottf8e5b562023-02-19 18:43:45 +00003979 /* Hide the fact that the restart context only holds a delta of number of
3980 * ops done during the last operation, not an absolute value. */
3981 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3982
Paul Elliott724bd252023-02-08 12:35:08 +00003983 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003984 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003985 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003986 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003987 operation->coordinate_bytes)
3988 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003989
3990 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003991 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003992 }
3993
3994 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003995 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003996 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003997 operation->coordinate_bytes,
3998 operation->coordinate_bytes)
3999 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004000
4001 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004002 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004003 }
4004
Paul Elliott1bc59df2023-02-05 13:41:57 +00004005 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004006
Paul Elliott724bd252023-02-08 12:35:08 +00004007 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004008 }
Paul Elliott724bd252023-02-08 12:35:08 +00004009
4010exit:
4011
4012 mbedtls_mpi_free(&r);
4013 mbedtls_mpi_free(&s);
4014 return status;
4015
Paul Elliott588f8ed2022-12-02 18:10:26 +00004016 #else
4017
4018 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004019 (void) signature;
4020 (void) signature_size;
4021 (void) signature_length;
4022
4023 return PSA_ERROR_NOT_SUPPORTED;
4024
4025#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4026 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4027 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4028}
4029
4030psa_status_t mbedtls_psa_sign_hash_abort(
4031 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4032{
4033
4034#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4035 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4036 defined(MBEDTLS_ECP_RESTARTABLE)
4037
4038 if (operation->ctx) {
4039 mbedtls_ecdsa_free(operation->ctx);
4040 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004041 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004042 }
4043
4044 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4045
Paul Elliott93d9ca82023-02-15 18:14:21 +00004046 operation->num_ops = 0;
4047
Paul Elliott588f8ed2022-12-02 18:10:26 +00004048 return PSA_SUCCESS;
4049
4050#else
4051
4052 (void) operation;
4053
4054 return PSA_ERROR_NOT_SUPPORTED;
4055
4056#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4057 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4058 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4059}
4060
4061psa_status_t mbedtls_psa_verify_hash_start(
4062 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4063 const psa_key_attributes_t *attributes,
4064 const uint8_t *key_buffer, size_t key_buffer_size,
4065 psa_algorithm_t alg,
4066 const uint8_t *hash, size_t hash_length,
4067 const uint8_t *signature, size_t signature_length)
4068{
4069 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004070 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004071 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004072
Paul Elliott068fe072023-01-16 13:59:15 +00004073 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4074 return PSA_ERROR_NOT_SUPPORTED;
4075 }
4076
4077 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004078 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004079 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004080
4081#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004082 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4083 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004084
Paul Elliotta1c94092023-02-15 16:38:04 +00004085 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4086 mbedtls_mpi_init(&operation->r);
4087 mbedtls_mpi_init(&operation->s);
4088
Paul Elliott93d9ca82023-02-15 18:14:21 +00004089 /* Ensure num_ops is zero'ed in case of context re-use. */
4090 operation->num_ops = 0;
4091
Paul Elliott068fe072023-01-16 13:59:15 +00004092 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4093 attributes->core.bits,
4094 key_buffer,
4095 key_buffer_size,
4096 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004097
Paul Elliott068fe072023-01-16 13:59:15 +00004098 if (status != PSA_SUCCESS) {
4099 return status;
4100 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004101
Paul Elliottc569fc22023-02-10 13:02:54 +00004102 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004103
Paul Elliott1bc59df2023-02-05 13:41:57 +00004104 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004105 return PSA_ERROR_INVALID_SIGNATURE;
4106 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004107
Paul Elliott068fe072023-01-16 13:59:15 +00004108 status = mbedtls_to_psa_error(
4109 mbedtls_mpi_read_binary(&operation->r,
4110 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004111 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004112
Paul Elliott068fe072023-01-16 13:59:15 +00004113 if (status != PSA_SUCCESS) {
4114 return status;
4115 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004116
Paul Elliott068fe072023-01-16 13:59:15 +00004117 status = mbedtls_to_psa_error(
4118 mbedtls_mpi_read_binary(&operation->s,
4119 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004120 coordinate_bytes,
4121 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004122
Paul Elliott068fe072023-01-16 13:59:15 +00004123 if (status != PSA_SUCCESS) {
4124 return status;
4125 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004126
Paul Elliott2c9843f2023-02-15 17:32:42 +00004127 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004128
Paul Elliott2c9843f2023-02-15 17:32:42 +00004129 if (status != PSA_SUCCESS) {
4130 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004131 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004132
Paul Elliott0290a762023-02-09 14:30:24 +00004133 /* We only need to store the same length of hash as the private key size
4134 * here, it would be truncated by the internal implementation anyway. */
4135 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4136 coordinate_bytes);
4137
Paul Elliottba70ad42023-02-15 18:23:53 +00004138 if (required_hash_length > sizeof(operation->hash)) {
4139 /* Shouldn't happen, but better safe than sorry. */
4140 return PSA_ERROR_CORRUPTION_DETECTED;
4141 }
4142
Paul Elliott0290a762023-02-09 14:30:24 +00004143 memcpy(operation->hash, hash, required_hash_length);
4144 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004145
4146 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004147#else
Paul Elliott068fe072023-01-16 13:59:15 +00004148 (void) operation;
4149 (void) key_buffer;
4150 (void) key_buffer_size;
4151 (void) alg;
4152 (void) hash;
4153 (void) hash_length;
4154 (void) signature;
4155 (void) signature_length;
4156 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004157 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004158 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004159
Paul Elliott068fe072023-01-16 13:59:15 +00004160 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004161#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4162 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4163 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004164}
4165
4166psa_status_t mbedtls_psa_verify_hash_complete(
4167 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4168{
4169
4170#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4171 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4172 defined(MBEDTLS_ECP_RESTARTABLE)
4173
Paul Elliottf8e5b562023-02-19 18:43:45 +00004174 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4175
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004176 /* Ensure max_ops is set to the current value (or default). */
4177 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4178
Paul Elliottf8e5b562023-02-19 18:43:45 +00004179 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004180 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4181 operation->hash,
4182 operation->hash_length,
4183 &operation->ctx->Q,
4184 &operation->r,
4185 &operation->s,
4186 &operation->restart_ctx));
4187
Paul Elliottf8e5b562023-02-19 18:43:45 +00004188 /* Hide the fact that the restart context only holds a delta of number of
4189 * ops done during the last operation, not an absolute value. */
4190 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4191
4192 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004193#else
4194 (void) operation;
4195
4196 return PSA_ERROR_NOT_SUPPORTED;
4197
4198#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4199 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4200 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4201}
4202
4203psa_status_t mbedtls_psa_verify_hash_abort(
4204 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4205{
4206
4207#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4208 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4209 defined(MBEDTLS_ECP_RESTARTABLE)
4210
4211 if (operation->ctx) {
4212 mbedtls_ecdsa_free(operation->ctx);
4213 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004214 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004215 }
4216
4217 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4218
Paul Elliott93d9ca82023-02-15 18:14:21 +00004219 operation->num_ops = 0;
4220
Paul Elliott588f8ed2022-12-02 18:10:26 +00004221 mbedtls_mpi_free(&operation->r);
4222 mbedtls_mpi_free(&operation->s);
4223
4224 return PSA_SUCCESS;
4225
4226#else
4227 (void) operation;
4228
4229 return PSA_ERROR_NOT_SUPPORTED;
4230
4231#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4232 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4233 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4234}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004235
mohammad1603503973b2018-03-12 15:59:30 +02004236/****************************************************************/
4237/* Symmetric cryptography */
4238/****************************************************************/
4239
Gilles Peskine449bd832023-01-11 14:50:10 +01004240static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4241 mbedtls_svc_key_id_t key,
4242 psa_algorithm_t alg,
4243 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004244{
4245 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4246 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004247 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4249 PSA_KEY_USAGE_ENCRYPT :
4250 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004251 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004252
4253 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004255 status = PSA_ERROR_BAD_STATE;
4256 goto exit;
4257 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004258
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004260 status = PSA_ERROR_INVALID_ARGUMENT;
4261 goto exit;
4262 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004263
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4265 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004266 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004268
Ronald Cron49fafa92021-03-10 08:34:23 +01004269 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004270 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004271 * so we only set it (in the driver wrapper) after resources have been
4272 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004273 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004275 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004277 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 }
4279 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004280
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004281 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004283 };
4284
Ronald Cronab99ac22020-10-01 16:38:28 +02004285 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 if (cipher_operation == MBEDTLS_ENCRYPT) {
4287 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4288 &attributes,
4289 slot->key.data,
4290 slot->key.bytes,
4291 alg);
4292 } else {
4293 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4294 &attributes,
4295 slot->key.data,
4296 slot->key.bytes,
4297 alg);
4298 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004299
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004300exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 if (status != PSA_SUCCESS) {
4302 psa_cipher_abort(operation);
4303 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004304
Ryan Everett1b70a072024-01-04 10:32:49 +00004305 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004306
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004308}
4309
Gilles Peskine449bd832023-01-11 14:50:10 +01004310psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4311 mbedtls_svc_key_id_t key,
4312 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004313{
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004315}
4316
Gilles Peskine449bd832023-01-11 14:50:10 +01004317psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4318 mbedtls_svc_key_id_t key,
4319 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004320{
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004322}
4323
Gilles Peskine449bd832023-01-11 14:50:10 +01004324psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4325 uint8_t *iv,
4326 size_t iv_size,
4327 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004328{
Ronald Cron6d051732020-10-01 14:10:20 +02004329 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004330 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004331 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004332
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004334 status = PSA_ERROR_BAD_STATE;
4335 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004336 }
4337
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004339 status = PSA_ERROR_BAD_STATE;
4340 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004341 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004342
Ronald Cron2fb90522021-07-05 12:31:44 +02004343 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004345 status = PSA_ERROR_BUFFER_TOO_SMALL;
4346 goto exit;
4347 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004348
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004350 status = PSA_ERROR_GENERIC_ERROR;
4351 goto exit;
4352 }
4353
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 status = psa_generate_random(local_iv, default_iv_length);
4355 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004356 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 }
Ronald Cron5618a392021-03-26 09:52:26 +01004358
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 status = psa_driver_wrapper_cipher_set_iv(operation,
4360 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004361
4362exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 if (status == PSA_SUCCESS) {
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004364 psa_crypto_copy_output(local_iv, default_iv_length, iv, iv_size);
Ronald Cron2fb90522021-07-05 12:31:44 +02004365 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004366 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004368 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004370 }
Ronald Cron6d051732020-10-01 14:10:20 +02004371
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004373}
4374
Gilles Peskine449bd832023-01-11 14:50:10 +01004375psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004376 const uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004378{
Ronald Cron6d051732020-10-01 14:10:20 +02004379 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004380
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004381 LOCAL_INPUT_DECLARE(iv_external, iv);
4382
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004384 status = PSA_ERROR_BAD_STATE;
4385 goto exit;
4386 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004387
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004389 status = PSA_ERROR_BAD_STATE;
4390 goto exit;
4391 }
Ronald Crona0d68172021-03-26 10:15:08 +01004392
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004394 status = PSA_ERROR_INVALID_ARGUMENT;
4395 goto exit;
4396 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004397
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004398 LOCAL_INPUT_ALLOC(iv_external, iv_length, iv);
4399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 status = psa_driver_wrapper_cipher_set_iv(operation,
4401 iv,
4402 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004403
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004404exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004406 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 } else {
4408 psa_cipher_abort(operation);
4409 }
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004410
4411 LOCAL_INPUT_FREE(iv_external, iv);
4412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004414}
4415
Gilles Peskine449bd832023-01-11 14:50:10 +01004416psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004417 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004419 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 size_t output_size,
4421 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004422{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004423 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004424
Gabor Mezei212eb082024-01-24 16:56:00 +01004425 LOCAL_INPUT_DECLARE(input_external, input);
4426 LOCAL_OUTPUT_DECLARE(output_external, output);
4427
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004429 status = PSA_ERROR_BAD_STATE;
4430 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004431 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004432
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004434 status = PSA_ERROR_BAD_STATE;
4435 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004436 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004437
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004438 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4439 LOCAL_OUTPUT_ALLOC_WITH_COPY(output_external, output_size, output);
4440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 status = psa_driver_wrapper_cipher_update(operation,
4442 input,
4443 input_length,
4444 output,
4445 output_size,
4446 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004447
4448exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 if (status != PSA_SUCCESS) {
4450 psa_cipher_abort(operation);
4451 }
Ronald Cron6d051732020-10-01 14:10:20 +02004452
Gabor Mezei212eb082024-01-24 16:56:00 +01004453 LOCAL_INPUT_FREE(input_external, input);
4454 LOCAL_OUTPUT_FREE(output_external, output);
4455
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004457}
4458
Gilles Peskine449bd832023-01-11 14:50:10 +01004459psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004460 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 size_t output_size,
4462 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004463{
David Saadab4ecc272019-02-14 13:48:10 +02004464 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004465
Gabor Mezei212eb082024-01-24 16:56:00 +01004466 LOCAL_OUTPUT_DECLARE(output_external, output);
4467
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004469 status = PSA_ERROR_BAD_STATE;
4470 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004471 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004472
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004474 status = PSA_ERROR_BAD_STATE;
4475 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004476 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004477
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004478 LOCAL_OUTPUT_ALLOC_WITH_COPY(output_external, output_size, output);
4479
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 status = psa_driver_wrapper_cipher_finish(operation,
4481 output,
4482 output_size,
4483 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004484
4485exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 if (status == PSA_SUCCESS) {
Gabor Mezei212eb082024-01-24 16:56:00 +01004487 status = psa_cipher_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004489 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 (void) psa_cipher_abort(operation);
Steven Cooremanef8575e2020-09-11 11:44:50 +02004491 }
Gabor Mezei212eb082024-01-24 16:56:00 +01004492
4493 LOCAL_OUTPUT_FREE(output_external, output);
4494
4495 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004496}
4497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004499{
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004501 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004502 * in use. It's ok to call abort on such an object, and there's
4503 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004505 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004506
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004508
Ronald Cron49fafa92021-03-10 08:34:23 +01004509 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004510 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004511 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004512
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004514}
4515
Gilles Peskine449bd832023-01-11 14:50:10 +01004516psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4517 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004518 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004520 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 size_t output_size,
4522 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004523{
4524 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004525 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004526 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004527 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4528 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004529 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004530
David Horstmann62a56d92023-12-14 18:12:47 +00004531 LOCAL_INPUT_DECLARE(input_external, input);
4532 LOCAL_OUTPUT_DECLARE(output_external, output);
4533
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 Mezei8b8e4852024-01-31 17:45:29 +01004568 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4569 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4570
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004571 status = psa_driver_wrapper_cipher_encrypt(
4572 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004573 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004574 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004576
4577exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004578 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004580 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004581 }
Ronald Cron23919522021-07-08 19:00:07 +02004582
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 if (status == PSA_SUCCESS) {
4584 if (default_iv_length > 0) {
4585 memcpy(output, local_iv, default_iv_length);
4586 }
4587 *output_length += default_iv_length;
4588 } else {
4589 *output_length = 0;
4590 }
4591
David Horstmann62a56d92023-12-14 18:12:47 +00004592 LOCAL_INPUT_FREE(input_external, input);
4593 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004594
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004596}
4597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4599 psa_algorithm_t alg,
Gabor Mezei212eb082024-01-24 16:56:00 +01004600 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004602 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 size_t output_size,
4604 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004605{
4606 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004607 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004608 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004609 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004610
Gabor Mezei212eb082024-01-24 16:56:00 +01004611 LOCAL_INPUT_DECLARE(input_external, input);
4612 LOCAL_OUTPUT_DECLARE(output_external, output);
4613
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004615 status = PSA_ERROR_INVALID_ARGUMENT;
4616 goto exit;
4617 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004618
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4620 PSA_KEY_USAGE_DECRYPT,
4621 alg);
4622 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004623 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004625
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004626 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004628 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004629
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4631 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004632 status = PSA_ERROR_INVALID_ARGUMENT;
4633 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004635 status = PSA_ERROR_INVALID_ARGUMENT;
4636 goto exit;
4637 }
4638
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004639 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4640 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4641
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004642 status = psa_driver_wrapper_cipher_decrypt(
4643 &attributes, slot->key.data, slot->key.bytes,
4644 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004646
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004647exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004648 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004650 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004654 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 }
Ronald Cron23919522021-07-08 19:00:07 +02004656
Gabor Mezei212eb082024-01-24 16:56:00 +01004657 LOCAL_INPUT_FREE(input_external, input);
4658 LOCAL_OUTPUT_FREE(output_external, output);
4659
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004661}
4662
4663
mohammad16035955c982018-04-26 00:53:03 +03004664/****************************************************************/
4665/* AEAD */
4666/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004667
Paul Elliottbaff51c2021-09-28 17:44:45 +01004668/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004669static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004670{
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004672}
4673
4674/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004675static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4676 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004677{
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004681#if defined(PSA_WANT_ALG_GCM)
4682 case PSA_ALG_GCM:
4683 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 * arbitrarily large nonces. Please note that we do not generally
4685 * recommend the usage of nonces of greater length than
4686 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4687 * size, which can then lead to collisions if you encrypt a very
4688 * large number of messages.*/
4689 if (nonce_length != 0) {
4690 return PSA_SUCCESS;
4691 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004692 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004693#endif /* PSA_WANT_ALG_GCM */
4694#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004695 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 if (nonce_length >= 7 && nonce_length <= 13) {
4697 return PSA_SUCCESS;
4698 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004699 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004700#endif /* PSA_WANT_ALG_CCM */
4701#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004702 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 if (nonce_length == 12) {
4704 return PSA_SUCCESS;
4705 } else if (nonce_length == 8) {
4706 return PSA_ERROR_NOT_SUPPORTED;
4707 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004708 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004709#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004710 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004711 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004713 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004714
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004716}
4717
Gilles Peskine449bd832023-01-11 14:50:10 +01004718static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004719{
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4721 return PSA_ERROR_INVALID_ARGUMENT;
4722 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004723
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004725}
4726
Gilles Peskine449bd832023-01-11 14:50:10 +01004727psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4728 psa_algorithm_t alg,
David Horstmann9d09a022023-11-28 19:25:00 +00004729 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 size_t nonce_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004731 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 size_t additional_data_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004733 const uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 size_t plaintext_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004735 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 size_t ciphertext_size,
4737 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004738{
Ronald Cron215633c2021-03-16 17:15:37 +01004739 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4740 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004741
David Horstmann9d09a022023-11-28 19:25:00 +00004742 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4743 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4744 LOCAL_INPUT_DECLARE(plaintext_external, plaintext);
4745 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
4746
mohammad1603f08a5502018-06-03 15:05:47 +03004747 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004748
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 status = psa_aead_check_algorithm(alg);
4750 if (status != PSA_SUCCESS) {
4751 return status;
4752 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004753
Ronald Cron9a986162021-03-26 12:40:07 +01004754 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4756 if (status != PSA_SUCCESS) {
4757 return status;
4758 }
mohammad16035955c982018-04-26 00:53:03 +03004759
Ronald Cron215633c2021-03-16 17:15:37 +01004760 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004762 };
mohammad16035955c982018-04-26 00:53:03 +03004763
David Horstmann9d09a022023-11-28 19:25:00 +00004764 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4765 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length, additional_data);
4766 LOCAL_INPUT_ALLOC(plaintext_external, plaintext_length, plaintext);
4767 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
4768
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 status = psa_aead_check_nonce_length(alg, nonce_length);
4770 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004771 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004773
Ronald Cronde822812021-03-17 16:08:20 +01004774 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004775 &attributes, slot->key.data, slot->key.bytes,
4776 alg,
4777 nonce, nonce_length,
4778 additional_data, additional_data_length,
4779 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004781
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4783 memset(ciphertext, 0, ciphertext_size);
4784 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004785
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004786exit:
David Horstmann9d09a022023-11-28 19:25:00 +00004787 LOCAL_INPUT_FREE(nonce_external, nonce);
4788 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4789 LOCAL_INPUT_FREE(plaintext_external, plaintext);
4790 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
4791
Ryan Everett1b70a072024-01-04 10:32:49 +00004792 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004793
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004795}
4796
Gilles Peskine449bd832023-01-11 14:50:10 +01004797psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4798 psa_algorithm_t alg,
David Horstmann7f2e0402023-11-28 19:43:53 +00004799 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 size_t nonce_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004801 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 size_t additional_data_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004803 const uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 size_t ciphertext_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004805 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 size_t plaintext_size,
4807 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004808{
Ronald Cron215633c2021-03-16 17:15:37 +01004809 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4810 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004811
David Horstmann7f2e0402023-11-28 19:43:53 +00004812 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4813 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4814 LOCAL_INPUT_DECLARE(ciphertext_external, ciphertext);
4815 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
4816
Gilles Peskineee652a32018-06-01 19:23:52 +02004817 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004818
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 status = psa_aead_check_algorithm(alg);
4820 if (status != PSA_SUCCESS) {
4821 return status;
4822 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004823
Ronald Cron9a986162021-03-26 12:40:07 +01004824 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4826 if (status != PSA_SUCCESS) {
4827 return status;
4828 }
mohammad16035955c982018-04-26 00:53:03 +03004829
Ronald Cron215633c2021-03-16 17:15:37 +01004830 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004832 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004833
David Horstmann7f2e0402023-11-28 19:43:53 +00004834 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4835 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length,
4836 additional_data);
4837 LOCAL_INPUT_ALLOC(ciphertext_external, ciphertext_length, ciphertext);
4838 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
4839
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 status = psa_aead_check_nonce_length(alg, nonce_length);
4841 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004842 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004844
Ronald Cronde822812021-03-17 16:08:20 +01004845 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004846 &attributes, slot->key.data, slot->key.bytes,
4847 alg,
4848 nonce, nonce_length,
4849 additional_data, additional_data_length,
4850 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004852
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 if (status != PSA_SUCCESS && plaintext_size != 0) {
4854 memset(plaintext, 0, plaintext_size);
4855 }
mohammad160360a64d02018-06-03 17:20:42 +03004856
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004857exit:
David Horstmann7f2e0402023-11-28 19:43:53 +00004858 LOCAL_INPUT_FREE(nonce_external, nonce);
4859 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4860 LOCAL_INPUT_FREE(ciphertext_external, ciphertext);
4861 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
4862
Ryan Everett1b70a072024-01-04 10:32:49 +00004863 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004864
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 return status;
mohammad16035955c982018-04-26 00:53:03 +03004866}
4867
Gilles Peskine449bd832023-01-11 14:50:10 +01004868static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4869{
4870 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004871
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004873#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004875 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4877 return PSA_ERROR_INVALID_ARGUMENT;
4878 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004879 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004880#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004881
Przemek Stekiel86679c72022-10-06 17:06:56 +02004882#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004884 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4886 return PSA_ERROR_INVALID_ARGUMENT;
4887 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004888 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004889#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004890
Przemek Stekiel86679c72022-10-06 17:06:56 +02004891#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004893 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 if (tag_len != 16) {
4895 return PSA_ERROR_INVALID_ARGUMENT;
4896 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004897 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004898#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004899
4900 default:
4901 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004903 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004905}
4906
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004907/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004908static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4909 int is_encrypt,
4910 mbedtls_svc_key_id_t key,
4911 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004912{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004913 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4914 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4915 psa_key_slot_t *slot = NULL;
4916 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004917 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004918
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 status = psa_aead_check_algorithm(alg);
4920 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004921 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004923
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004925 status = PSA_ERROR_BAD_STATE;
4926 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004927 }
4928
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 if (operation->nonce_set || operation->lengths_set ||
4930 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004931 status = PSA_ERROR_BAD_STATE;
4932 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004933 }
4934
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004936 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004938 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004940
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4942 alg);
4943 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004944 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004946
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004947 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004948 .core = slot->attr
4949 };
4950
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004952 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004954
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 if (is_encrypt) {
4956 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4957 &attributes,
4958 slot->key.data,
4959 slot->key.bytes,
4960 alg);
4961 } else {
4962 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4963 &attributes,
4964 slot->key.data,
4965 slot->key.bytes,
4966 alg);
4967 }
4968 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004969 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004973
4974exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004975 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004976
Gilles Peskine449bd832023-01-11 14:50:10 +01004977 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004978 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004980 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 } else {
4982 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004983 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004984
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004986}
4987
Paul Elliott302ff6b2021-04-20 18:10:30 +01004988/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004989psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4990 mbedtls_svc_key_id_t key,
4991 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004992{
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004994}
4995
4996/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004997psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4998 mbedtls_svc_key_id_t key,
4999 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005000{
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005002}
5003
David Horstmannfed23772023-12-19 17:49:20 +00005004static psa_status_t psa_aead_set_nonce_internal(psa_aead_operation_t *operation,
5005 const uint8_t *nonce,
5006 size_t nonce_length)
5007{
5008 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5009
5010 if (operation->id == 0) {
5011 status = PSA_ERROR_BAD_STATE;
5012 goto exit;
5013 }
5014
5015 if (operation->nonce_set) {
5016 status = PSA_ERROR_BAD_STATE;
5017 goto exit;
5018 }
5019
5020 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5021 if (status != PSA_SUCCESS) {
5022 status = PSA_ERROR_INVALID_ARGUMENT;
5023 goto exit;
5024 }
5025
5026 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5027 nonce_length);
5028
5029exit:
5030 if (status == PSA_SUCCESS) {
5031 operation->nonce_set = 1;
5032 } else {
5033 psa_aead_abort(operation);
5034 }
5035
5036 return status;
5037}
5038
Paul Elliott302ff6b2021-04-20 18:10:30 +01005039/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01005040psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
David Horstmannd3cad8b2023-12-11 14:46:04 +00005041 uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 size_t nonce_size,
5043 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005044{
5045 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01005046 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07005047 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005048
David Horstmannd3cad8b2023-12-11 14:46:04 +00005049 LOCAL_OUTPUT_DECLARE(nonce_external, nonce);
5050 LOCAL_OUTPUT_ALLOC(nonce_external, nonce_size, nonce);
5051
Paul Elliott8eb9daf2021-06-04 16:42:21 +01005052 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005053
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005055 status = PSA_ERROR_BAD_STATE;
5056 goto exit;
5057 }
5058
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005060 status = PSA_ERROR_BAD_STATE;
5061 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005062 }
5063
Paul Elliotte193ea82021-10-01 13:00:16 +01005064 /* For CCM, this size may not be correct according to the PSA
5065 * specification. The PSA Crypto 1.0.1 specification states:
5066 *
5067 * CCM encodes the plaintext length pLen in L octets, with L the smallest
5068 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
5069 *
5070 * However this restriction that L has to be the smallest integer is not
5071 * applied in practice, and it is not implementable here since the
5072 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
5074 operation->alg);
5075 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005076 status = PSA_ERROR_BUFFER_TOO_SMALL;
5077 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005078 }
5079
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 status = psa_generate_random(local_nonce, required_nonce_size);
5081 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005082 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005084
David Horstmannfed23772023-12-19 17:49:20 +00005085 status = psa_aead_set_nonce_internal(operation, local_nonce,
5086 required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005087
Paul Elliott39dc6b82021-05-11 19:16:09 +01005088exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 if (status == PSA_SUCCESS) {
5090 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005091 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 } else {
5093 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005094 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005095
David Horstmannd3cad8b2023-12-11 14:46:04 +00005096 LOCAL_OUTPUT_FREE(nonce_external, nonce);
5097
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005099}
5100
5101/* Set the nonce for a multipart authenticated encryption or decryption
5102 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005103psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
David Horstmann8f0ef512023-12-11 15:17:11 +00005104 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005106{
David Horstmannfed23772023-12-19 17:49:20 +00005107 psa_status_t status;
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005108
David Horstmann8f0ef512023-12-11 15:17:11 +00005109 LOCAL_INPUT_DECLARE(nonce_external, nonce);
5110 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
Paul Elliottcee785c2021-05-20 14:29:20 +01005111
David Horstmannfed23772023-12-19 17:49:20 +00005112 status = psa_aead_set_nonce_internal(operation, nonce, nonce_length);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005113
David Horstmann18dc0322023-12-20 16:16:43 +00005114/* Exit label is only needed for buffer copying, prevent unused warnings. */
5115#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Paul Elliott39dc6b82021-05-11 19:16:09 +01005116exit:
David Horstmann18dc0322023-12-20 16:16:43 +00005117#endif
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005118
David Horstmann8f0ef512023-12-11 15:17:11 +00005119 LOCAL_INPUT_FREE(nonce_external, nonce);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005120
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005122}
5123
5124/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005125psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5126 size_t ad_length,
5127 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005128{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5130
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005132 status = PSA_ERROR_BAD_STATE;
5133 goto exit;
5134 }
5135
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 if (operation->lengths_set || operation->ad_started ||
5137 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005138 status = PSA_ERROR_BAD_STATE;
5139 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005140 }
5141
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005143#if defined(PSA_WANT_ALG_GCM)
5144 case PSA_ALG_GCM:
5145 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 * bits. Without the guard this code will generate warnings on 32bit
5147 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005148#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 if (((uint64_t) ad_length) >> 61 != 0 ||
5150 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005151 status = PSA_ERROR_INVALID_ARGUMENT;
5152 goto exit;
5153 }
Paul Elliott325d3742021-09-27 17:56:28 +01005154#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005155 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005156#endif /* PSA_WANT_ALG_GCM */
5157#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005158 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005160 status = PSA_ERROR_INVALID_ARGUMENT;
5161 goto exit;
5162 }
5163 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005164#endif /* PSA_WANT_ALG_CCM */
5165#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005166 case PSA_ALG_CHACHA20_POLY1305:
5167 /* No length restrictions for ChaChaPoly. */
5168 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005169#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005170 default:
5171 break;
5172 }
Paul Elliott325d3742021-09-27 17:56:28 +01005173
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5175 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005176
Paul Elliott39dc6b82021-05-11 19:16:09 +01005177exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005179 operation->ad_remaining = ad_length;
5180 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005181 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 } else {
5183 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005184 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005185
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005187}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005188
5189/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005190psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
David Horstmann25dac6e2023-12-11 15:23:13 +00005191 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005193{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005194 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5195
David Horstmann25dac6e2023-12-11 15:23:13 +00005196 LOCAL_INPUT_DECLARE(input_external, input);
5197 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5198
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005200 status = PSA_ERROR_BAD_STATE;
5201 goto exit;
5202 }
5203
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005205 status = PSA_ERROR_BAD_STATE;
5206 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005207 }
5208
Gilles Peskine449bd832023-01-11 14:50:10 +01005209 if (operation->lengths_set) {
5210 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005211 status = PSA_ERROR_INVALID_ARGUMENT;
5212 goto exit;
5213 }
5214
5215 operation->ad_remaining -= input_length;
5216 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005217#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005219 status = PSA_ERROR_BAD_STATE;
5220 goto exit;
5221 }
5222#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005223
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 status = psa_driver_wrapper_aead_update_ad(operation, input,
5225 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005226
Paul Elliott39dc6b82021-05-11 19:16:09 +01005227exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005229 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 } else {
5231 psa_aead_abort(operation);
5232 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005233
David Horstmann25dac6e2023-12-11 15:23:13 +00005234 LOCAL_INPUT_FREE(input_external, input);
5235
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005237}
5238
5239/* Encrypt or decrypt a message fragment in an active multipart AEAD
5240 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005241psa_status_t psa_aead_update(psa_aead_operation_t *operation,
David Horstmann2914fac2023-12-11 15:28:37 +00005242 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 size_t input_length,
David Horstmann2914fac2023-12-11 15:28:37 +00005244 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 size_t output_size,
5246 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005247{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005248 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005249
David Horstmann2914fac2023-12-11 15:28:37 +00005250
5251 LOCAL_INPUT_DECLARE(input_external, input);
5252 LOCAL_OUTPUT_DECLARE(output_external, output);
5253
5254 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5255 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
5256
Paul Elliott302ff6b2021-04-20 18:10:30 +01005257 *output_length = 0;
5258
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005260 status = PSA_ERROR_BAD_STATE;
5261 goto exit;
5262 }
5263
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005265 status = PSA_ERROR_BAD_STATE;
5266 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005267 }
5268
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005270 /* Additional data length was supplied, but not all the additional
5271 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005273 status = PSA_ERROR_INVALID_ARGUMENT;
5274 goto exit;
5275 }
5276
5277 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005279 status = PSA_ERROR_INVALID_ARGUMENT;
5280 goto exit;
5281 }
5282
5283 operation->body_remaining -= input_length;
5284 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005285#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005287 status = PSA_ERROR_BAD_STATE;
5288 goto exit;
5289 }
5290#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005291
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5293 output, output_size,
5294 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005295
Paul Elliott39dc6b82021-05-11 19:16:09 +01005296exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005298 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 } else {
5300 psa_aead_abort(operation);
5301 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005302
David Horstmann2914fac2023-12-11 15:28:37 +00005303 LOCAL_INPUT_FREE(input_external, input);
5304 LOCAL_OUTPUT_FREE(output_external, output);
5305
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005307}
5308
Gilles Peskine449bd832023-01-11 14:50:10 +01005309static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005310{
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 if (operation->id == 0 || !operation->nonce_set) {
5312 return PSA_ERROR_BAD_STATE;
5313 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005314
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5316 operation->body_remaining != 0)) {
5317 return PSA_ERROR_INVALID_ARGUMENT;
5318 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005319
Gilles Peskine449bd832023-01-11 14:50:10 +01005320 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005321}
5322
Paul Elliott302ff6b2021-04-20 18:10:30 +01005323/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005324psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
David Horstmann6db0e732023-12-11 15:35:59 +00005325 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 size_t ciphertext_size,
5327 size_t *ciphertext_length,
David Horstmann6db0e732023-12-11 15:35:59 +00005328 uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 size_t tag_size,
5330 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005331{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005332 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5333
David Horstmann6db0e732023-12-11 15:35:59 +00005334 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
5335 LOCAL_OUTPUT_DECLARE(tag_external, tag);
5336
5337 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
5338 LOCAL_OUTPUT_ALLOC(tag_external, tag_size, tag);
5339
Paul Elliott302ff6b2021-04-20 18:10:30 +01005340 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005341 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005342
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 status = psa_aead_final_checks(operation);
5344 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005345 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005347
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005349 status = PSA_ERROR_BAD_STATE;
5350 goto exit;
5351 }
5352
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5354 ciphertext_size,
5355 ciphertext_length,
5356 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005357
Paul Elliott39dc6b82021-05-11 19:16:09 +01005358exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005359
5360
Paul Elliottf47b0952021-05-21 18:02:33 +01005361 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005362 * the zero tag size, make sure the tag is set to something implausible.
5363 * Even if the operation succeeds, make sure we clear the rest of the
5364 * buffer to prevent potential leakage of anything previously placed in
5365 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005366 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005367
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005369
David Horstmann6db0e732023-12-11 15:35:59 +00005370 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
5371 LOCAL_OUTPUT_FREE(tag_external, tag);
5372
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005374}
5375
5376/* Finish authenticating and decrypting a message in a multipart AEAD
5377 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005378psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
David Horstmanne000a0a2023-12-11 16:37:04 +00005379 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 size_t plaintext_size,
5381 size_t *plaintext_length,
David Horstmanne000a0a2023-12-11 16:37:04 +00005382 const uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005384{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005385 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5386
David Horstmanne000a0a2023-12-11 16:37:04 +00005387 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
5388 LOCAL_INPUT_DECLARE(tag_external, tag);
5389
5390 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
5391 LOCAL_INPUT_ALLOC(tag_external, tag_length, tag);
5392
Paul Elliott302ff6b2021-04-20 18:10:30 +01005393 *plaintext_length = 0;
5394
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 status = psa_aead_final_checks(operation);
5396 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005397 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005399
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005401 status = PSA_ERROR_BAD_STATE;
5402 goto exit;
5403 }
5404
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5406 plaintext_size,
5407 plaintext_length,
5408 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005409
5410exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005412
David Horstmanne000a0a2023-12-11 16:37:04 +00005413 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
5414 LOCAL_INPUT_FREE(tag_external, tag);
5415
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005417}
5418
5419/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005420psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005421{
5422 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5423
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005425 /* The object has (apparently) been initialized but it is not (yet)
5426 * in use. It's ok to call abort on such an object, and there's
5427 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005429 }
5430
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005432
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005434
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005436}
5437
Gilles Peskinee59236f2018-01-27 23:32:46 +01005438/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005439/* Generators */
5440/****************************************************************/
5441
Przemek Stekiel69c46792022-06-10 12:59:51 +02005442#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005443 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005444 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305445 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305446 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005447#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005448#endif /* At least one builtin KDF */
5449
Przemek Stekiel69c46792022-06-10 12:59:51 +02005450#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005451 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5452 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5453static psa_status_t psa_key_derivation_start_hmac(
5454 psa_mac_operation_t *operation,
5455 psa_algorithm_t hash_alg,
5456 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005458{
5459 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5460 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5462 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5463 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005464
Steven Cooreman72f736a2021-05-07 14:14:37 +02005465 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005467
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 status = psa_driver_wrapper_mac_sign_setup(operation,
5469 &attributes,
5470 hmac_key, hmac_key_length,
5471 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005472
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 psa_reset_key_attributes(&attributes);
5474 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005475}
5476#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005477
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005478#define HKDF_STATE_INIT 0 /* no input yet */
5479#define HKDF_STATE_STARTED 1 /* got salt */
5480#define HKDF_STATE_KEYED 2 /* got key */
5481#define HKDF_STATE_OUTPUT 3 /* output started */
5482
Gilles Peskinecbe66502019-05-16 16:59:18 +02005483static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005485{
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5487 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5488 } else {
5489 return operation->alg;
5490 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005491}
5492
Gilles Peskine449bd832023-01-11 14:50:10 +01005493psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005494{
5495 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5497 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005498 /* The object has (apparently) been initialized but it is not
5499 * in use. It's ok to call abort on such an object, and there's
5500 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005502#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5504 mbedtls_free(operation->ctx.hkdf.info);
5505 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5506 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005507#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005508#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5509 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005510 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5511 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5512 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5513 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005514 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005516 }
5517
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005519 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005521 }
5522
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005524 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005526 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005527#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005528 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005529 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005531 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005532#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005533 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005534
5535 /* We leave the fields Ai and output_block to be erased safely by the
5536 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005537 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005538#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5539 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005540#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5542 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5543 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5544 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005545#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305546#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305547 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305548 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005549 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305550 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305551 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305552
5553 status = PSA_SUCCESS;
5554 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305555#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005556 {
5557 status = PSA_ERROR_BAD_STATE;
5558 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 mbedtls_platform_zeroize(operation, sizeof(*operation));
5560 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005561}
5562
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005563psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005565{
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005567 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005569 }
5570
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005571 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005573}
5574
Gilles Peskine449bd832023-01-11 14:50:10 +01005575psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5576 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005577{
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 if (operation->alg == 0) {
5579 return PSA_ERROR_BAD_STATE;
5580 }
5581 if (capacity > operation->capacity) {
5582 return PSA_ERROR_INVALID_ARGUMENT;
5583 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005584 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005586}
5587
Przemek Stekiel69c46792022-06-10 12:59:51 +02005588#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005589/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005590static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5591 psa_algorithm_t kdf_alg,
5592 uint8_t *output,
5593 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005594{
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5596 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005597 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005598 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005599#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005601#else
5602 const uint8_t last_block = 0xff;
5603#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005604
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 if (hkdf->state < HKDF_STATE_KEYED ||
5606 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005607#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005609#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 )) {
5611 return PSA_ERROR_BAD_STATE;
5612 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005613 hkdf->state = HKDF_STATE_OUTPUT;
5614
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005616 /* Copy what remains of the current block */
5617 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005619 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 }
5621 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005622 output += n;
5623 output_length -= n;
5624 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005625 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005626 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005627 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005628 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005629 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005630 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005631 * object was corrupted or if this function is called directly
5632 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 if (hkdf->block_number == last_block) {
5634 return PSA_ERROR_BAD_STATE;
5635 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005636
5637 /* We need a new block */
5638 ++hkdf->block_number;
5639 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005640
Gilles Peskine449bd832023-01-11 14:50:10 +01005641 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5642 hash_alg,
5643 hkdf->prk,
5644 hash_length);
5645 if (status != PSA_SUCCESS) {
5646 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005647 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005648
5649 if (hkdf->block_number != 1) {
5650 status = psa_mac_update(&hkdf->hmac,
5651 hkdf->output_block,
5652 hash_length);
5653 if (status != PSA_SUCCESS) {
5654 return status;
5655 }
5656 }
5657 status = psa_mac_update(&hkdf->hmac,
5658 hkdf->info,
5659 hkdf->info_length);
5660 if (status != PSA_SUCCESS) {
5661 return status;
5662 }
5663 status = psa_mac_update(&hkdf->hmac,
5664 &hkdf->block_number, 1);
5665 if (status != PSA_SUCCESS) {
5666 return status;
5667 }
5668 status = psa_mac_sign_finish(&hkdf->hmac,
5669 hkdf->output_block,
5670 sizeof(hkdf->output_block),
5671 &hmac_output_length);
5672 if (status != PSA_SUCCESS) {
5673 return status;
5674 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005675 }
5676
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005678}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005679#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005680
John Durkop07cc04a2020-11-16 22:08:34 -08005681#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5682 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005683static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5684 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005686{
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5688 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005689 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5690 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005691 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005692
Janos Follath7742fee2019-06-17 12:58:10 +01005693 /* We can't be wanting more output after block 0xff, otherwise
5694 * the capacity check in psa_key_derivation_output_bytes() would have
5695 * prevented this call. It could happen only if the operation
5696 * object was corrupted or if this function is called directly
5697 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 if (tls12_prf->block_number == 0xff) {
5699 return PSA_ERROR_CORRUPTION_DETECTED;
5700 }
Janos Follath7742fee2019-06-17 12:58:10 +01005701
5702 /* We need a new block */
5703 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005704 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005705
5706 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5707 *
5708 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5709 *
5710 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5711 * HMAC_hash(secret, A(2) + seed) +
5712 * HMAC_hash(secret, A(3) + seed) + ...
5713 *
5714 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005715 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005716 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005717 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005718 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005719 * is currently extracted as `output_block` and where i is
5720 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005721 */
5722
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 status = psa_key_derivation_start_hmac(&hmac,
5724 hash_alg,
5725 tls12_prf->secret,
5726 tls12_prf->secret_length);
5727 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005728 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005730
5731 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005733 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5734 * the variable seed and in this instance means it in the context of the
5735 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 status = psa_mac_update(&hmac,
5737 tls12_prf->label,
5738 tls12_prf->label_length);
5739 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005740 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 }
5742 status = psa_mac_update(&hmac,
5743 tls12_prf->seed,
5744 tls12_prf->seed_length);
5745 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005746 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 }
5748 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005749 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005750 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5751 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005752 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005754 }
5755
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 status = psa_mac_sign_finish(&hmac,
5757 tls12_prf->Ai, hash_length,
5758 &hmac_output_length);
5759 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005760 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 }
5762 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005763 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005765
5766 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 status = psa_key_derivation_start_hmac(&hmac,
5768 hash_alg,
5769 tls12_prf->secret,
5770 tls12_prf->secret_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_update(&hmac, tls12_prf->Ai, hash_length);
5775 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005776 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005777 }
5778 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5779 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005780 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 }
5782 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5783 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005784 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005785 }
5786 status = psa_mac_sign_finish(&hmac,
5787 tls12_prf->output_block, hash_length,
5788 &hmac_output_length);
5789 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005790 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005792
Janos Follath7742fee2019-06-17 12:58:10 +01005793
5794cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 cleanup_status = psa_mac_abort(&hmac);
5796 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005797 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005799
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005801}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005802
Janos Follath844eb0e2019-06-19 12:10:49 +01005803static psa_status_t psa_key_derivation_tls12_prf_read(
5804 psa_tls12_prf_key_derivation_t *tls12_prf,
5805 psa_algorithm_t alg,
5806 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005807 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005808{
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5810 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005811 psa_status_t status;
5812 uint8_t offset, length;
5813
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005815 case PSA_TLS12_PRF_STATE_LABEL_SET:
5816 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5817 break;
5818 case PSA_TLS12_PRF_STATE_OUTPUT:
5819 break;
5820 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005822 }
5823
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005825 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 if (tls12_prf->left_in_block == 0) {
5827 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5828 alg);
5829 if (status != PSA_SUCCESS) {
5830 return status;
5831 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005832
5833 continue;
5834 }
5835
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005837 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005839 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005841
5842 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005844 output += length;
5845 output_length -= length;
5846 tls12_prf->left_in_block -= length;
5847 }
5848
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005850}
John Durkop07cc04a2020-11-16 22:08:34 -08005851#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5852 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005853
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005854#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5855static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5856 psa_tls12_ecjpake_to_pms_t *ecjpake,
5857 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005859{
5860 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005861 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005862
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 if (output_length != 32) {
5864 return PSA_ERROR_INVALID_ARGUMENT;
5865 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005866
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5868 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5869 &output_size);
5870 if (status != PSA_SUCCESS) {
5871 return status;
5872 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005873
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 if (output_size != output_length) {
5875 return PSA_ERROR_GENERIC_ERROR;
5876 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005877
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005879}
5880#endif
5881
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305882#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305883static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5884 psa_pbkdf2_key_derivation_t *pbkdf2,
5885 psa_algorithm_t prf_alg,
5886 uint8_t prf_output_length,
5887 psa_key_attributes_t *attributes)
5888{
5889 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305890 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305891 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305892 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305893 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305894 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305895 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305896
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305897 mac_operation.is_sign = 1;
5898 mac_operation.mac_size = prf_output_length;
5899 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305900
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305901 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5902 attributes,
5903 pbkdf2->password,
5904 pbkdf2->password_length,
5905 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305906 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305907 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305908 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305909 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5910 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305911 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305912 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305913 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305914 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305915 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305916 }
5917 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5918 &mac_output_length);
5919 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305920 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305921 }
5922
5923 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305924 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305925 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305926 }
5927
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305928 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305929
5930 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305931 /* We are passing prf_output_length as mac_size because the driver
5932 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305933 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305934 status = psa_driver_wrapper_mac_compute(attributes,
5935 pbkdf2->password,
5936 pbkdf2->password_length,
5937 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305938 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305939 &mac_output_length);
5940 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305941 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305942 }
5943
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305944 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305945 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305946
5947cleanup:
5948 /* Zeroise buffers to clear sensitive data from memory. */
5949 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5950 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305951}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305952
5953static psa_status_t psa_key_derivation_pbkdf2_read(
5954 psa_pbkdf2_key_derivation_t *pbkdf2,
5955 psa_algorithm_t kdf_alg,
5956 uint8_t *output,
5957 size_t output_length)
5958{
5959 psa_status_t status;
5960 psa_algorithm_t prf_alg;
5961 uint8_t prf_output_length;
5962 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5963 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5964 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5965
5966 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5967 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5968 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5969 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305970 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5971 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305972 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305973 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305974 } else {
5975 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305976 }
5977
5978 switch (pbkdf2->state) {
5979 case PSA_PBKDF2_STATE_PASSWORD_SET:
5980 /* Initially we need a new block so bytes_used is equal to block size*/
5981 pbkdf2->bytes_used = prf_output_length;
5982 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5983 break;
5984 case PSA_PBKDF2_STATE_OUTPUT:
5985 break;
5986 default:
5987 return PSA_ERROR_BAD_STATE;
5988 }
5989
5990 while (output_length != 0) {
5991 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5992 if (n > output_length) {
5993 n = (uint8_t) output_length;
5994 }
5995 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5996 output += n;
5997 output_length -= n;
5998 pbkdf2->bytes_used += n;
5999
6000 if (output_length == 0) {
6001 break;
6002 }
6003
6004 /* We need a new block */
6005 pbkdf2->bytes_used = 0;
6006 pbkdf2->block_number++;
6007
6008 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
6009 prf_output_length,
6010 &attributes);
6011 if (status != PSA_SUCCESS) {
6012 return status;
6013 }
6014 }
6015
6016 return PSA_SUCCESS;
6017}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306018#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306019
Janos Follath6c6c8fc2019-06-17 12:38:20 +01006020psa_status_t psa_key_derivation_output_bytes(
6021 psa_key_derivation_operation_t *operation,
Ryan Everettf943e222024-01-19 14:46:39 +00006022 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006024{
6025 psa_status_t status;
Ryan Everettf943e222024-01-19 14:46:39 +00006026 LOCAL_OUTPUT_DECLARE(output_external, output);
6027
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02006029
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006031 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006033 }
6034
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006036 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006037 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02006038 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
6039 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006040 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02006041 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006043 }
Ryan Everettf943e222024-01-19 14:46:39 +00006044
6045 LOCAL_OUTPUT_ALLOC(output_external, output_length, output);
Ryan Everettda9227d2024-01-25 11:37:22 +00006046 if (output_length > operation->capacity) {
6047 operation->capacity = 0;
6048 /* Go through the error path to wipe all confidential data now
6049 * that the operation object is useless. */
6050 status = PSA_ERROR_INSUFFICIENT_DATA;
6051 goto exit;
6052 }
6053
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006054 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006055
Przemek Stekiel69c46792022-06-10 12:59:51 +02006056#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6058 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
6059 output, output_length);
6060 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006061#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006062#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6063 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6065 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6066 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
6067 kdf_alg, output,
6068 output_length);
6069 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006070#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
6071 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006072#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006074 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
6076 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006077#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306078#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306079 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306080 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
6081 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05306082 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306083#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006084
Gilles Peskineeab56e42018-07-12 17:12:33 +02006085 {
Steven Cooreman74afe472021-02-10 17:19:22 +01006086 (void) kdf_alg;
Ryan Everettf943e222024-01-19 14:46:39 +00006087 status = PSA_ERROR_BAD_STATE;
6088 LOCAL_OUTPUT_FREE(output_external, output);
6089
6090 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006091 }
6092
6093exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006095 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006096 * This allows us to differentiate between exhausted operations and
6097 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
6098 * operations. */
6099 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006101 operation->alg = alg;
Ryan Everettee5920a2024-02-09 15:09:28 +00006102 if (output != NULL) {
6103 memset(output, '!', output_length);
6104 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006105 }
Ryan Everettda9227d2024-01-25 11:37:22 +00006106
6107 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006109}
6110
David Brown7807bf72021-02-09 16:28:23 -07006111#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006112static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02006113{
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 if (data_size >= 8) {
6115 mbedtls_des_key_set_parity(data);
6116 }
6117 if (data_size >= 16) {
6118 mbedtls_des_key_set_parity(data + 8);
6119 }
6120 if (data_size >= 24) {
6121 mbedtls_des_key_set_parity(data + 16);
6122 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006123}
David Brown7807bf72021-02-09 16:28:23 -07006124#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006125
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006126/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006127 * ECC keys on a Weierstrass elliptic curve require the generation
6128 * of a private key which is an integer
6129 * in the range [1, N - 1], where N is the boundary of the private key domain:
6130 * N is the prime p for Diffie-Hellman, or the order of the
6131 * curve’s base point for ECC.
6132 *
6133 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6134 * This function generates the private key using the following process:
6135 *
6136 * 1. Draw a byte string of length ceiling(m/8) bytes.
6137 * 2. If m is not a multiple of 8, set the most significant
6138 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6139 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6140 * 4. If k > N - 2, discard the result and return to step 1.
6141 * 5. Output k + 1 as the private key.
6142 *
6143 * This method allows compliance to NIST standards, specifically the methods titled
6144 * Key-Pair Generation by Testing Candidates in the following publications:
6145 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6146 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6147 * Diffie-Hellman keys.
6148 *
6149 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6150 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6151 *
6152 * Note: Function allocates memory for *data buffer, so given *data should be
6153 * always NULL.
6154 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006155#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6156#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006157static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006158 psa_key_slot_t *slot,
6159 size_t bits,
6160 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006161 uint8_t **data
6162 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006163{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006164 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006165 mbedtls_mpi k;
6166 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006168 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006169 size_t m;
6170 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006171
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 mbedtls_mpi_init(&k);
6173 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006174
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006175 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006177 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01006178 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006181 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006182 goto cleanup;
6183 }
6184
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006185 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006187
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006189
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006190 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006191 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006192 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006193
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006194 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006195
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006196 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006198
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006199 /* Note: This function is always called with *data == NULL and it
6200 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 *data = mbedtls_calloc(1, m_bytes);
6202 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006203 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006204 goto cleanup;
6205 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006206
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006208 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006210 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006212
6213 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006215 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006216 * (8 * ceiling(m/8) - m) bits of the first byte in
6217 * the string to zero.
6218 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006220 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006221 }
6222
6223 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 * big-endian byte string.
6225 */
6226 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006227
6228 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 * Result of comparison is returned. When it indicates error
6230 * then this function is called again.
6231 */
6232 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006233 }
6234
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006235 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6237 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006238cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 if (ret != 0) {
6240 status = mbedtls_to_psa_error(ret);
6241 }
6242 if (status != PSA_SUCCESS) {
6243 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006244 *data = NULL;
6245 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 mbedtls_mpi_free(&k);
6247 mbedtls_mpi_free(&diff_N_2);
6248 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006249}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006250
6251/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6252 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6253 *
6254 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6255 * draw a 32-byte string and process it as specified in
6256 * Elliptic Curves for Security [RFC7748] §5.
6257 *
6258 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6259 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6260 *
6261 * Note: Function allocates memory for *data buffer, so given *data should be
6262 * always NULL.
6263 */
6264
6265static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6266 size_t bits,
6267 psa_key_derivation_operation_t *operation,
6268 uint8_t **data
6269 )
6270{
6271 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006272 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006273
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006275 case 255:
6276 output_length = 32;
6277 break;
6278 case 448:
6279 output_length = 56;
6280 break;
6281 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006283 break;
6284 }
6285
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006287
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 if (*data == NULL) {
6289 return PSA_ERROR_INSUFFICIENT_MEMORY;
6290 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006291
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006293
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006295 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006297
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006299 case 255:
6300 (*data)[0] &= 248;
6301 (*data)[31] &= 127;
6302 (*data)[31] |= 64;
6303 break;
6304 case 448:
6305 (*data)[0] &= 252;
6306 (*data)[55] |= 128;
6307 break;
6308 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006310 break;
6311 }
6312
6313 return status;
6314}
Valerio Setti86587ab2023-06-27 13:09:30 +02006315#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6316static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6317 psa_key_slot_t *slot, size_t bits,
6318 psa_key_derivation_operation_t *operation, uint8_t **data)
6319{
6320 (void) slot;
6321 (void) bits;
6322 (void) operation;
6323 (void) data;
6324 return PSA_ERROR_NOT_SUPPORTED;
6325}
6326
6327static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6328 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6329{
6330 (void) bits;
6331 (void) operation;
6332 (void) data;
6333 return PSA_ERROR_NOT_SUPPORTED;
6334}
6335#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6336#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006337
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006338static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006339 psa_key_slot_t *slot,
6340 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006341 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006342{
6343 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306345 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006346 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006347 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006348
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6350 return PSA_ERROR_INVALID_ARGUMENT;
6351 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006352
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006353#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006354 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006355 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6356 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6357 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006358 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6360 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006361 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 }
6363 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006364 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006365 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6366 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006367 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006369 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006370 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006371#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006372 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 if (key_type_is_raw_bytes(slot->attr.type)) {
6374 if (bits % 8 != 0) {
6375 return PSA_ERROR_INVALID_ARGUMENT;
6376 }
6377 data = mbedtls_calloc(1, bytes);
6378 if (data == NULL) {
6379 return PSA_ERROR_INSUFFICIENT_MEMORY;
6380 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006381
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 status = psa_key_derivation_output_bytes(operation, data, bytes);
6383 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006384 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006385 }
David Brown12ca5032021-02-11 11:02:00 -07006386#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6388 psa_des_set_key_parity(data, bytes);
6389 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006390#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 } else {
6392 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006393 }
Ronald Crondd04d422020-11-28 15:14:42 +01006394
Ronald Cronbf33c932020-11-28 18:06:53 +01006395 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006396 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006398 };
6399
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6401 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6402 &storage_size);
6403 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306404 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 }
Archanad8a83dc2021-06-14 10:04:16 +05306406 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 status = psa_allocate_buffer_to_slot(slot, storage_size);
6408 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306409 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 }
Archanad8a83dc2021-06-14 10:04:16 +05306411
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 status = psa_driver_wrapper_import_key(&attributes,
6413 data, bytes,
6414 slot->key.data,
6415 slot->key.bytes,
6416 &slot->key.bytes, &bits);
6417 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006418 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006420
6421exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 mbedtls_free(data);
6423 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006424}
6425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6427 psa_key_derivation_operation_t *operation,
6428 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006429{
6430 psa_status_t status;
6431 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006432 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006433
Ronald Cron81709fc2020-11-14 12:10:32 +01006434 *key = MBEDTLS_SVC_KEY_ID_INIT;
6435
Gilles Peskine0f84d622019-09-12 19:03:13 +02006436 /* Reject any attempt to create a zero-length key so that we don't
6437 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 if (psa_get_key_bits(attributes) == 0) {
6439 return PSA_ERROR_INVALID_ARGUMENT;
6440 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006441
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 if (operation->alg == PSA_ALG_NONE) {
6443 return PSA_ERROR_BAD_STATE;
6444 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006445
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 if (!operation->can_output_key) {
6447 return PSA_ERROR_NOT_PERMITTED;
6448 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006449
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6451 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006452#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006453 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006454 /* Deriving a key in a secure element is not implemented yet. */
6455 status = PSA_ERROR_NOT_SUPPORTED;
6456 }
6457#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 if (status == PSA_SUCCESS) {
6459 status = psa_generate_derived_key_internal(slot,
6460 attributes->core.bits,
6461 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006462 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 if (status == PSA_SUCCESS) {
6464 status = psa_finish_key_creation(slot, driver, key);
6465 }
6466 if (status != PSA_SUCCESS) {
6467 psa_fail_key_creation(slot, driver);
6468 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006469
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006471}
6472
Gilles Peskineeab56e42018-07-12 17:12:33 +02006473
6474
6475/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006476/* Key derivation */
6477/****************************************************************/
6478
Steven Cooreman932ffb72021-02-15 12:14:32 +01006479#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006480static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006481{
6482#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6484 return 1;
6485 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006486#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006487#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6489 return 1;
6490 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006491#endif
6492#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6494 return 1;
6495 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006496#endif
6497#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6499 return 1;
6500 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006501#endif
6502#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6504 return 1;
6505 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006506#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006507#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6509 return 1;
6510 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006511#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306512#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6513 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6514 return 1;
6515 }
6516#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306517#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6518 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6519 return 1;
6520 }
6521#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006523}
6524
Gilles Peskine449bd832023-01-11 14:50:10 +01006525static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006526{
6527 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 psa_status_t status = psa_hash_setup(&operation, alg);
6529 psa_hash_abort(&operation);
6530 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006531}
6532
Gilles Peskine969c5d62019-01-16 15:53:06 +01006533static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006534 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006536{
Janos Follath5fe19732019-06-20 15:09:30 +01006537 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6538 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006540
Gilles Peskine969c5d62019-01-16 15:53:06 +01006541 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 if (!is_kdf_alg_supported(kdf_alg)) {
6543 return PSA_ERROR_NOT_SUPPORTED;
6544 }
John Durkop07cc04a2020-11-16 22:08:34 -08006545
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006546 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306547 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6549 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306550 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6551 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6552 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306553 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306554 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 if (hash_size == 0) {
6556 return PSA_ERROR_NOT_SUPPORTED;
6557 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006558
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006559 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6560 * we might fail later, which is somewhat unfriendly and potentially
6561 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 psa_status_t status = psa_hash_try_support(hash_alg);
6563 if (status != PSA_SUCCESS) {
6564 return status;
6565 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006566 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006567
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6569 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6570 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6571 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006572 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006573#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006574 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6576 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006577 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006579#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6580 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006581 operation->capacity = 255 * hash_size;
6582 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006583}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006584
Gilles Peskine449bd832023-01-11 14:50:10 +01006585static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006586{
6587#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006588 if (alg == PSA_ALG_ECDH) {
6589 return PSA_SUCCESS;
6590 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006591#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006592#if defined(PSA_WANT_ALG_FFDH)
6593 if (alg == PSA_ALG_FFDH) {
6594 return PSA_SUCCESS;
6595 }
6596#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006597 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006599}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006600
6601static int psa_key_derivation_allows_free_form_secret_input(
6602 psa_algorithm_t kdf_alg)
6603{
6604#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6605 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6606 return 0;
6607 }
6608#endif
6609 (void) kdf_alg;
6610 return 1;
6611}
John Durkop07cc04a2020-11-16 22:08:34 -08006612#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006613
Gilles Peskine449bd832023-01-11 14:50:10 +01006614psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6615 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006616{
6617 psa_status_t status;
6618
Gilles Peskine449bd832023-01-11 14:50:10 +01006619 if (operation->alg != 0) {
6620 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006621 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006622
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6624 return PSA_ERROR_INVALID_ARGUMENT;
6625 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6626#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6627 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6628 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6629 status = psa_key_agreement_try_support(ka_alg);
6630 if (status != PSA_SUCCESS) {
6631 return status;
6632 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006633 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6634 return PSA_ERROR_INVALID_ARGUMENT;
6635 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6637#else
6638 return PSA_ERROR_NOT_SUPPORTED;
6639#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6640 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6641#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6642 status = psa_key_derivation_setup_kdf(operation, alg);
6643#else
6644 return PSA_ERROR_NOT_SUPPORTED;
6645#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6646 } else {
6647 return PSA_ERROR_INVALID_ARGUMENT;
6648 }
6649
6650 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006651 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 }
6653 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006654}
6655
Przemek Stekiel69c46792022-06-10 12:59:51 +02006656#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006657static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6658 psa_algorithm_t kdf_alg,
6659 psa_key_derivation_step_t step,
6660 const uint8_t *data,
6661 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006662{
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006664 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006665 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006666 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006667#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006668 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6669 return PSA_ERROR_INVALID_ARGUMENT;
6670 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006671#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006672 if (hkdf->state != HKDF_STATE_INIT) {
6673 return PSA_ERROR_BAD_STATE;
6674 } else {
6675 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6676 hash_alg,
6677 data, data_length);
6678 if (status != PSA_SUCCESS) {
6679 return status;
6680 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006681 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006682 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006683 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006684 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006685#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006686 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006687 /* We shouldn't be in different state as HKDF_EXPAND only allows
6688 * two inputs: SECRET (this case) and INFO which does not modify
6689 * the state. It could happen only if the hkdf
6690 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006691 if (hkdf->state != HKDF_STATE_INIT) {
6692 return PSA_ERROR_BAD_STATE;
6693 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006694
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006695 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006696 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6697 return PSA_ERROR_INVALID_ARGUMENT;
6698 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 memcpy(hkdf->prk, data, data_length);
6701 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006702#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006703 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006704 /* HKDF: If no salt was provided, use an empty salt.
6705 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006706 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006707#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6709 return PSA_ERROR_BAD_STATE;
6710 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006711#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006712 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6713 hash_alg,
6714 NULL, 0);
6715 if (status != PSA_SUCCESS) {
6716 return status;
6717 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006718 hkdf->state = HKDF_STATE_STARTED;
6719 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006720 if (hkdf->state != HKDF_STATE_STARTED) {
6721 return PSA_ERROR_BAD_STATE;
6722 }
6723 status = psa_mac_update(&hkdf->hmac,
6724 data, data_length);
6725 if (status != PSA_SUCCESS) {
6726 return status;
6727 }
6728 status = psa_mac_sign_finish(&hkdf->hmac,
6729 hkdf->prk,
6730 sizeof(hkdf->prk),
6731 &data_length);
6732 if (status != PSA_SUCCESS) {
6733 return status;
6734 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006735 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006736
Gilles Peskine2b522db2019-04-12 15:11:49 +02006737 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006738 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006739#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006740 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006741 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006742 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006743 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006745#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006746 {
6747 /* Block 0 is empty, and the next block will be
6748 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006750 }
6751
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006753 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006754#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006755 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6756 return PSA_ERROR_INVALID_ARGUMENT;
6757 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006758#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006759#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6761 hkdf->state == HKDF_STATE_INIT) {
6762 return PSA_ERROR_BAD_STATE;
6763 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006764#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 if (hkdf->state == HKDF_STATE_OUTPUT) {
6766 return PSA_ERROR_BAD_STATE;
6767 }
6768 if (hkdf->info_set) {
6769 return PSA_ERROR_BAD_STATE;
6770 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006771 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 if (data_length != 0) {
6773 hkdf->info = mbedtls_calloc(1, data_length);
6774 if (hkdf->info == NULL) {
6775 return PSA_ERROR_INSUFFICIENT_MEMORY;
6776 }
6777 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006778 }
6779 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006781 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006783 }
6784}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006785#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006786
John Durkop07cc04a2020-11-16 22:08:34 -08006787#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6788 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006789static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6790 const uint8_t *data,
6791 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006792{
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6794 return PSA_ERROR_BAD_STATE;
6795 }
Janos Follathf08e2652019-06-13 09:05:41 +01006796
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if (data_length != 0) {
6798 prf->seed = mbedtls_calloc(1, data_length);
6799 if (prf->seed == NULL) {
6800 return PSA_ERROR_INSUFFICIENT_MEMORY;
6801 }
Janos Follathf08e2652019-06-13 09:05:41 +01006802
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006804 prf->seed_length = data_length;
6805 }
Janos Follathf08e2652019-06-13 09:05:41 +01006806
Gilles Peskine43f958b2020-12-13 14:55:14 +01006807 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006808
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006810}
6811
Gilles Peskine449bd832023-01-11 14:50:10 +01006812static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6813 const uint8_t *data,
6814 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006815{
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6817 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6818 return PSA_ERROR_BAD_STATE;
6819 }
Janos Follath81550542019-06-13 14:26:34 +01006820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 if (data_length != 0) {
6822 prf->secret = mbedtls_calloc(1, data_length);
6823 if (prf->secret == NULL) {
6824 return PSA_ERROR_INSUFFICIENT_MEMORY;
6825 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006826
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006828 prf->secret_length = data_length;
6829 }
Janos Follath81550542019-06-13 14:26:34 +01006830
Gilles Peskine43f958b2020-12-13 14:55:14 +01006831 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006832
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006834}
6835
Gilles Peskine449bd832023-01-11 14:50:10 +01006836static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6837 const uint8_t *data,
6838 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006839{
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6841 return PSA_ERROR_BAD_STATE;
6842 }
Janos Follath63028dd2019-06-13 09:15:47 +01006843
Gilles Peskine449bd832023-01-11 14:50:10 +01006844 if (data_length != 0) {
6845 prf->label = mbedtls_calloc(1, data_length);
6846 if (prf->label == NULL) {
6847 return PSA_ERROR_INSUFFICIENT_MEMORY;
6848 }
Janos Follath63028dd2019-06-13 09:15:47 +01006849
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006851 prf->label_length = data_length;
6852 }
Janos Follath63028dd2019-06-13 09:15:47 +01006853
Gilles Peskine43f958b2020-12-13 14:55:14 +01006854 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006855
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006857}
6858
Gilles Peskine449bd832023-01-11 14:50:10 +01006859static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6860 psa_key_derivation_step_t step,
6861 const uint8_t *data,
6862 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006863{
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006865 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006866 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006867 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006869 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006871 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006873 }
6874}
John Durkop07cc04a2020-11-16 22:08:34 -08006875#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6876 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6877
6878#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6879static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6880 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006881 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006883{
6884 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6886 4 + data_length + prf->other_secret_length :
6887 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006888
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6890 return PSA_ERROR_INVALID_ARGUMENT;
6891 }
John Durkop07cc04a2020-11-16 22:08:34 -08006892
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 uint8_t *pms = mbedtls_calloc(1, pms_len);
6894 if (pms == NULL) {
6895 return PSA_ERROR_INSUFFICIENT_MEMORY;
6896 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006897 uint8_t *cur = pms;
6898
6899 /* pure-PSK:
6900 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006901 *
6902 * The premaster secret is formed as follows: if the PSK is N octets
6903 * long, concatenate a uint16 with the value N, N zero octets, a second
6904 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006905 *
6906 * mixed-PSK:
6907 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6908 * follows: concatenate a uint16 with the length of the other secret,
6909 * the other secret itself, uint16 with the length of PSK, and the
6910 * PSK itself.
6911 * For details please check:
6912 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6913 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6914 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006915 */
6916
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6918 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6919 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6920 if (prf->other_secret_length != 0) {
6921 memcpy(cur, prf->other_secret, prf->other_secret_length);
6922 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006923 cur += prf->other_secret_length;
6924 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 } else {
6926 *cur++ = MBEDTLS_BYTE_1(data_length);
6927 *cur++ = MBEDTLS_BYTE_0(data_length);
6928 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006929 cur += data_length;
6930 }
6931
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 *cur++ = MBEDTLS_BYTE_1(data_length);
6933 *cur++ = MBEDTLS_BYTE_0(data_length);
6934 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006935 cur += data_length;
6936
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006937 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006938
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006939 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006940 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006941}
Janos Follath6660f0e2019-06-17 08:44:03 +01006942
Przemek Stekiele47201b2022-04-19 13:53:28 +02006943static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6944 psa_tls12_prf_key_derivation_t *prf,
6945 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006947{
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6949 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006950 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006951
6952 if (data_length != 0) {
6953 prf->other_secret = mbedtls_calloc(1, data_length);
6954 if (prf->other_secret == NULL) {
6955 return PSA_ERROR_INSUFFICIENT_MEMORY;
6956 }
6957
6958 memcpy(prf->other_secret, data, data_length);
6959 prf->other_secret_length = data_length;
6960 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006961 prf->other_secret_length = 0;
6962 }
6963
6964 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6965
Gilles Peskine449bd832023-01-11 14:50:10 +01006966 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006967}
6968
Janos Follath6660f0e2019-06-17 08:44:03 +01006969static psa_status_t psa_tls12_prf_psk_to_ms_input(
6970 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006971 psa_key_derivation_step_t step,
6972 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006974{
Gilles Peskine449bd832023-01-11 14:50:10 +01006975 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006976 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 return psa_tls12_prf_psk_to_ms_set_key(prf,
6978 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006979 break;
6980 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006981 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6982 data,
6983 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006984 break;
6985 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006987 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006988
Przemek Stekiele47201b2022-04-19 13:53:28 +02006989 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006990}
John Durkop07cc04a2020-11-16 22:08:34 -08006991#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006992
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006993#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6994static psa_status_t psa_tls12_ecjpake_to_pms_input(
6995 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006996 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006997 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006999{
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
7001 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
7002 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04007003 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007004
7005 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 if (data[0] != 0x04) {
7007 return PSA_ERROR_INVALID_ARGUMENT;
7008 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007009
7010 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007012
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007014}
7015#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307016
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307017#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307018static psa_status_t psa_pbkdf2_set_input_cost(
7019 psa_pbkdf2_key_derivation_t *pbkdf2,
7020 psa_key_derivation_step_t step,
7021 uint64_t data)
7022{
7023 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
7024 return PSA_ERROR_INVALID_ARGUMENT;
7025 }
7026
7027 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
7028 return PSA_ERROR_BAD_STATE;
7029 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307030
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307031 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307032 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307033 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307034
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307035 if (data == 0) {
7036 return PSA_ERROR_INVALID_ARGUMENT;
7037 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307038
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307039 pbkdf2->input_cost = data;
7040 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
7041
7042 return PSA_SUCCESS;
7043}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307044
7045static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
7046 const uint8_t *data,
7047 size_t data_length)
7048{
Gilles Peskineead17662023-08-20 22:02:51 +02007049 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
7050 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
7051 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
7052 /* Appending to existing salt. No state change. */
7053 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307054 return PSA_ERROR_BAD_STATE;
7055 }
7056
Gilles Peskineca57d782023-07-20 19:08:06 +02007057 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02007058 /* Appending an empty string, nothing to do. */
7059 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307060 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05307061
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307062 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
7063 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307064 return PSA_ERROR_INSUFFICIENT_MEMORY;
7065 }
7066
Gilles Peskineead17662023-08-20 22:02:51 +02007067 if (pbkdf2->salt_length != 0) {
7068 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
7069 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307070 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307071 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307072 mbedtls_free(pbkdf2->salt);
7073 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307074 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307075 return PSA_SUCCESS;
7076}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307077
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307078#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307079static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307080 const uint8_t *input,
7081 size_t input_len,
7082 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05307083 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307084{
7085 psa_status_t status = PSA_SUCCESS;
7086 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007087 return psa_hash_compute(hash_alg, input, input_len, output,
7088 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
7089 } else if (input_len > 0) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307090 memcpy(output, input, input_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307091 }
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007092 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307093 return status;
7094}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307095#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307096
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307097#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307098static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
7099 size_t input_len,
7100 uint8_t *output,
7101 size_t *output_len)
7102{
7103 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307104 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307105 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05307106 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307107 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
7108 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
7109 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307110 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05307111 * mac_size as the driver function sets mac_output_length = mac_size
7112 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307113 status = psa_driver_wrapper_mac_compute(&attributes,
7114 zeros, sizeof(zeros),
7115 PSA_ALG_CMAC, input, input_len,
7116 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307117 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7118 128U,
7119 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307120 output_len);
7121 } else {
7122 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307123 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307124 }
7125 return status;
7126}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307127#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307128
7129static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307130 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307131 const uint8_t *data,
7132 size_t data_length)
7133{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307134 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307135 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7136 return PSA_ERROR_BAD_STATE;
7137 }
7138
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307139#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307140 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7141 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7142 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7143 pbkdf2->password,
7144 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307145 } else
7146#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7147#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7148 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307149 status = psa_pbkdf2_cmac_set_password(data, data_length,
7150 pbkdf2->password,
7151 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307152 } else
7153#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7154 {
7155 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307156 }
7157
7158 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7159
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307160 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307161}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307162
7163static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307164 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307165 psa_key_derivation_step_t step,
7166 const uint8_t *data,
7167 size_t data_length)
7168{
7169 switch (step) {
7170 case PSA_KEY_DERIVATION_INPUT_SALT:
7171 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7172 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307173 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307174 default:
7175 return PSA_ERROR_INVALID_ARGUMENT;
7176 }
7177}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307178#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307179
Gilles Peskineb8965192019-09-24 16:21:10 +02007180/** Check whether the given key type is acceptable for the given
7181 * input step of a key derivation.
7182 *
7183 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7184 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7185 * Both secret and non-secret inputs can alternatively have the type
7186 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7187 * that the input was passed as a buffer rather than via a key object.
7188 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007189static int psa_key_derivation_check_input_type(
7190 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007192{
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007194 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 if (key_type == PSA_KEY_TYPE_DERIVE) {
7196 return PSA_SUCCESS;
7197 }
7198 if (key_type == PSA_KEY_TYPE_NONE) {
7199 return PSA_SUCCESS;
7200 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007201 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007202 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 if (key_type == PSA_KEY_TYPE_DERIVE) {
7204 return PSA_SUCCESS;
7205 }
7206 if (key_type == PSA_KEY_TYPE_NONE) {
7207 return PSA_SUCCESS;
7208 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007209 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007210 case PSA_KEY_DERIVATION_INPUT_LABEL:
7211 case PSA_KEY_DERIVATION_INPUT_SALT:
7212 case PSA_KEY_DERIVATION_INPUT_INFO:
7213 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7215 return PSA_SUCCESS;
7216 }
7217 if (key_type == PSA_KEY_TYPE_NONE) {
7218 return PSA_SUCCESS;
7219 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007220 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307221 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7222 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7223 return PSA_SUCCESS;
7224 }
7225 if (key_type == PSA_KEY_TYPE_DERIVE) {
7226 return PSA_SUCCESS;
7227 }
7228 if (key_type == PSA_KEY_TYPE_NONE) {
7229 return PSA_SUCCESS;
7230 }
7231 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007232 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007233 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007234}
7235
Janos Follathb80a94e2019-06-12 15:54:46 +01007236static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007237 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007238 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007239 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007240 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007242{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007243 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007245
Gilles Peskine449bd832023-01-11 14:50:10 +01007246 status = psa_key_derivation_check_input_type(step, key_type);
7247 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007248 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007250
Przemek Stekiel69c46792022-06-10 12:59:51 +02007251#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7253 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7254 step, data, data_length);
7255 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007256#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007257#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7259 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7260 step, data, data_length);
7261 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007262#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7263#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7265 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7266 step, data, data_length);
7267 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007268#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007269#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007271 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007272 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7273 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007274#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307275#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307276 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307277 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7278 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307279 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307280#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007281 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007282 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007283 (void) data;
7284 (void) data_length;
7285 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007287 }
7288
Gilles Peskine224b0d62019-09-23 18:13:17 +02007289exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 if (status != PSA_SUCCESS) {
7291 psa_key_derivation_abort(operation);
7292 }
7293 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007294}
7295
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307296static psa_status_t psa_key_derivation_input_integer_internal(
7297 psa_key_derivation_operation_t *operation,
7298 psa_key_derivation_step_t step,
7299 uint64_t value)
7300{
7301 psa_status_t status;
7302 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7303
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307304#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307305 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307306 status = psa_pbkdf2_set_input_cost(
7307 &operation->ctx.pbkdf2, step, value);
7308 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307309#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307310 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307311 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307312 (void) value;
7313 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307314 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307315 }
7316
7317 if (status != PSA_SUCCESS) {
7318 psa_key_derivation_abort(operation);
7319 }
7320 return status;
7321}
7322
Janos Follath51f4a0f2019-06-14 11:35:55 +01007323psa_status_t psa_key_derivation_input_bytes(
7324 psa_key_derivation_operation_t *operation,
7325 psa_key_derivation_step_t step,
Ryan Everettd1e398c2024-01-19 14:46:00 +00007326 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007328{
Ryan Everettd1e398c2024-01-19 14:46:00 +00007329 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7330 LOCAL_INPUT_DECLARE(data_external, data);
7331
7332 LOCAL_INPUT_ALLOC(data_external, data_length, data);
7333
7334 status = psa_key_derivation_input_internal(operation, step,
7335 PSA_KEY_TYPE_NONE,
7336 data, data_length);
Ryan Everettb41c3c92024-01-25 11:56:35 +00007337#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everettd1e398c2024-01-19 14:46:00 +00007338exit:
Ryan Everettb41c3c92024-01-25 11:56:35 +00007339#endif
Ryan Everettd1e398c2024-01-19 14:46:00 +00007340 LOCAL_INPUT_FREE(data_external, data);
7341 return status;
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007342}
7343
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307344psa_status_t psa_key_derivation_input_integer(
7345 psa_key_derivation_operation_t *operation,
7346 psa_key_derivation_step_t step,
7347 uint64_t value)
7348{
7349 return psa_key_derivation_input_integer_internal(operation, step, value);
7350}
7351
Janos Follath51f4a0f2019-06-14 11:35:55 +01007352psa_status_t psa_key_derivation_input_key(
7353 psa_key_derivation_operation_t *operation,
7354 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007355 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007356{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007358 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007359 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007360
Ronald Cron5c522922020-11-14 16:35:34 +01007361 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7363 if (status != PSA_SUCCESS) {
7364 psa_key_derivation_abort(operation);
7365 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007366 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007367
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307368 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7369 * permission to output to a key object. */
7370 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7371 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007372 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007374
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 status = psa_key_derivation_input_internal(operation,
7376 step, slot->attr.type,
7377 slot->key.data,
7378 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007379
Ryan Everett1b70a072024-01-04 10:32:49 +00007380 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007381
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007383}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007384
7385
7386
7387/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007388/* Key agreement */
7389/****************************************************************/
7390
Gilles Peskine449bd832023-01-11 14:50:10 +01007391psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7392 const uint8_t *key_buffer,
7393 size_t key_buffer_size,
7394 psa_algorithm_t alg,
7395 const uint8_t *peer_key,
7396 size_t peer_key_length,
7397 uint8_t *shared_secret,
7398 size_t shared_secret_size,
7399 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007400{
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007402#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007403 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7405 key_buffer_size, alg,
7406 peer_key, peer_key_length,
7407 shared_secret,
7408 shared_secret_size,
7409 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007410#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007411
7412#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7413 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007414 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007415 peer_key,
7416 peer_key_length,
7417 key_buffer,
7418 key_buffer_size,
7419 shared_secret,
7420 shared_secret_size,
7421 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007422#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7423
Gilles Peskine01d718c2018-09-18 12:01:02 +02007424 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007425 (void) attributes;
7426 (void) key_buffer;
7427 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007428 (void) peer_key;
7429 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007430 (void) shared_secret;
7431 (void) shared_secret_size;
7432 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007434 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007435}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007436
Aditya Deshpande17845b82022-10-13 17:21:01 +01007437/** Internal function for raw key agreement
7438 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007439 * to the driver's implementation if a driver is present.
7440 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007441 * (psa_key_agreement_raw_builtin).
7442 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007443static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7444 psa_key_slot_t *private_key,
7445 const uint8_t *peer_key,
7446 size_t peer_key_length,
7447 uint8_t *shared_secret,
7448 size_t shared_secret_size,
7449 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007450{
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7452 return PSA_ERROR_NOT_SUPPORTED;
7453 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007454
7455 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007457 };
7458
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 return psa_driver_wrapper_key_agreement(&attributes,
7460 private_key->key.data,
7461 private_key->key.bytes, alg,
7462 peer_key, peer_key_length,
7463 shared_secret,
7464 shared_secret_size,
7465 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007466}
7467
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007468/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007469 * to potentially free embedded data structures and wipe confidential data.
7470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007471static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7472 psa_key_derivation_step_t step,
7473 psa_key_slot_t *private_key,
7474 const uint8_t *peer_key,
7475 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007476{
7477 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007478 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007479 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007481
7482 /* Step 1: run the secret agreement algorithm to generate the shared
7483 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 status = psa_key_agreement_raw_internal(ka_alg,
7485 private_key,
7486 peer_key, peer_key_length,
7487 shared_secret,
7488 sizeof(shared_secret),
7489 &shared_secret_length);
7490 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007491 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007493
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007494 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007495 * the shared secret. A shared secret is permitted wherever a key
7496 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 status = psa_key_derivation_input_internal(operation, step,
7498 PSA_KEY_TYPE_DERIVE,
7499 shared_secret,
7500 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007501exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7503 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007504}
7505
Gilles Peskine449bd832023-01-11 14:50:10 +01007506psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7507 psa_key_derivation_step_t step,
7508 mbedtls_svc_key_id_t private_key,
7509 const uint8_t *peer_key,
7510 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007511{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007512 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007513 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007514 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007515
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7517 return PSA_ERROR_INVALID_ARGUMENT;
7518 }
Ronald Cron5c522922020-11-14 16:35:34 +01007519 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7521 if (status != PSA_SUCCESS) {
7522 return status;
7523 }
7524 status = psa_key_agreement_internal(operation, step,
7525 slot,
7526 peer_key, peer_key_length);
7527 if (status != PSA_SUCCESS) {
7528 psa_key_derivation_abort(operation);
7529 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007530 /* If a private key has been added as SECRET, we allow the derived
7531 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007533 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007535 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007536
Ryan Everett1b70a072024-01-04 10:32:49 +00007537 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007538
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007540}
7541
Gilles Peskine449bd832023-01-11 14:50:10 +01007542psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7543 mbedtls_svc_key_id_t private_key,
7544 const uint8_t *peer_key,
7545 size_t peer_key_length,
7546 uint8_t *output,
7547 size_t output_size,
7548 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007549{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007550 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007551 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007552 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007553 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007554
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007556 status = PSA_ERROR_INVALID_ARGUMENT;
7557 goto exit;
7558 }
Ronald Cron5c522922020-11-14 16:35:34 +01007559 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7561 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007562 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007564
Gilles Peskine3e561302022-04-14 00:17:15 +02007565 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7566 * for the output size. The PSA specification only guarantees that this
7567 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7568 * but it might be nice to allow smaller buffers if the output fits.
7569 * At the time of writing this comment, with only ECDH implemented,
7570 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7571 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7572 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007573 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7575 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007576 status = PSA_ERROR_BUFFER_TOO_SMALL;
7577 goto exit;
7578 }
7579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 status = psa_key_agreement_raw_internal(alg, slot,
7581 peer_key, peer_key_length,
7582 output, output_size,
7583 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007584
7585exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007587 /* If an error happens and is not handled properly, the output
7588 * may be used as a key to protect sensitive data. Arrange for such
7589 * a key to be random, which is likely to result in decryption or
7590 * verification errors. This is better than filling the buffer with
7591 * some constant data such as zeros, which would result in the data
7592 * being protected with a reproducible, easily knowable key.
7593 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007595 *output_length = output_size;
7596 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007597
Ryan Everett1b70a072024-01-04 10:32:49 +00007598 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007599
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007601}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007602
7603
Gilles Peskine30524eb2020-11-13 17:02:26 +01007604
Gilles Peskine86a440b2018-11-12 18:39:40 +01007605/****************************************************************/
7606/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007607/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007608
Gilles Peskine672a7712023-04-28 21:00:28 +02007609#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7610#include "entropy_poll.h"
7611#endif
7612
Gilles Peskine30524eb2020-11-13 17:02:26 +01007613/** Initialize the PSA random generator.
7614 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007615static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007616{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007617#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007619#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7620
Gilles Peskine30524eb2020-11-13 17:02:26 +01007621 /* Set default configuration if
7622 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007624 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 }
7626 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007627 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007631#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7632 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7633 /* The PSA entropy injection feature depends on using NV seed as an entropy
7634 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 mbedtls_entropy_add_source(&rng->entropy,
7636 mbedtls_nv_seed_poll, NULL,
7637 MBEDTLS_ENTROPY_BLOCK_SIZE,
7638 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007639#endif
7640
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007642#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007643}
7644
7645/** Deinitialize the PSA random generator.
7646 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007647static void mbedtls_psa_random_free(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)
Valerio Setti83e0de82023-11-24 12:13:05 +01007650 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007651#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007652 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7653 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007654#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007655}
7656
7657/** Seed the PSA random generator.
7658 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007659static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007660{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007661#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7662 /* Do nothing: the external RNG seeds itself. */
7663 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007665#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007666 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007667 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7668 drbg_seed, sizeof(drbg_seed) - 1);
7669 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007670#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007671}
7672
Gilles Peskine449bd832023-01-11 14:50:10 +01007673psa_status_t psa_generate_random(uint8_t *output,
7674 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007675{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007676 GUARD_MODULE_INITIALIZED;
7677
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007678#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7679
7680 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007681 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7682 output, output_size,
7683 &output_length);
7684 if (status != PSA_SUCCESS) {
7685 return status;
7686 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007687 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007688 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007689 if (output_length != output_size) {
7690 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7691 }
7692 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007693
7694#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7695
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007697 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007698 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7699 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7700 output_size);
7701 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7702 output, request_size);
7703 if (ret != 0) {
7704 return mbedtls_to_psa_error(ret);
7705 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007706 output_size -= request_size;
7707 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007708 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007710#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007711}
7712
Gilles Peskine8814fc42020-12-14 15:33:44 +01007713/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007714 *
7715 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7716 * `psa_generate_random(...)`. The state parameter is ignored since the
7717 * PSA API doesn't support passing an explicit state.
7718 *
7719 * In the non-external case, psa_generate_random() calls an
7720 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7721 * and semantics as mbedtls_psa_get_random(). As an optimization,
7722 * instead of doing this back-and-forth between the PSA API and the
7723 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7724 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007725 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007726#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7727int mbedtls_psa_get_random(void *p_rng,
7728 unsigned char *output,
7729 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007730{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007731 /* This function takes a pointer to the RNG state because that's what
7732 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7733 * its own state internally and doesn't let the caller access that state.
7734 * So we just ignore the state parameter, and in practice we'll pass
7735 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007736 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 psa_status_t status = psa_generate_random(output, output_size);
7738 if (status == PSA_SUCCESS) {
7739 return 0;
7740 } else {
7741 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7742 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007743}
7744#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7745
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007746#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007747psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7748 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007749{
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 if (global_data.initialized) {
7751 return PSA_ERROR_NOT_PERMITTED;
7752 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007753
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7755 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7756 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7757 return PSA_ERROR_INVALID_ARGUMENT;
7758 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007759
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007761}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007762#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007763
Ronald Cron3772afe2021-02-08 16:10:05 +01007764/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007765 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007766 * \param type The key type
7767 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007768 *
7769 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007770 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007771 * \retval #PSA_ERROR_INVALID_ARGUMENT
7772 * The size in bits of the key is not valid.
7773 * \retval #PSA_ERROR_NOT_SUPPORTED
7774 * The type and/or the size in bits of the key or the combination of
7775 * the two is not supported.
7776 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007777static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007779{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007780 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007781
Gilles Peskine449bd832023-01-11 14:50:10 +01007782 if (key_type_is_raw_bytes(type)) {
7783 status = psa_validate_unstructured_key_bit_size(type, bits);
7784 if (status != PSA_SUCCESS) {
7785 return status;
7786 }
7787 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007788#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7790 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7791 return PSA_ERROR_NOT_SUPPORTED;
7792 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007793 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007794 return PSA_ERROR_NOT_SUPPORTED;
7795 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007796
Ronald Cron01b2aba2020-10-05 09:42:02 +02007797 /* Accept only byte-aligned keys, for the same reasons as
7798 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 if (bits % 8 != 0) {
7800 return PSA_ERROR_NOT_SUPPORTED;
7801 }
7802 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007803#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007804
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007805#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007807 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 return PSA_SUCCESS;
7809 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007810#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007811
Valerio Settia55f0422023-07-10 15:34:41 +02007812#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007813 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007814 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007815 return PSA_ERROR_NOT_SUPPORTED;
7816 }
7817 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007818#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007819 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007820 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007821 }
7822
Gilles Peskine449bd832023-01-11 14:50:10 +01007823 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007824}
7825
Ronald Cron55ed0592020-10-05 10:30:40 +02007826psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007827 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007829{
7830 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007831 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007832
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 if ((attributes->domain_parameters == NULL) &&
7834 (attributes->domain_parameters_size != 0)) {
7835 return PSA_ERROR_INVALID_ARGUMENT;
7836 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007837
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 if (key_type_is_raw_bytes(type)) {
7839 status = psa_generate_random(key_buffer, key_buffer_size);
7840 if (status != PSA_SUCCESS) {
7841 return status;
7842 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007843
David Brown12ca5032021-02-11 11:02:00 -07007844#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007845 if (type == PSA_KEY_TYPE_DES) {
7846 psa_des_set_key_parity(key_buffer, key_buffer_size);
7847 }
David Brown8107e312021-02-12 08:08:46 -07007848#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007850
Valerio Setti76df8c12023-07-11 14:11:28 +02007851#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007852 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7853 return mbedtls_psa_rsa_generate_key(attributes,
7854 key_buffer,
7855 key_buffer_size,
7856 key_buffer_length);
7857 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007858#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007859
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007860#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007861 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7862 return mbedtls_psa_ecp_generate_key(attributes,
7863 key_buffer,
7864 key_buffer_size,
7865 key_buffer_length);
7866 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007867#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007868
Valerio Settia55f0422023-07-10 15:34:41 +02007869#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007870 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7871 return mbedtls_psa_ffdh_generate_key(attributes,
7872 key_buffer,
7873 key_buffer_size,
7874 key_buffer_length);
7875 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007876#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007877 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007878 (void) key_buffer_length;
7879 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007880 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007881
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007883}
Darryl Green0c6575a2018-11-07 16:05:30 +00007884
Gilles Peskine449bd832023-01-11 14:50:10 +01007885psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7886 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007887{
7888 psa_status_t status;
7889 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007890 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007891 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007892
Ronald Cron81709fc2020-11-14 12:10:32 +01007893 *key = MBEDTLS_SVC_KEY_ID_INIT;
7894
Gilles Peskine0f84d622019-09-12 19:03:13 +02007895 /* Reject any attempt to create a zero-length key so that we don't
7896 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 if (psa_get_key_bits(attributes) == 0) {
7898 return PSA_ERROR_INVALID_ARGUMENT;
7899 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007900
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007901 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007902 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7903 return PSA_ERROR_INVALID_ARGUMENT;
7904 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007905
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7907 &slot, &driver);
7908 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007909 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 }
Gilles Peskine11792082019-08-06 18:36:36 +02007911
Ronald Cron977c2472020-10-13 08:32:21 +02007912 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307913 * storage ( thus not in the case of generating a key in a secure element
7914 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7915 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 if (slot->key.data == NULL) {
7917 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7918 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007919 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 attributes->core.type, attributes->core.bits);
7921 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007922 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007924
7925 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 attributes->core.type,
7927 attributes->core.bits);
7928 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007929 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 attributes, &key_buffer_size);
7931 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007932 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 }
Ronald Cron977c2472020-10-13 08:32:21 +02007934 }
Ronald Cron977c2472020-10-13 08:32:21 +02007935
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7937 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007938 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007939 }
Ronald Cron977c2472020-10-13 08:32:21 +02007940 }
7941
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 status = psa_driver_wrapper_generate_key(attributes,
7943 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007944
Gilles Peskine449bd832023-01-11 14:50:10 +01007945 if (status != PSA_SUCCESS) {
7946 psa_remove_key_data_from_memory(slot);
7947 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007948
Gilles Peskine11792082019-08-06 18:36:36 +02007949exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007950 if (status == PSA_SUCCESS) {
7951 status = psa_finish_key_creation(slot, driver, key);
7952 }
7953 if (status != PSA_SUCCESS) {
7954 psa_fail_key_creation(slot, driver);
7955 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007956
Gilles Peskine449bd832023-01-11 14:50:10 +01007957 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007958}
7959
Gilles Peskinee59236f2018-01-27 23:32:46 +01007960/****************************************************************/
7961/* Module setup */
7962/****************************************************************/
7963
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007964#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007965psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 void (* entropy_init)(mbedtls_entropy_context *ctx),
7967 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007968{
Gilles Peskine449bd832023-01-11 14:50:10 +01007969 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7970 return PSA_ERROR_BAD_STATE;
7971 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007972 global_data.rng.entropy_init = entropy_init;
7973 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007975}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007976#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007977
Gilles Peskine449bd832023-01-11 14:50:10 +01007978void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007979{
Gilles Peskine449bd832023-01-11 14:50:10 +01007980 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007981 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7982 mbedtls_psa_random_free(&global_data.rng);
7983 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007984 /* Wipe all remaining data, including configuration.
7985 * In particular, this sets all state indicator to the value
7986 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007988
7989 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007991}
7992
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007993#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7994/** Recover a transaction that was interrupted by a power failure.
7995 *
7996 * This function is called during initialization, before psa_crypto_init()
7997 * returns. If this function returns a failure status, the initialization
7998 * fails.
7999 */
8000static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008002{
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008004 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
8005 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 /* TODO - fall through to the failure case until this
8007 * is implemented.
8008 * https://github.com/ARMmbed/mbed-crypto/issues/218
8009 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008010 default:
8011 /* We found an unsupported transaction in the storage.
8012 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008014 }
8015}
8016#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
8017
Gilles Peskine449bd832023-01-11 14:50:10 +01008018psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008019{
Gilles Peskine66fb1262018-12-10 16:29:04 +01008020 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008021
Gilles Peskinec6b69072018-11-20 21:42:52 +01008022 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 if (global_data.initialized != 0) {
8024 return PSA_SUCCESS;
8025 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008026
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01008027 /* Init drivers */
8028 status = psa_driver_wrapper_init();
8029 if (status != PSA_SUCCESS) {
8030 goto exit;
8031 }
8032 global_data.drivers_initialized = 1;
8033
Valerio Setti402cfba2023-11-13 10:24:32 +01008034 status = psa_initialize_key_slots();
8035 if (status != PSA_SUCCESS) {
8036 goto exit;
8037 }
8038
Gilles Peskine30524eb2020-11-13 17:02:26 +01008039 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01008041 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 status = mbedtls_psa_random_seed(&global_data.rng);
8043 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01008044 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01008046 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008047
Gilles Peskine4b734222019-07-24 15:56:31 +02008048#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008049 status = psa_crypto_load_transaction();
8050 if (status == PSA_SUCCESS) {
8051 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
8052 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008053 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 }
8055 status = psa_crypto_stop_transaction();
8056 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02008057 /* There's no transaction to complete. It's all good. */
8058 status = PSA_SUCCESS;
8059 }
Gilles Peskine4b734222019-07-24 15:56:31 +02008060#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02008061
Gilles Peskinec6b69072018-11-20 21:42:52 +01008062 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01008063 global_data.initialized = 1;
8064
8065exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 if (status != PSA_SUCCESS) {
8067 mbedtls_psa_crypto_free();
8068 }
8069 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008070}
8071
Yanray Wangffc3c482023-07-11 12:01:04 +08008072#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008073psa_status_t psa_crypto_driver_pake_get_password_len(
8074 const psa_crypto_driver_pake_inputs_t *inputs,
8075 size_t *password_len)
8076{
8077 if (inputs->password_len == 0) {
8078 return PSA_ERROR_BAD_STATE;
8079 }
8080
8081 *password_len = inputs->password_len;
8082
8083 return PSA_SUCCESS;
8084}
8085
8086psa_status_t psa_crypto_driver_pake_get_password(
8087 const psa_crypto_driver_pake_inputs_t *inputs,
8088 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
8089{
8090 if (inputs->password_len == 0) {
8091 return PSA_ERROR_BAD_STATE;
8092 }
8093
8094 if (buffer_size < inputs->password_len) {
8095 return PSA_ERROR_BUFFER_TOO_SMALL;
8096 }
8097
8098 memcpy(buffer, inputs->password, inputs->password_len);
8099 *buffer_length = inputs->password_len;
8100
8101 return PSA_SUCCESS;
8102}
8103
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008104psa_status_t psa_crypto_driver_pake_get_user_len(
8105 const psa_crypto_driver_pake_inputs_t *inputs,
8106 size_t *user_len)
8107{
8108 if (inputs->user_len == 0) {
8109 return PSA_ERROR_BAD_STATE;
8110 }
8111
8112 *user_len = inputs->user_len;
8113
8114 return PSA_SUCCESS;
8115}
8116
8117psa_status_t psa_crypto_driver_pake_get_user(
8118 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008119 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008120{
8121 if (inputs->user_len == 0) {
8122 return PSA_ERROR_BAD_STATE;
8123 }
8124
Przemek Stekielc0e62502023-03-14 11:49:36 +01008125 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008126 return PSA_ERROR_BUFFER_TOO_SMALL;
8127 }
8128
Przemek Stekielc0e62502023-03-14 11:49:36 +01008129 memcpy(user_id, inputs->user, inputs->user_len);
8130 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008131
8132 return PSA_SUCCESS;
8133}
8134
8135psa_status_t psa_crypto_driver_pake_get_peer_len(
8136 const psa_crypto_driver_pake_inputs_t *inputs,
8137 size_t *peer_len)
8138{
8139 if (inputs->peer_len == 0) {
8140 return PSA_ERROR_BAD_STATE;
8141 }
8142
8143 *peer_len = inputs->peer_len;
8144
8145 return PSA_SUCCESS;
8146}
8147
8148psa_status_t psa_crypto_driver_pake_get_peer(
8149 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008150 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008151{
8152 if (inputs->peer_len == 0) {
8153 return PSA_ERROR_BAD_STATE;
8154 }
8155
Przemek Stekielc0e62502023-03-14 11:49:36 +01008156 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008157 return PSA_ERROR_BUFFER_TOO_SMALL;
8158 }
8159
Przemek Stekielc0e62502023-03-14 11:49:36 +01008160 memcpy(peer_id, inputs->peer, inputs->peer_len);
8161 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008162
8163 return PSA_SUCCESS;
8164}
8165
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008166psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8167 const psa_crypto_driver_pake_inputs_t *inputs,
8168 psa_pake_cipher_suite_t *cipher_suite)
8169{
8170 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8171 return PSA_ERROR_BAD_STATE;
8172 }
8173
8174 *cipher_suite = inputs->cipher_suite;
8175
8176 return PSA_SUCCESS;
8177}
8178
Neil Armstronga7d08c32022-06-01 18:21:20 +02008179psa_status_t psa_pake_setup(
8180 psa_pake_operation_t *operation,
8181 const psa_pake_cipher_suite_t *cipher_suite)
8182{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008183 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008184
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008185 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008186 status = PSA_ERROR_BAD_STATE;
8187 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008188 }
8189
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008190 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008191 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008192 status = PSA_ERROR_INVALID_ARGUMENT;
8193 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008194 }
8195
Przemek Stekiel51eac532022-12-07 11:04:51 +01008196 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8197
Przemek Stekiele12ed362022-12-21 12:54:46 +01008198 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008199 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8200 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008201 operation->data.inputs.cipher_suite = *cipher_suite;
8202
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008203#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008204 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008205 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008206 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008207
David Horstmann16f01512023-06-14 17:21:07 +01008208 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008209 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008210 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008211#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008212 {
8213 status = PSA_ERROR_NOT_SUPPORTED;
8214 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008215 }
8216
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008217 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8218
Przemek Stekiel51eac532022-12-07 11:04:51 +01008219 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008220exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008221 psa_pake_abort(operation);
8222 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008223}
8224
8225psa_status_t psa_pake_set_password_key(
8226 psa_pake_operation_t *operation,
8227 mbedtls_svc_key_id_t password)
8228{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008229 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008230 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8231 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008232 psa_key_attributes_t attributes;
8233 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008234
Przemek Stekiel51eac532022-12-07 11:04:51 +01008235 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008236 status = PSA_ERROR_BAD_STATE;
8237 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008238 }
8239
Przemek Stekiel6c764412022-11-22 14:05:12 +01008240 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8241 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008242 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008243 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008244 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008245 }
8246
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008247 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008248 .core = slot->attr
8249 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008250
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008251 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008252
Przemek Stekiel51eac532022-12-07 11:04:51 +01008253 if (type != PSA_KEY_TYPE_PASSWORD &&
8254 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8255 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008256 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008257 }
8258
Przemek Stekiel51eac532022-12-07 11:04:51 +01008259 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8260 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008261 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008262 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008263 }
8264
8265 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8266 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008267 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008268exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008269 if (status != PSA_SUCCESS) {
8270 psa_pake_abort(operation);
8271 }
Ryan Everett1b70a072024-01-04 10:32:49 +00008272 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008273 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008274}
8275
8276psa_status_t psa_pake_set_user(
8277 psa_pake_operation_t *operation,
8278 const uint8_t *user_id,
8279 size_t user_id_len)
8280{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008281 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008282
8283 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008284 status = PSA_ERROR_BAD_STATE;
8285 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008286 }
8287
Przemek Stekiel51eac532022-12-07 11:04:51 +01008288 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008289 status = PSA_ERROR_INVALID_ARGUMENT;
8290 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008291 }
8292
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008293 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008294 status = PSA_ERROR_BAD_STATE;
8295 goto exit;
8296 }
8297
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008298 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8299 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008300 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8301 goto exit;
8302 }
8303
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008304 memcpy(operation->data.inputs.user, user_id, user_id_len);
8305 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008306
8307 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008308exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008309 psa_pake_abort(operation);
8310 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008311}
8312
8313psa_status_t psa_pake_set_peer(
8314 psa_pake_operation_t *operation,
8315 const uint8_t *peer_id,
8316 size_t peer_id_len)
8317{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008318 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008319
8320 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008321 status = PSA_ERROR_BAD_STATE;
8322 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008323 }
8324
Przemek Stekiel51eac532022-12-07 11:04:51 +01008325 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008326 status = PSA_ERROR_INVALID_ARGUMENT;
8327 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008328 }
8329
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008330 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008331 status = PSA_ERROR_BAD_STATE;
8332 goto exit;
8333 }
8334
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008335 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8336 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008337 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8338 goto exit;
8339 }
8340
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008341 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8342 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008343
8344 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008345exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008346 psa_pake_abort(operation);
8347 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008348}
8349
8350psa_status_t psa_pake_set_role(
8351 psa_pake_operation_t *operation,
8352 psa_pake_role_t role)
8353{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008354 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008355
Przemek Stekiel51eac532022-12-07 11:04:51 +01008356 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008357 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008358 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008359 }
8360
Przemek Stekiel09104b82023-03-06 14:11:51 +01008361 switch (operation->alg) {
8362#if defined(PSA_WANT_ALG_JPAKE)
8363 case PSA_ALG_JPAKE:
8364 if (role == PSA_PAKE_ROLE_NONE) {
8365 return PSA_SUCCESS;
8366 }
8367 status = PSA_ERROR_INVALID_ARGUMENT;
8368 break;
8369#endif
8370 default:
8371 (void) role;
8372 status = PSA_ERROR_NOT_SUPPORTED;
8373 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008374 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008375exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008376 psa_pake_abort(operation);
8377 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008378}
8379
David Horstmanne7f21e62023-05-12 18:17:21 +01008380/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008381#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008382static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008383 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008384{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008385 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008386 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008387 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008388
David Horstmann024e5c52023-06-14 15:48:21 +01008389 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008390 is_x1 = (stage->outputs < 1);
8391 } else {
8392 is_x1 = (stage->inputs < 1);
8393 }
8394
David Horstmann74a3d8c2023-06-14 18:28:19 +01008395 key_share_step = is_x1 ?
8396 PSA_JPAKE_X1_STEP_KEY_SHARE :
8397 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008398 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008399 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8400 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8401 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8402 } else {
8403 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008404 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008405 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008406}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008407#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008408
Przemek Stekiel2797d372022-12-22 11:19:22 +01008409static psa_status_t psa_pake_complete_inputs(
8410 psa_pake_operation_t *operation)
8411{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008412 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008413 /* Create copy of the inputs on stack as inputs share memory
8414 with the driver context which will be setup by the driver. */
8415 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008416
Przemek Stekielfde11282023-03-13 16:06:09 +01008417 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008418 return PSA_ERROR_BAD_STATE;
8419 }
8420
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008421 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008422 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8423 return PSA_ERROR_BAD_STATE;
8424 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008425 }
8426
Przemek Stekiel18620a32023-01-17 16:34:52 +01008427 /* Clear driver context */
8428 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8429
8430 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008431
8432 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008433 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008434
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008435 /* User and peer are translated to role. */
8436 mbedtls_free(inputs.user);
8437 mbedtls_free(inputs.peer);
8438
Przemek Stekiel2797d372022-12-22 11:19:22 +01008439 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008440#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008441 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008442 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008443 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008444#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008445 {
8446 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008447 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008448 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008449 return status;
8450}
8451
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008452#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008453static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008454 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008455 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008456 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008457{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008458 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8459 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8460 step != PSA_PAKE_STEP_ZK_PROOF) {
8461 return PSA_ERROR_INVALID_ARGUMENT;
8462 }
8463
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008464 psa_jpake_computation_stage_t *computation_stage =
8465 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008466
David Horstmann5da95602023-06-08 15:37:12 +01008467 if (computation_stage->round != PSA_JPAKE_FIRST &&
8468 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008469 return PSA_ERROR_BAD_STATE;
8470 }
8471
David Horstmanne7f21e62023-05-12 18:17:21 +01008472 /* Check that the step we are given is the one we were expecting */
8473 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008474 return PSA_ERROR_BAD_STATE;
8475 }
8476
David Horstmanne7f21e62023-05-12 18:17:21 +01008477 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8478 computation_stage->inputs == 0 &&
8479 computation_stage->outputs == 0) {
8480 /* Start of the round, so function decides whether we are inputting
8481 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008482 computation_stage->io_mode = io_mode;
8483 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008484 /* Middle of the round so the mode we are in must match the function
8485 * called by the user */
8486 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008487 }
8488
8489 return PSA_SUCCESS;
8490}
8491
David Horstmanne7f21e62023-05-12 18:17:21 +01008492static psa_status_t psa_jpake_epilogue(
8493 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008494 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008495{
David Horstmanne7f21e62023-05-12 18:17:21 +01008496 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008497 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008498
David Horstmanne7f21e62023-05-12 18:17:21 +01008499 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8500 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008501 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008502 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008503 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008504 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008505 }
8506 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008507 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008508 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008509 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008510 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008511 }
8512 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008513 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8514 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008515 /* End of a round, move to the next round */
8516 stage->inputs = 0;
8517 stage->outputs = 0;
8518 stage->round++;
8519 }
8520 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008521 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008522 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008523 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008524 return PSA_SUCCESS;
8525}
David Horstmanne7f21e62023-05-12 18:17:21 +01008526
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008527#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008528
Neil Armstronga7d08c32022-06-01 18:21:20 +02008529psa_status_t psa_pake_output(
8530 psa_pake_operation_t *operation,
8531 psa_pake_step_t step,
8532 uint8_t *output,
8533 size_t output_size,
8534 size_t *output_length)
8535{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008536 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008537 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008538 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008539
8540 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008541 status = psa_pake_complete_inputs(operation);
8542 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008543 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008544 }
8545 }
8546
8547 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008548 status = PSA_ERROR_BAD_STATE;
8549 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008550 }
8551
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008552 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008553 status = PSA_ERROR_INVALID_ARGUMENT;
8554 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008555 }
8556
Przemek Stekiele12ed362022-12-21 12:54:46 +01008557 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008558#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008559 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008560 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008561 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008562 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008563 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008564 driver_step = convert_jpake_computation_stage_to_driver_step(
8565 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008566 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008567#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008568 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008569 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008570 status = PSA_ERROR_NOT_SUPPORTED;
8571 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008572 }
8573
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008574 status = psa_driver_wrapper_pake_output(operation, driver_step,
8575 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008576
8577 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008578 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008579 }
8580
8581 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008582#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008583 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008584 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008585 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008586 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008587 }
8588 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008589#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008590 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008591 status = PSA_ERROR_NOT_SUPPORTED;
8592 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008593 }
8594
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008595 return PSA_SUCCESS;
8596exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008597 psa_pake_abort(operation);
8598 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008599}
8600
8601psa_status_t psa_pake_input(
8602 psa_pake_operation_t *operation,
8603 psa_pake_step_t step,
8604 const uint8_t *input,
8605 size_t input_length)
8606{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008607 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008608 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008609 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8610 operation->primitive,
8611 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008612
8613 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008614 status = psa_pake_complete_inputs(operation);
8615 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008616 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008617 }
8618 }
8619
8620 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008621 status = PSA_ERROR_BAD_STATE;
8622 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008623 }
8624
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008625 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008626 status = PSA_ERROR_INVALID_ARGUMENT;
8627 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008628 }
8629
Przemek Stekiele12ed362022-12-21 12:54:46 +01008630 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008631#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008632 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008633 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008634 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008635 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008636 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008637 driver_step = convert_jpake_computation_stage_to_driver_step(
8638 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008639 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008640#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008641 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008642 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008643 status = PSA_ERROR_NOT_SUPPORTED;
8644 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008645 }
8646
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008647 status = psa_driver_wrapper_pake_input(operation, driver_step,
8648 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008649
8650 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008651 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008652 }
8653
8654 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008655#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008656 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008657 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008658 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008659 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008660 }
8661 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008662#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008663 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008664 status = PSA_ERROR_NOT_SUPPORTED;
8665 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008666 }
8667
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008668 return PSA_SUCCESS;
8669exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008670 psa_pake_abort(operation);
8671 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008672}
8673
8674psa_status_t psa_pake_get_implicit_key(
8675 psa_pake_operation_t *operation,
8676 psa_key_derivation_operation_t *output)
8677{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008678 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008679 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008680 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008681 size_t shared_key_len = 0;
8682
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008683 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008684 status = PSA_ERROR_BAD_STATE;
8685 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008686 }
8687
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008688#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008689 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008690 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008691 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008692 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008693 status = PSA_ERROR_BAD_STATE;
8694 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008695 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008696 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008697#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008698 {
8699 status = PSA_ERROR_NOT_SUPPORTED;
8700 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008701 }
8702
Przemek Stekiel0c781802022-11-29 14:53:13 +01008703 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8704 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008705 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008706 &shared_key_len);
8707
8708 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008709 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008710 }
8711
8712 status = psa_key_derivation_input_bytes(output,
8713 PSA_KEY_DERIVATION_INPUT_SECRET,
8714 shared_key,
8715 shared_key_len);
8716
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008717 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008718exit:
8719 abort_status = psa_pake_abort(operation);
8720 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008721}
8722
8723psa_status_t psa_pake_abort(
8724 psa_pake_operation_t *operation)
8725{
Przemek Stekield69dca92023-01-31 19:59:20 +01008726 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008727
Przemek Stekield69dca92023-01-31 19:59:20 +01008728 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008729 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008730 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008731
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008732 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8733 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008734 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008735 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008736 }
8737 if (operation->data.inputs.user != NULL) {
8738 mbedtls_free(operation->data.inputs.user);
8739 }
8740 if (operation->data.inputs.peer != NULL) {
8741 mbedtls_free(operation->data.inputs.peer);
8742 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008743 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008744 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008745
Przemek Stekield69dca92023-01-31 19:59:20 +01008746 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008747}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008748#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008749
David Horstmann00d7a042023-12-07 18:39:17 +00008750/* Memory copying test hooks. These are called before input copy, after input
8751 * copy, before output copy and after output copy, respectively.
8752 * They are used by memory-poisoning tests to temporarily unpoison buffers
8753 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008754#if defined(MBEDTLS_TEST_HOOKS)
8755void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8756void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8757void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8758void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8759#endif
David Horstmannfde97392023-10-30 20:29:43 +00008760
David Horstmann1b7279a2023-11-15 15:18:30 +00008761/** Copy from an input buffer to a local copy.
8762 *
8763 * \param[in] input Pointer to input buffer.
8764 * \param[in] input_len Length of the input buffer.
8765 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8766 * \param[out] input_copy_len Length of the local copy buffer.
8767 * \return #PSA_SUCCESS, if the buffer was successfully
8768 * copied.
8769 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8770 * copy is too small to hold contents of the
8771 * input buffer.
8772 */
8773MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008774psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8775 uint8_t *input_copy, size_t input_copy_len)
8776{
8777 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008778 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008779 }
8780
David Horstmann372b8bb2023-11-24 16:21:04 +00008781#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008782 if (psa_input_pre_copy_hook != NULL) {
8783 psa_input_pre_copy_hook(input, input_len);
8784 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008785#endif
8786
David Horstmann777e7412023-11-15 17:33:47 +00008787 if (input_len > 0) {
8788 memcpy(input_copy, input, input_len);
8789 }
David Horstmannfde97392023-10-30 20:29:43 +00008790
David Horstmann372b8bb2023-11-24 16:21:04 +00008791#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008792 if (psa_input_post_copy_hook != NULL) {
8793 psa_input_post_copy_hook(input, input_len);
8794 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008795#endif
8796
David Horstmannfde97392023-10-30 20:29:43 +00008797 return PSA_SUCCESS;
8798}
8799
David Horstmann1b7279a2023-11-15 15:18:30 +00008800/** Copy from a local output buffer into a user-supplied one.
8801 *
8802 * \param[in] output_copy Pointer to a local buffer containing the output.
8803 * \param[in] output_copy_len Length of the local buffer.
8804 * \param[out] output Pointer to user-supplied output buffer.
8805 * \param[out] output_len Length of the user-supplied output buffer.
8806 * \return #PSA_SUCCESS, if the buffer was successfully
8807 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008808 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008809 * user-supplied output buffer is too small to
8810 * hold the contents of the local buffer.
8811 */
8812MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008813psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8814 uint8_t *output, size_t output_len)
8815{
8816 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008817 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008818 }
David Horstmann777e7412023-11-15 17:33:47 +00008819
David Horstmann372b8bb2023-11-24 16:21:04 +00008820#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008821 if (psa_output_pre_copy_hook != NULL) {
8822 psa_output_pre_copy_hook(output, output_len);
8823 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008824#endif
8825
David Horstmann777e7412023-11-15 17:33:47 +00008826 if (output_copy_len > 0) {
8827 memcpy(output, output_copy, output_copy_len);
8828 }
8829
David Horstmann372b8bb2023-11-24 16:21:04 +00008830#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008831 if (psa_output_post_copy_hook != NULL) {
8832 psa_output_post_copy_hook(output, output_len);
8833 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008834#endif
8835
David Horstmann8978f5c2023-10-30 20:37:12 +00008836 return PSA_SUCCESS;
8837}
8838
David Horstmannf1734052023-11-20 17:15:32 +00008839psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8840 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008841{
8842 psa_status_t status;
8843
David Horstmann9db14482023-11-23 15:50:37 +00008844 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008845
David Horstmannc5cc1c32023-11-15 18:11:26 +00008846 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008847 return PSA_SUCCESS;
8848 }
8849
David Horstmannf1734052023-11-20 17:15:32 +00008850 local_input->buffer = mbedtls_calloc(input_len, 1);
8851 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008852 /* Since we dealt with the zero-length case above, we know that
8853 * a NULL return value means a failure of allocation. */
8854 return PSA_ERROR_INSUFFICIENT_MEMORY;
8855 }
David Horstmannf1734052023-11-20 17:15:32 +00008856 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008857
David Horstmannf1734052023-11-20 17:15:32 +00008858 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008859
8860 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008861 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008862 if (status != PSA_SUCCESS) {
8863 goto error;
8864 }
8865
8866 return PSA_SUCCESS;
8867
8868error:
David Horstmannf1734052023-11-20 17:15:32 +00008869 mbedtls_free(local_input->buffer);
8870 local_input->buffer = NULL;
8871 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008872 return status;
8873}
8874
David Horstmannf1734052023-11-20 17:15:32 +00008875void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008876{
David Horstmannf1734052023-11-20 17:15:32 +00008877 mbedtls_free(local_input->buffer);
8878 local_input->buffer = NULL;
8879 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008880}
8881
David Horstmann89875a42023-11-20 12:54:09 +00008882psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8883 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008884{
David Horstmann9db14482023-11-23 15:50:37 +00008885 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008886
David Horstmannc5cc1c32023-11-15 18:11:26 +00008887 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008888 return PSA_SUCCESS;
8889 }
David Horstmann89875a42023-11-20 12:54:09 +00008890 local_output->buffer = mbedtls_calloc(output_len, 1);
8891 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008892 /* Since we dealt with the zero-length case above, we know that
8893 * a NULL return value means a failure of allocation. */
8894 return PSA_ERROR_INSUFFICIENT_MEMORY;
8895 }
David Horstmann89875a42023-11-20 12:54:09 +00008896 local_output->length = output_len;
8897 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008898
8899 return PSA_SUCCESS;
8900}
8901
Gabor Mezei1882c512024-01-24 13:07:17 +01008902psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8903 psa_crypto_local_output_t *local_output)
8904{
8905 psa_status_t status;
8906 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8907
8908 if (output_len == 0) {
8909 return PSA_SUCCESS;
8910 }
8911 local_output->buffer = mbedtls_calloc(output_len, 1);
8912 if (local_output->buffer == NULL) {
8913 /* Since we dealt with the zero-length case above, we know that
8914 * a NULL return value means a failure of allocation. */
8915 return PSA_ERROR_INSUFFICIENT_MEMORY;
8916 }
8917 local_output->length = output_len;
8918 local_output->original = output;
8919
8920 status = psa_crypto_copy_input(output, output_len,
8921 local_output->buffer, local_output->length);
8922 if (status != PSA_SUCCESS) {
8923 goto error;
8924 }
8925
8926 return PSA_SUCCESS;
8927
8928error:
8929 mbedtls_free(local_output->buffer);
8930 local_output->buffer = NULL;
8931 local_output->length = 0;
8932 return status;
8933}
8934
David Horstmann89875a42023-11-20 12:54:09 +00008935psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008936{
David Horstmannc335a4e2023-11-15 15:57:32 +00008937 psa_status_t status;
8938
David Horstmann89875a42023-11-20 12:54:09 +00008939 if (local_output->buffer == NULL) {
8940 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008941 return PSA_SUCCESS;
8942 }
David Horstmann89875a42023-11-20 12:54:09 +00008943 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008944 /* We have an internal copy but nothing to copy back to. */
8945 return PSA_ERROR_CORRUPTION_DETECTED;
8946 }
8947
David Horstmann89875a42023-11-20 12:54:09 +00008948 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8949 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008950 if (status != PSA_SUCCESS) {
8951 return status;
8952 }
David Horstmann9467ea32023-11-08 17:44:18 +00008953
David Horstmann89875a42023-11-20 12:54:09 +00008954 mbedtls_free(local_output->buffer);
8955 local_output->buffer = NULL;
8956 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008957
8958 return PSA_SUCCESS;
8959}
8960
Gilles Peskinee59236f2018-01-27 23:32:46 +01008961#endif /* MBEDTLS_PSA_CRYPTO_C */