blob: 7473aef4dea297f160c488ffac59a36a1df39319 [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,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003382 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003383 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003384 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003385 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003386 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003387 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;
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003394 LOCAL_INPUT_DECLARE(input_external, input);
3395 LOCAL_INPUT_DECLARE(salt_external, salt);
3396 LOCAL_OUTPUT_DECLARE(output_external, output);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003397
Darryl Green5cc689a2018-07-24 15:34:10 +01003398 (void) input;
3399 (void) input_length;
3400 (void) salt;
3401 (void) output;
3402 (void) output_size;
3403
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003404 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003405
Gilles Peskine449bd832023-01-11 14:50:10 +01003406 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3407 return PSA_ERROR_INVALID_ARGUMENT;
3408 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003409
Valerio Setti5bb454a2024-01-15 10:43:16 +01003410 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003411 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3412 if (status != PSA_SUCCESS) {
3413 return status;
3414 }
3415 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3416 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003417 status = PSA_ERROR_INVALID_ARGUMENT;
3418 goto exit;
3419 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003420
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003421 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003423 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003424
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003425 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3426 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3427 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003428 status = psa_driver_wrapper_asymmetric_encrypt(
3429 &attributes, slot->key.data, slot->key.bytes,
3430 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003432exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003433 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003434
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003435 LOCAL_INPUT_FREE(input_external, input);
3436 LOCAL_INPUT_FREE(salt_external, salt);
3437 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003438
Gilles Peskine449bd832023-01-11 14:50:10 +01003439 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003440}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003441
Gilles Peskine449bd832023-01-11 14:50:10 +01003442psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3443 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003444 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003445 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003446 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003447 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003448 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003449 size_t output_size,
3450 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003451{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003452 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003453 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003454 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003455 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003456
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003457 LOCAL_INPUT_DECLARE(input_external, input);
3458 LOCAL_INPUT_DECLARE(salt_external, salt);
3459 LOCAL_OUTPUT_DECLARE(output_external, output);
3460
Darryl Green5cc689a2018-07-24 15:34:10 +01003461 (void) input;
3462 (void) input_length;
3463 (void) salt;
3464 (void) output;
3465 (void) output_size;
3466
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003467 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003468
Gilles Peskine449bd832023-01-11 14:50:10 +01003469 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3470 return PSA_ERROR_INVALID_ARGUMENT;
3471 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003472
Valerio Setti5bb454a2024-01-15 10:43:16 +01003473 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003474 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3475 if (status != PSA_SUCCESS) {
3476 return status;
3477 }
3478 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003479 status = PSA_ERROR_INVALID_ARGUMENT;
3480 goto exit;
3481 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003482
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003483 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003484 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003485 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003486
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003487 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3488 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3489 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003490 status = psa_driver_wrapper_asymmetric_decrypt(
3491 &attributes, slot->key.data, slot->key.bytes,
3492 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003493 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003494
3495exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003496 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003497
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003498 LOCAL_INPUT_FREE(input_external, input);
3499 LOCAL_INPUT_FREE(salt_external, salt);
3500 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003501
Gilles Peskine449bd832023-01-11 14:50:10 +01003502 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003503}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003504
Paul Elliott9fe12f62022-11-30 19:16:02 +00003505/****************************************************************/
3506/* Asymmetric interruptible cryptography */
3507/****************************************************************/
3508
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003509static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3510
Paul Elliott9fe12f62022-11-30 19:16:02 +00003511void psa_interruptible_set_max_ops(uint32_t max_ops)
3512{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003513 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003514}
3515
3516uint32_t psa_interruptible_get_max_ops(void)
3517{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003518 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003519}
3520
Paul Elliott9fe12f62022-11-30 19:16:02 +00003521uint32_t psa_sign_hash_get_num_ops(
3522 const psa_sign_hash_interruptible_operation_t *operation)
3523{
Paul Elliott296ede92022-12-15 17:00:30 +00003524 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003525}
3526
3527uint32_t psa_verify_hash_get_num_ops(
3528 const psa_verify_hash_interruptible_operation_t *operation)
3529{
Paul Elliott296ede92022-12-15 17:00:30 +00003530 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003531}
3532
Paul Elliott59ad9452022-12-18 15:09:02 +00003533static psa_status_t psa_sign_hash_abort_internal(
3534 psa_sign_hash_interruptible_operation_t *operation)
3535{
3536 if (operation->id == 0) {
3537 /* The object has (apparently) been initialized but it is not (yet)
3538 * in use. It's ok to call abort on such an object, and there's
3539 * nothing to do. */
3540 return PSA_SUCCESS;
3541 }
3542
3543 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3544
3545 status = psa_driver_wrapper_sign_hash_abort(operation);
3546
3547 operation->id = 0;
3548
Paul Elliotte6145dc2023-02-07 12:51:21 +00003549 /* Do not clear either the error_occurred or num_ops elements here as they
3550 * only want to be cleared by the application calling abort, not by abort
3551 * being called at completion of an operation. */
3552
Paul Elliott59ad9452022-12-18 15:09:02 +00003553 return status;
3554}
3555
Paul Elliott9fe12f62022-11-30 19:16:02 +00003556psa_status_t psa_sign_hash_start(
3557 psa_sign_hash_interruptible_operation_t *operation,
3558 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann4a523a62024-03-11 13:32:16 +00003559 const uint8_t *hash_external, size_t hash_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003560{
3561 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3562 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3563 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003564 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003565
David Horstmann4a523a62024-03-11 13:32:16 +00003566 LOCAL_INPUT_DECLARE(hash_external, hash);
3567
Paul Elliottc9774412023-02-06 15:14:07 +00003568 /* Check that start has not been previously called, or operation has not
3569 * previously errored. */
3570 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003571 return PSA_ERROR_BAD_STATE;
3572 }
3573
Paul Elliott9fe12f62022-11-30 19:16:02 +00003574 status = psa_sign_verify_check_alg(0, alg);
3575 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003576 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003577 return status;
3578 }
3579
3580 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3581 PSA_KEY_USAGE_SIGN_HASH,
3582 alg);
3583
3584 if (status != PSA_SUCCESS) {
3585 goto exit;
3586 }
3587
3588 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3589 status = PSA_ERROR_INVALID_ARGUMENT;
3590 goto exit;
3591 }
3592
David Horstmann4a523a62024-03-11 13:32:16 +00003593 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3594
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003595 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003596 .core = slot->attr
3597 };
3598
Paul Elliott296ede92022-12-15 17:00:30 +00003599 /* Ensure ops count gets reset, in case of operation re-use. */
3600 operation->num_ops = 0;
3601
Paul Elliott9fe12f62022-11-30 19:16:02 +00003602 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3603 slot->key.data,
3604 slot->key.bytes, alg,
3605 hash, hash_length);
3606exit:
3607
3608 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003609 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003610 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003611 }
3612
Ryan Everett1b70a072024-01-04 10:32:49 +00003613 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003614
Paul Elliottc9774412023-02-06 15:14:07 +00003615 if (unlock_status != PSA_SUCCESS) {
3616 operation->error_occurred = 1;
3617 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003618
David Horstmann4a523a62024-03-11 13:32:16 +00003619 LOCAL_INPUT_FREE(hash_external, hash);
3620
Paul Elliottc9774412023-02-06 15:14:07 +00003621 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003622}
3623
3624
3625psa_status_t psa_sign_hash_complete(
3626 psa_sign_hash_interruptible_operation_t *operation,
David Horstmann4a523a62024-03-11 13:32:16 +00003627 uint8_t *signature_external, size_t signature_size,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003628 size_t *signature_length)
3629{
3630 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3631
David Horstmann4a523a62024-03-11 13:32:16 +00003632 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3633
Paul Elliott9fe12f62022-11-30 19:16:02 +00003634 *signature_length = 0;
3635
Paul Elliottc9774412023-02-06 15:14:07 +00003636 /* Check that start has been called first, and that operation has not
3637 * previously errored. */
3638 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003639 status = PSA_ERROR_BAD_STATE;
3640 goto exit;
3641 }
3642
Paul Elliott096abc42023-02-03 18:33:23 +00003643 /* Immediately reject a zero-length signature buffer. This guarantees that
3644 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003645 if (signature_size == 0) {
3646 status = PSA_ERROR_BUFFER_TOO_SMALL;
3647 goto exit;
3648 }
3649
David Horstmann4a523a62024-03-11 13:32:16 +00003650 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3651
Paul Elliott9fe12f62022-11-30 19:16:02 +00003652 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3653 signature_size,
3654 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003655
Paul Elliott296ede92022-12-15 17:00:30 +00003656 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003657 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003658
Paul Elliottebe225c2023-02-10 14:32:53 +00003659exit:
3660
David Horstmannc5064c82024-03-11 17:02:03 +00003661 if (signature != NULL) {
3662 psa_wipe_tag_output_buffer(signature, status, signature_size,
3663 *signature_length);
3664 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003665
Paul Elliott53bb3122023-02-10 14:22:22 +00003666 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003667 if (status != PSA_SUCCESS) {
3668 operation->error_occurred = 1;
3669 }
3670
Paul Elliott59ad9452022-12-18 15:09:02 +00003671 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003672 }
3673
David Horstmann4a523a62024-03-11 13:32:16 +00003674 LOCAL_OUTPUT_FREE(signature_external, signature);
3675
Paul Elliott9fe12f62022-11-30 19:16:02 +00003676 return status;
3677}
3678
3679psa_status_t psa_sign_hash_abort(
3680 psa_sign_hash_interruptible_operation_t *operation)
3681{
Paul Elliott59ad9452022-12-18 15:09:02 +00003682 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3683
3684 status = psa_sign_hash_abort_internal(operation);
3685
3686 /* We clear the number of ops done here, so that it is not cleared when
3687 * the operation fails or succeeds, only on manual abort. */
3688 operation->num_ops = 0;
3689
Paul Elliottc9774412023-02-06 15:14:07 +00003690 /* Likewise, failure state. */
3691 operation->error_occurred = 0;
3692
Paul Elliott59ad9452022-12-18 15:09:02 +00003693 return status;
3694}
3695
3696static psa_status_t psa_verify_hash_abort_internal(
3697 psa_verify_hash_interruptible_operation_t *operation)
3698{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003699 if (operation->id == 0) {
3700 /* The object has (apparently) been initialized but it is not (yet)
3701 * in use. It's ok to call abort on such an object, and there's
3702 * nothing to do. */
3703 return PSA_SUCCESS;
3704 }
3705
Paul Elliott59ad9452022-12-18 15:09:02 +00003706 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3707
3708 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003709
3710 operation->id = 0;
3711
Paul Elliotte6145dc2023-02-07 12:51:21 +00003712 /* Do not clear either the error_occurred or num_ops elements here as they
3713 * only want to be cleared by the application calling abort, not by abort
3714 * being called at completion of an operation. */
3715
Paul Elliott59ad9452022-12-18 15:09:02 +00003716 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003717}
3718
3719psa_status_t psa_verify_hash_start(
3720 psa_verify_hash_interruptible_operation_t *operation,
3721 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann0fea6a52024-03-11 13:41:05 +00003722 const uint8_t *hash_external, size_t hash_length,
3723 const uint8_t *signature_external, size_t signature_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003724{
3725 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3726 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3727 psa_key_slot_t *slot;
3728
David Horstmann0fea6a52024-03-11 13:41:05 +00003729 LOCAL_INPUT_DECLARE(hash_external, hash);
3730 LOCAL_INPUT_DECLARE(signature_external, signature);
3731
Paul Elliottc9774412023-02-06 15:14:07 +00003732 /* Check that start has not been previously called, or operation has not
3733 * previously errored. */
3734 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003735 return PSA_ERROR_BAD_STATE;
3736 }
3737
3738 status = psa_sign_verify_check_alg(0, alg);
3739 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003740 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003741 return status;
3742 }
3743
3744 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3745 PSA_KEY_USAGE_VERIFY_HASH,
3746 alg);
3747
3748 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003749 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003750 return status;
3751 }
3752
David Horstmann0fea6a52024-03-11 13:41:05 +00003753 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3754 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3755
Paul Elliott9fe12f62022-11-30 19:16:02 +00003756 psa_key_attributes_t attributes = {
3757 .core = slot->attr
3758 };
3759
Paul Elliott296ede92022-12-15 17:00:30 +00003760 /* Ensure ops count gets reset, in case of operation re-use. */
3761 operation->num_ops = 0;
3762
Paul Elliott9fe12f62022-11-30 19:16:02 +00003763 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3764 slot->key.data,
3765 slot->key.bytes,
3766 alg, hash, hash_length,
3767 signature, signature_length);
David Horstmann0fea6a52024-03-11 13:41:05 +00003768#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
3769exit:
3770#endif
Paul Elliott9fe12f62022-11-30 19:16:02 +00003771
3772 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003773 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003774 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003775 }
3776
Ryan Everett1b70a072024-01-04 10:32:49 +00003777 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003778
Paul Elliottc9774412023-02-06 15:14:07 +00003779 if (unlock_status != PSA_SUCCESS) {
3780 operation->error_occurred = 1;
3781 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003782
David Horstmann0fea6a52024-03-11 13:41:05 +00003783 LOCAL_INPUT_FREE(hash_external, hash);
3784 LOCAL_INPUT_FREE(signature_external, signature);
3785
Paul Elliottc9774412023-02-06 15:14:07 +00003786 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003787}
3788
3789psa_status_t psa_verify_hash_complete(
3790 psa_verify_hash_interruptible_operation_t *operation)
3791{
3792 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3793
Paul Elliottc9774412023-02-06 15:14:07 +00003794 /* Check that start has been called first, and that operation has not
3795 * previously errored. */
3796 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003797 status = PSA_ERROR_BAD_STATE;
3798 goto exit;
3799 }
3800
3801 status = psa_driver_wrapper_verify_hash_complete(operation);
3802
Paul Elliott296ede92022-12-15 17:00:30 +00003803 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003804 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003805 operation);
3806
Paul Elliottebe225c2023-02-10 14:32:53 +00003807exit:
3808
Paul Elliott9fe12f62022-11-30 19:16:02 +00003809 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003810 if (status != PSA_SUCCESS) {
3811 operation->error_occurred = 1;
3812 }
3813
Paul Elliott59ad9452022-12-18 15:09:02 +00003814 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003815 }
3816
3817 return status;
3818}
3819
3820psa_status_t psa_verify_hash_abort(
3821 psa_verify_hash_interruptible_operation_t *operation)
3822{
Paul Elliott59ad9452022-12-18 15:09:02 +00003823 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003824
Paul Elliott59ad9452022-12-18 15:09:02 +00003825 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003826
Paul Elliott59ad9452022-12-18 15:09:02 +00003827 /* We clear the number of ops done here, so that it is not cleared when
3828 * the operation fails or succeeds, only on manual abort. */
3829 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003830
Paul Elliottc9774412023-02-06 15:14:07 +00003831 /* Likewise, failure state. */
3832 operation->error_occurred = 0;
3833
Paul Elliott59ad9452022-12-18 15:09:02 +00003834 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003835}
3836
Paul Elliott588f8ed2022-12-02 18:10:26 +00003837/****************************************************************/
3838/* Asymmetric interruptible cryptography internal */
3839/* implementations */
3840/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003841
Paul Elliott588f8ed2022-12-02 18:10:26 +00003842void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3843{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003844
Paul Elliott588f8ed2022-12-02 18:10:26 +00003845#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3846 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3847 defined(MBEDTLS_ECP_RESTARTABLE)
3848
3849 /* Internal implementation uses zero to indicate infinite number max ops,
3850 * therefore avoid this value, and set to minimum possible. */
3851 if (max_ops == 0) {
3852 max_ops = 1;
3853 }
3854
Paul Elliott588f8ed2022-12-02 18:10:26 +00003855 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003856#else
3857 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003858#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3859 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3860 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3861}
3862
Paul Elliott588f8ed2022-12-02 18:10:26 +00003863uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003864 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003865{
3866#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3867 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3868 defined(MBEDTLS_ECP_RESTARTABLE)
3869
Paul Elliott93d9ca82023-02-15 18:14:21 +00003870 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003871#else
3872 (void) operation;
3873 return 0;
3874#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3875 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3876 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3877}
3878
3879uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003880 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003881{
3882 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3883 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3884 defined(MBEDTLS_ECP_RESTARTABLE)
3885
Paul Elliott93d9ca82023-02-15 18:14:21 +00003886 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003887#else
3888 (void) operation;
3889 return 0;
3890#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3891 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3892 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3893}
3894
3895psa_status_t mbedtls_psa_sign_hash_start(
3896 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3897 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3898 size_t key_buffer_size, psa_algorithm_t alg,
3899 const uint8_t *hash, size_t hash_length)
3900{
3901 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003902 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003903
Paul Elliott068fe072023-01-16 13:59:15 +00003904 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3905 return PSA_ERROR_NOT_SUPPORTED;
3906 }
3907
3908 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003909 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003910 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003911
3912#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003913 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3914 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003915
Paul Elliotta1c94092023-02-15 16:38:04 +00003916 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3917
Paul Elliott93d9ca82023-02-15 18:14:21 +00003918 /* Ensure num_ops is zero'ed in case of context re-use. */
3919 operation->num_ops = 0;
3920
Paul Elliott068fe072023-01-16 13:59:15 +00003921 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3922 attributes->core.bits,
3923 key_buffer,
3924 key_buffer_size,
3925 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003926
Paul Elliott068fe072023-01-16 13:59:15 +00003927 if (status != PSA_SUCCESS) {
3928 return status;
3929 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003930
Paul Elliott1bc59df2023-02-05 13:41:57 +00003931 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003932 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003933
Paul Elliott068fe072023-01-16 13:59:15 +00003934 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003935 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003936 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003937
Paul Elliott0290a762023-02-09 14:30:24 +00003938 /* We only need to store the same length of hash as the private key size
3939 * here, it would be truncated by the internal implementation anyway. */
3940 required_hash_length = (hash_length < operation->coordinate_bytes ?
3941 hash_length : operation->coordinate_bytes);
3942
Paul Elliottba70ad42023-02-15 18:23:53 +00003943 if (required_hash_length > sizeof(operation->hash)) {
3944 /* Shouldn't happen, but better safe than sorry. */
3945 return PSA_ERROR_CORRUPTION_DETECTED;
3946 }
3947
Paul Elliott0290a762023-02-09 14:30:24 +00003948 memcpy(operation->hash, hash, required_hash_length);
3949 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003950
3951 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003952
3953#else
Paul Elliott068fe072023-01-16 13:59:15 +00003954 (void) operation;
3955 (void) key_buffer;
3956 (void) key_buffer_size;
3957 (void) alg;
3958 (void) hash;
3959 (void) hash_length;
3960 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003961 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003962
Paul Elliott068fe072023-01-16 13:59:15 +00003963 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003964#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3965 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3966 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003967}
3968
3969psa_status_t mbedtls_psa_sign_hash_complete(
3970 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3971 uint8_t *signature, size_t signature_size,
3972 size_t *signature_length)
3973{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003974#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3975 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3976 defined(MBEDTLS_ECP_RESTARTABLE)
3977
Paul Elliotta1c94092023-02-15 16:38:04 +00003978 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003979 mbedtls_mpi r;
3980 mbedtls_mpi s;
3981
Paul Elliott46845252023-02-03 14:59:11 +00003982 mbedtls_mpi_init(&r);
3983 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003984
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003985 /* Ensure max_ops is set to the current value (or default). */
3986 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3987
Paul Elliotta1c94092023-02-15 16:38:04 +00003988 if (signature_size < 2 * operation->coordinate_bytes) {
3989 status = PSA_ERROR_BUFFER_TOO_SMALL;
3990 goto exit;
3991 }
3992
Paul Elliott588f8ed2022-12-02 18:10:26 +00003993 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003994
Paul Elliott588f8ed2022-12-02 18:10:26 +00003995#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3996 status = mbedtls_to_psa_error(
3997 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003998 &r,
3999 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004000 &operation->ctx->d,
4001 operation->hash,
4002 operation->hash_length,
4003 operation->md_alg,
4004 mbedtls_psa_get_random,
4005 MBEDTLS_PSA_RANDOM_STATE,
4006 &operation->restart_ctx));
4007#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00004008 status = PSA_ERROR_NOT_SUPPORTED;
4009 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004010#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
4011 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00004012 status = mbedtls_to_psa_error(
4013 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00004014 &r,
4015 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004016 &operation->ctx->d,
4017 operation->hash,
4018 operation->hash_length,
4019 mbedtls_psa_get_random,
4020 MBEDTLS_PSA_RANDOM_STATE,
4021 mbedtls_psa_get_random,
4022 MBEDTLS_PSA_RANDOM_STATE,
4023 &operation->restart_ctx));
4024 }
4025
Paul Elliottf8e5b562023-02-19 18:43:45 +00004026 /* Hide the fact that the restart context only holds a delta of number of
4027 * ops done during the last operation, not an absolute value. */
4028 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4029
Paul Elliott724bd252023-02-08 12:35:08 +00004030 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00004031 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004032 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004033 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004034 operation->coordinate_bytes)
4035 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004036
4037 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004038 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004039 }
4040
4041 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004042 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004043 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004044 operation->coordinate_bytes,
4045 operation->coordinate_bytes)
4046 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004047
4048 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004049 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004050 }
4051
Paul Elliott1bc59df2023-02-05 13:41:57 +00004052 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004053
Paul Elliott724bd252023-02-08 12:35:08 +00004054 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004055 }
Paul Elliott724bd252023-02-08 12:35:08 +00004056
4057exit:
4058
4059 mbedtls_mpi_free(&r);
4060 mbedtls_mpi_free(&s);
4061 return status;
4062
Paul Elliott588f8ed2022-12-02 18:10:26 +00004063 #else
4064
4065 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004066 (void) signature;
4067 (void) signature_size;
4068 (void) signature_length;
4069
4070 return PSA_ERROR_NOT_SUPPORTED;
4071
4072#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4073 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4074 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4075}
4076
4077psa_status_t mbedtls_psa_sign_hash_abort(
4078 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4079{
4080
4081#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4082 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4083 defined(MBEDTLS_ECP_RESTARTABLE)
4084
4085 if (operation->ctx) {
4086 mbedtls_ecdsa_free(operation->ctx);
4087 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004088 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004089 }
4090
4091 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4092
Paul Elliott93d9ca82023-02-15 18:14:21 +00004093 operation->num_ops = 0;
4094
Paul Elliott588f8ed2022-12-02 18:10:26 +00004095 return PSA_SUCCESS;
4096
4097#else
4098
4099 (void) operation;
4100
4101 return PSA_ERROR_NOT_SUPPORTED;
4102
4103#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4104 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4105 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4106}
4107
4108psa_status_t mbedtls_psa_verify_hash_start(
4109 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4110 const psa_key_attributes_t *attributes,
4111 const uint8_t *key_buffer, size_t key_buffer_size,
4112 psa_algorithm_t alg,
4113 const uint8_t *hash, size_t hash_length,
4114 const uint8_t *signature, size_t signature_length)
4115{
4116 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004117 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004118 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004119
Paul Elliott068fe072023-01-16 13:59:15 +00004120 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4121 return PSA_ERROR_NOT_SUPPORTED;
4122 }
4123
4124 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004125 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004126 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004127
4128#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004129 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4130 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004131
Paul Elliotta1c94092023-02-15 16:38:04 +00004132 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4133 mbedtls_mpi_init(&operation->r);
4134 mbedtls_mpi_init(&operation->s);
4135
Paul Elliott93d9ca82023-02-15 18:14:21 +00004136 /* Ensure num_ops is zero'ed in case of context re-use. */
4137 operation->num_ops = 0;
4138
Paul Elliott068fe072023-01-16 13:59:15 +00004139 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4140 attributes->core.bits,
4141 key_buffer,
4142 key_buffer_size,
4143 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004144
Paul Elliott068fe072023-01-16 13:59:15 +00004145 if (status != PSA_SUCCESS) {
4146 return status;
4147 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004148
Paul Elliottc569fc22023-02-10 13:02:54 +00004149 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004150
Paul Elliott1bc59df2023-02-05 13:41:57 +00004151 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004152 return PSA_ERROR_INVALID_SIGNATURE;
4153 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004154
Paul Elliott068fe072023-01-16 13:59:15 +00004155 status = mbedtls_to_psa_error(
4156 mbedtls_mpi_read_binary(&operation->r,
4157 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004158 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004159
Paul Elliott068fe072023-01-16 13:59:15 +00004160 if (status != PSA_SUCCESS) {
4161 return status;
4162 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004163
Paul Elliott068fe072023-01-16 13:59:15 +00004164 status = mbedtls_to_psa_error(
4165 mbedtls_mpi_read_binary(&operation->s,
4166 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004167 coordinate_bytes,
4168 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004169
Paul Elliott068fe072023-01-16 13:59:15 +00004170 if (status != PSA_SUCCESS) {
4171 return status;
4172 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004173
Paul Elliott2c9843f2023-02-15 17:32:42 +00004174 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004175
Paul Elliott2c9843f2023-02-15 17:32:42 +00004176 if (status != PSA_SUCCESS) {
4177 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004178 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004179
Paul Elliott0290a762023-02-09 14:30:24 +00004180 /* We only need to store the same length of hash as the private key size
4181 * here, it would be truncated by the internal implementation anyway. */
4182 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4183 coordinate_bytes);
4184
Paul Elliottba70ad42023-02-15 18:23:53 +00004185 if (required_hash_length > sizeof(operation->hash)) {
4186 /* Shouldn't happen, but better safe than sorry. */
4187 return PSA_ERROR_CORRUPTION_DETECTED;
4188 }
4189
Paul Elliott0290a762023-02-09 14:30:24 +00004190 memcpy(operation->hash, hash, required_hash_length);
4191 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004192
4193 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004194#else
Paul Elliott068fe072023-01-16 13:59:15 +00004195 (void) operation;
4196 (void) key_buffer;
4197 (void) key_buffer_size;
4198 (void) alg;
4199 (void) hash;
4200 (void) hash_length;
4201 (void) signature;
4202 (void) signature_length;
4203 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004204 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004205 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004206
Paul Elliott068fe072023-01-16 13:59:15 +00004207 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004208#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4209 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4210 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004211}
4212
4213psa_status_t mbedtls_psa_verify_hash_complete(
4214 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4215{
4216
4217#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4218 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4219 defined(MBEDTLS_ECP_RESTARTABLE)
4220
Paul Elliottf8e5b562023-02-19 18:43:45 +00004221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4222
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004223 /* Ensure max_ops is set to the current value (or default). */
4224 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4225
Paul Elliottf8e5b562023-02-19 18:43:45 +00004226 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004227 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4228 operation->hash,
4229 operation->hash_length,
4230 &operation->ctx->Q,
4231 &operation->r,
4232 &operation->s,
4233 &operation->restart_ctx));
4234
Paul Elliottf8e5b562023-02-19 18:43:45 +00004235 /* Hide the fact that the restart context only holds a delta of number of
4236 * ops done during the last operation, not an absolute value. */
4237 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4238
4239 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004240#else
4241 (void) operation;
4242
4243 return PSA_ERROR_NOT_SUPPORTED;
4244
4245#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4246 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4247 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4248}
4249
4250psa_status_t mbedtls_psa_verify_hash_abort(
4251 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4252{
4253
4254#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4255 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4256 defined(MBEDTLS_ECP_RESTARTABLE)
4257
4258 if (operation->ctx) {
4259 mbedtls_ecdsa_free(operation->ctx);
4260 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004261 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004262 }
4263
4264 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4265
Paul Elliott93d9ca82023-02-15 18:14:21 +00004266 operation->num_ops = 0;
4267
Paul Elliott588f8ed2022-12-02 18:10:26 +00004268 mbedtls_mpi_free(&operation->r);
4269 mbedtls_mpi_free(&operation->s);
4270
4271 return PSA_SUCCESS;
4272
4273#else
4274 (void) operation;
4275
4276 return PSA_ERROR_NOT_SUPPORTED;
4277
4278#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4279 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4280 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4281}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004282
David Horstmann6e99bb22024-02-06 15:27:49 +00004283static psa_status_t psa_generate_random_internal(uint8_t *output,
4284 size_t output_size)
4285{
4286 GUARD_MODULE_INITIALIZED;
4287
4288 psa_status_t status;
4289
4290#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4291
4292 size_t output_length = 0;
4293 status = mbedtls_psa_external_get_random(&global_data.rng,
4294 output, output_size,
4295 &output_length);
4296 if (status != PSA_SUCCESS) {
4297 goto exit;
4298 }
4299 /* Breaking up a request into smaller chunks is currently not supported
4300 * for the external RNG interface. */
4301 if (output_length != output_size) {
4302 status = PSA_ERROR_INSUFFICIENT_ENTROPY;
4303 goto exit;
4304 }
4305 status = PSA_SUCCESS;
4306
4307#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4308
4309 while (output_size > 0) {
4310 size_t request_size =
4311 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4312 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4313 output_size);
4314 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
4315 output, request_size);
4316 if (ret != 0) {
4317 status = mbedtls_to_psa_error(ret);
4318 goto exit;
4319 }
4320 output_size -= request_size;
4321 output += request_size;
4322 }
4323 status = PSA_SUCCESS;
4324#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4325
4326exit:
4327 return status;
4328}
4329
4330
mohammad1603503973b2018-03-12 15:59:30 +02004331/****************************************************************/
4332/* Symmetric cryptography */
4333/****************************************************************/
4334
Gilles Peskine449bd832023-01-11 14:50:10 +01004335static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4336 mbedtls_svc_key_id_t key,
4337 psa_algorithm_t alg,
4338 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004339{
4340 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4341 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004342 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4344 PSA_KEY_USAGE_ENCRYPT :
4345 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004346 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004347
4348 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004350 status = PSA_ERROR_BAD_STATE;
4351 goto exit;
4352 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004353
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004355 status = PSA_ERROR_INVALID_ARGUMENT;
4356 goto exit;
4357 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004358
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4360 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004361 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004363
Ronald Cron49fafa92021-03-10 08:34:23 +01004364 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004365 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004366 * so we only set it (in the driver wrapper) after resources have been
4367 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004368 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004370 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004372 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 }
4374 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004375
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004376 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004378 };
4379
Ronald Cronab99ac22020-10-01 16:38:28 +02004380 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 if (cipher_operation == MBEDTLS_ENCRYPT) {
4382 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4383 &attributes,
4384 slot->key.data,
4385 slot->key.bytes,
4386 alg);
4387 } else {
4388 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4389 &attributes,
4390 slot->key.data,
4391 slot->key.bytes,
4392 alg);
4393 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004394
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004395exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 if (status != PSA_SUCCESS) {
4397 psa_cipher_abort(operation);
4398 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004399
Ryan Everett1b70a072024-01-04 10:32:49 +00004400 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004403}
4404
Gilles Peskine449bd832023-01-11 14:50:10 +01004405psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4406 mbedtls_svc_key_id_t key,
4407 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004408{
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004410}
4411
Gilles Peskine449bd832023-01-11 14:50:10 +01004412psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4413 mbedtls_svc_key_id_t key,
4414 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004415{
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004417}
4418
Gilles Peskine449bd832023-01-11 14:50:10 +01004419psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004420 uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 size_t iv_size,
4422 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004423{
Ronald Cron6d051732020-10-01 14:10:20 +02004424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Sergeybef1f632023-03-06 15:25:06 -07004425 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004426
Gabor Mezei358eb212024-02-07 18:10:13 +01004427 LOCAL_OUTPUT_DECLARE(iv_external, iv);
4428
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004430 status = PSA_ERROR_BAD_STATE;
4431 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004432 }
4433
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004435 status = PSA_ERROR_BAD_STATE;
4436 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004437 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004438
Ronald Cron2fb90522021-07-05 12:31:44 +02004439 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004441 status = PSA_ERROR_BUFFER_TOO_SMALL;
4442 goto exit;
4443 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004444
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004446 status = PSA_ERROR_GENERIC_ERROR;
4447 goto exit;
4448 }
4449
Gabor Mezei358eb212024-02-07 18:10:13 +01004450 LOCAL_OUTPUT_ALLOC(iv_external, default_iv_length, iv);
4451
Gabor Mezei1b5b58d2024-03-04 17:15:08 +01004452 status = psa_generate_random_internal(iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004454 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 }
Ronald Cron5618a392021-03-26 09:52:26 +01004456
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 status = psa_driver_wrapper_cipher_set_iv(operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004458 iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004459
4460exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 if (status == PSA_SUCCESS) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004462 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004463 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004465 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 psa_cipher_abort(operation);
Gabor Mezei358eb212024-02-07 18:10:13 +01004467 if (iv != NULL) {
4468 mbedtls_platform_zeroize(iv, default_iv_length);
4469 }
Ronald Cron2fb90522021-07-05 12:31:44 +02004470 }
Ronald Cron6d051732020-10-01 14:10:20 +02004471
Gabor Mezei358eb212024-02-07 18:10:13 +01004472 LOCAL_OUTPUT_FREE(iv_external, iv);
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004474}
4475
Gilles Peskine449bd832023-01-11 14:50:10 +01004476psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004477 const uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004479{
Ronald Cron6d051732020-10-01 14:10:20 +02004480 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004481
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004482 LOCAL_INPUT_DECLARE(iv_external, iv);
4483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004485 status = PSA_ERROR_BAD_STATE;
4486 goto exit;
4487 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004488
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004490 status = PSA_ERROR_BAD_STATE;
4491 goto exit;
4492 }
Ronald Crona0d68172021-03-26 10:15:08 +01004493
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004495 status = PSA_ERROR_INVALID_ARGUMENT;
4496 goto exit;
4497 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004498
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004499 LOCAL_INPUT_ALLOC(iv_external, iv_length, iv);
4500
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 status = psa_driver_wrapper_cipher_set_iv(operation,
4502 iv,
4503 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004504
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004505exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004507 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 } else {
4509 psa_cipher_abort(operation);
4510 }
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004511
4512 LOCAL_INPUT_FREE(iv_external, iv);
4513
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004515}
4516
Gilles Peskine449bd832023-01-11 14:50:10 +01004517psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004518 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004520 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 size_t output_size,
4522 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004523{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004524 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004525
Gabor Mezei212eb082024-01-24 16:56:00 +01004526 LOCAL_INPUT_DECLARE(input_external, input);
4527 LOCAL_OUTPUT_DECLARE(output_external, output);
4528
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004530 status = PSA_ERROR_BAD_STATE;
4531 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004532 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004533
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004535 status = PSA_ERROR_BAD_STATE;
4536 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004537 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004538
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004539 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gabor Mezei0b041162024-02-29 10:08:16 +00004540 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004541
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 status = psa_driver_wrapper_cipher_update(operation,
4543 input,
4544 input_length,
4545 output,
4546 output_size,
4547 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004548
4549exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 if (status != PSA_SUCCESS) {
4551 psa_cipher_abort(operation);
4552 }
Ronald Cron6d051732020-10-01 14:10:20 +02004553
Gabor Mezei212eb082024-01-24 16:56:00 +01004554 LOCAL_INPUT_FREE(input_external, input);
4555 LOCAL_OUTPUT_FREE(output_external, output);
4556
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004558}
4559
Gilles Peskine449bd832023-01-11 14:50:10 +01004560psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004561 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 size_t output_size,
4563 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004564{
David Saadab4ecc272019-02-14 13:48:10 +02004565 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004566
Gabor Mezei212eb082024-01-24 16:56:00 +01004567 LOCAL_OUTPUT_DECLARE(output_external, output);
4568
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004570 status = PSA_ERROR_BAD_STATE;
4571 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004572 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004573
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004575 status = PSA_ERROR_BAD_STATE;
4576 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004577 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004578
Gabor Mezei0b041162024-02-29 10:08:16 +00004579 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004580
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 status = psa_driver_wrapper_cipher_finish(operation,
4582 output,
4583 output_size,
4584 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004585
4586exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (status == PSA_SUCCESS) {
Gabor Mezei212eb082024-01-24 16:56:00 +01004588 status = psa_cipher_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004590 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 (void) psa_cipher_abort(operation);
Steven Cooremanef8575e2020-09-11 11:44:50 +02004592 }
Gabor Mezei212eb082024-01-24 16:56:00 +01004593
4594 LOCAL_OUTPUT_FREE(output_external, output);
4595
4596 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004597}
4598
Gilles Peskine449bd832023-01-11 14:50:10 +01004599psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004600{
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004602 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004603 * in use. It's ok to call abort on such an object, and there's
4604 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004606 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004607
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004609
Ronald Cron49fafa92021-03-10 08:34:23 +01004610 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004611 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004612 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004613
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004615}
4616
Gilles Peskine449bd832023-01-11 14:50:10 +01004617psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4618 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004619 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004620 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004621 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 size_t output_size,
4623 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004624{
4625 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004626 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004627 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004628 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4629 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004630 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004631
David Horstmann62a56d92023-12-14 18:12:47 +00004632 LOCAL_INPUT_DECLARE(input_external, input);
4633 LOCAL_OUTPUT_DECLARE(output_external, output);
4634
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004636 status = PSA_ERROR_INVALID_ARGUMENT;
4637 goto exit;
4638 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004639
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4641 PSA_KEY_USAGE_ENCRYPT,
4642 alg);
4643 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004644 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004646
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004647 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004649 };
4650
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4652 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004653 status = PSA_ERROR_GENERIC_ERROR;
4654 goto exit;
4655 }
4656
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 if (default_iv_length > 0) {
4658 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004659 status = PSA_ERROR_BUFFER_TOO_SMALL;
4660 goto exit;
4661 }
4662
David Horstmann6e99bb22024-02-06 15:27:49 +00004663 status = psa_generate_random_internal(local_iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004665 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004667 }
4668
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004669 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4670 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4671
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004672 status = psa_driver_wrapper_cipher_encrypt(
4673 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004674 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004675 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004677
4678exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004679 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004681 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004682 }
Ronald Cron23919522021-07-08 19:00:07 +02004683
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 if (status == PSA_SUCCESS) {
4685 if (default_iv_length > 0) {
4686 memcpy(output, local_iv, default_iv_length);
4687 }
4688 *output_length += default_iv_length;
4689 } else {
4690 *output_length = 0;
4691 }
4692
David Horstmann62a56d92023-12-14 18:12:47 +00004693 LOCAL_INPUT_FREE(input_external, input);
4694 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004695
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004697}
4698
Gilles Peskine449bd832023-01-11 14:50:10 +01004699psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4700 psa_algorithm_t alg,
Gabor Mezei212eb082024-01-24 16:56:00 +01004701 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004703 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 size_t output_size,
4705 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004706{
4707 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004708 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004709 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004710 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004711
Gabor Mezei212eb082024-01-24 16:56:00 +01004712 LOCAL_INPUT_DECLARE(input_external, input);
4713 LOCAL_OUTPUT_DECLARE(output_external, output);
4714
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004716 status = PSA_ERROR_INVALID_ARGUMENT;
4717 goto exit;
4718 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004719
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4721 PSA_KEY_USAGE_DECRYPT,
4722 alg);
4723 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004724 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004726
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004727 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004729 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004730
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4732 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004733 status = PSA_ERROR_INVALID_ARGUMENT;
4734 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004736 status = PSA_ERROR_INVALID_ARGUMENT;
4737 goto exit;
4738 }
4739
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004740 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4741 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4742
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004743 status = psa_driver_wrapper_cipher_decrypt(
4744 &attributes, slot->key.data, slot->key.bytes,
4745 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004747
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004748exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004749 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004751 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004753
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004755 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 }
Ronald Cron23919522021-07-08 19:00:07 +02004757
Gabor Mezei212eb082024-01-24 16:56:00 +01004758 LOCAL_INPUT_FREE(input_external, input);
4759 LOCAL_OUTPUT_FREE(output_external, output);
4760
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004762}
4763
4764
mohammad16035955c982018-04-26 00:53:03 +03004765/****************************************************************/
4766/* AEAD */
4767/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004768
Paul Elliottbaff51c2021-09-28 17:44:45 +01004769/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004770static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004771{
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004773}
4774
4775/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004776static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4777 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004778{
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004780
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004782#if defined(PSA_WANT_ALG_GCM)
4783 case PSA_ALG_GCM:
4784 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 * arbitrarily large nonces. Please note that we do not generally
4786 * recommend the usage of nonces of greater length than
4787 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4788 * size, which can then lead to collisions if you encrypt a very
4789 * large number of messages.*/
4790 if (nonce_length != 0) {
4791 return PSA_SUCCESS;
4792 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004793 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004794#endif /* PSA_WANT_ALG_GCM */
4795#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004796 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if (nonce_length >= 7 && nonce_length <= 13) {
4798 return PSA_SUCCESS;
4799 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004800 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004801#endif /* PSA_WANT_ALG_CCM */
4802#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004803 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (nonce_length == 12) {
4805 return PSA_SUCCESS;
4806 } else if (nonce_length == 8) {
4807 return PSA_ERROR_NOT_SUPPORTED;
4808 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004809 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004810#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004811 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004812 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004814 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004815
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004817}
4818
Gilles Peskine449bd832023-01-11 14:50:10 +01004819static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004820{
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4822 return PSA_ERROR_INVALID_ARGUMENT;
4823 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004824
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004826}
4827
Gilles Peskine449bd832023-01-11 14:50:10 +01004828psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4829 psa_algorithm_t alg,
David Horstmann9d09a022023-11-28 19:25:00 +00004830 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 size_t nonce_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004832 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 size_t additional_data_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004834 const uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 size_t plaintext_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004836 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 size_t ciphertext_size,
4838 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004839{
Ronald Cron215633c2021-03-16 17:15:37 +01004840 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4841 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004842
David Horstmann9d09a022023-11-28 19:25:00 +00004843 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4844 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4845 LOCAL_INPUT_DECLARE(plaintext_external, plaintext);
4846 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
4847
mohammad1603f08a5502018-06-03 15:05:47 +03004848 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004849
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 status = psa_aead_check_algorithm(alg);
4851 if (status != PSA_SUCCESS) {
4852 return status;
4853 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004854
Ronald Cron9a986162021-03-26 12:40:07 +01004855 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4857 if (status != PSA_SUCCESS) {
4858 return status;
4859 }
mohammad16035955c982018-04-26 00:53:03 +03004860
Ronald Cron215633c2021-03-16 17:15:37 +01004861 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004863 };
mohammad16035955c982018-04-26 00:53:03 +03004864
David Horstmann9d09a022023-11-28 19:25:00 +00004865 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4866 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length, additional_data);
4867 LOCAL_INPUT_ALLOC(plaintext_external, plaintext_length, plaintext);
4868 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
4869
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 status = psa_aead_check_nonce_length(alg, nonce_length);
4871 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004872 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004874
Ronald Cronde822812021-03-17 16:08:20 +01004875 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004876 &attributes, slot->key.data, slot->key.bytes,
4877 alg,
4878 nonce, nonce_length,
4879 additional_data, additional_data_length,
4880 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004882
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4884 memset(ciphertext, 0, ciphertext_size);
4885 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004886
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004887exit:
David Horstmann9d09a022023-11-28 19:25:00 +00004888 LOCAL_INPUT_FREE(nonce_external, nonce);
4889 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4890 LOCAL_INPUT_FREE(plaintext_external, plaintext);
4891 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
4892
Ryan Everett1b70a072024-01-04 10:32:49 +00004893 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004894
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004896}
4897
Gilles Peskine449bd832023-01-11 14:50:10 +01004898psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4899 psa_algorithm_t alg,
David Horstmann7f2e0402023-11-28 19:43:53 +00004900 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 size_t nonce_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004902 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 size_t additional_data_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004904 const uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 size_t ciphertext_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004906 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 size_t plaintext_size,
4908 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004909{
Ronald Cron215633c2021-03-16 17:15:37 +01004910 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4911 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004912
David Horstmann7f2e0402023-11-28 19:43:53 +00004913 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4914 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4915 LOCAL_INPUT_DECLARE(ciphertext_external, ciphertext);
4916 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
4917
Gilles Peskineee652a32018-06-01 19:23:52 +02004918 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004919
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 status = psa_aead_check_algorithm(alg);
4921 if (status != PSA_SUCCESS) {
4922 return status;
4923 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004924
Ronald Cron9a986162021-03-26 12:40:07 +01004925 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4927 if (status != PSA_SUCCESS) {
4928 return status;
4929 }
mohammad16035955c982018-04-26 00:53:03 +03004930
Ronald Cron215633c2021-03-16 17:15:37 +01004931 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004933 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004934
David Horstmann7f2e0402023-11-28 19:43:53 +00004935 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4936 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length,
4937 additional_data);
4938 LOCAL_INPUT_ALLOC(ciphertext_external, ciphertext_length, ciphertext);
4939 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
4940
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 status = psa_aead_check_nonce_length(alg, nonce_length);
4942 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004943 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004945
Ronald Cronde822812021-03-17 16:08:20 +01004946 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004947 &attributes, slot->key.data, slot->key.bytes,
4948 alg,
4949 nonce, nonce_length,
4950 additional_data, additional_data_length,
4951 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004953
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 if (status != PSA_SUCCESS && plaintext_size != 0) {
4955 memset(plaintext, 0, plaintext_size);
4956 }
mohammad160360a64d02018-06-03 17:20:42 +03004957
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004958exit:
David Horstmann7f2e0402023-11-28 19:43:53 +00004959 LOCAL_INPUT_FREE(nonce_external, nonce);
4960 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4961 LOCAL_INPUT_FREE(ciphertext_external, ciphertext);
4962 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
4963
Ryan Everett1b70a072024-01-04 10:32:49 +00004964 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 return status;
mohammad16035955c982018-04-26 00:53:03 +03004967}
4968
Gilles Peskine449bd832023-01-11 14:50:10 +01004969static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4970{
4971 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004972
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004974#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004976 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004977 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4978 return PSA_ERROR_INVALID_ARGUMENT;
4979 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004980 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004981#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004982
Przemek Stekiel86679c72022-10-06 17:06:56 +02004983#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004985 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004986 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4987 return PSA_ERROR_INVALID_ARGUMENT;
4988 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004989 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004990#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004991
Przemek Stekiel86679c72022-10-06 17:06:56 +02004992#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004994 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 if (tag_len != 16) {
4996 return PSA_ERROR_INVALID_ARGUMENT;
4997 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004998 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004999#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01005000
5001 default:
5002 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01005004 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005005 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01005006}
5007
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005008/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005009static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
5010 int is_encrypt,
5011 mbedtls_svc_key_id_t key,
5012 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01005013{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005014 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5015 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
5016 psa_key_slot_t *slot = NULL;
5017 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005018 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005019
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 status = psa_aead_check_algorithm(alg);
5021 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005022 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 }
Paul Elliottc2b71442021-06-24 18:17:52 +01005024
Gilles Peskine449bd832023-01-11 14:50:10 +01005025 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005026 status = PSA_ERROR_BAD_STATE;
5027 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01005028 }
5029
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 if (operation->nonce_set || operation->lengths_set ||
5031 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005032 status = PSA_ERROR_BAD_STATE;
5033 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01005034 }
5035
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005037 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005039 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
5043 alg);
5044 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005045 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005047
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005048 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005049 .core = slot->attr
5050 };
5051
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02005053 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02005055
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 if (is_encrypt) {
5057 status = psa_driver_wrapper_aead_encrypt_setup(operation,
5058 &attributes,
5059 slot->key.data,
5060 slot->key.bytes,
5061 alg);
5062 } else {
5063 status = psa_driver_wrapper_aead_decrypt_setup(operation,
5064 &attributes,
5065 slot->key.data,
5066 slot->key.bytes,
5067 alg);
5068 }
5069 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005070 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005072
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005074
5075exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00005076 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005077
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005079 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01005081 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01005082 } else {
5083 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005084 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005085
Gilles Peskine449bd832023-01-11 14:50:10 +01005086 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01005087}
5088
Paul Elliott302ff6b2021-04-20 18:10:30 +01005089/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005090psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
5091 mbedtls_svc_key_id_t key,
5092 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005093{
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005095}
5096
5097/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005098psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
5099 mbedtls_svc_key_id_t key,
5100 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005101{
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005103}
5104
David Horstmannfed23772023-12-19 17:49:20 +00005105static psa_status_t psa_aead_set_nonce_internal(psa_aead_operation_t *operation,
5106 const uint8_t *nonce,
5107 size_t nonce_length)
5108{
5109 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5110
5111 if (operation->id == 0) {
5112 status = PSA_ERROR_BAD_STATE;
5113 goto exit;
5114 }
5115
5116 if (operation->nonce_set) {
5117 status = PSA_ERROR_BAD_STATE;
5118 goto exit;
5119 }
5120
5121 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5122 if (status != PSA_SUCCESS) {
5123 status = PSA_ERROR_INVALID_ARGUMENT;
5124 goto exit;
5125 }
5126
5127 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5128 nonce_length);
5129
5130exit:
5131 if (status == PSA_SUCCESS) {
5132 operation->nonce_set = 1;
5133 } else {
5134 psa_aead_abort(operation);
5135 }
5136
5137 return status;
5138}
5139
Paul Elliott302ff6b2021-04-20 18:10:30 +01005140/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01005141psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
David Horstmannd3cad8b2023-12-11 14:46:04 +00005142 uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 size_t nonce_size,
5144 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005145{
5146 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01005147 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07005148 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005149
David Horstmannd3cad8b2023-12-11 14:46:04 +00005150 LOCAL_OUTPUT_DECLARE(nonce_external, nonce);
5151 LOCAL_OUTPUT_ALLOC(nonce_external, nonce_size, nonce);
5152
Paul Elliott8eb9daf2021-06-04 16:42:21 +01005153 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005154
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005156 status = PSA_ERROR_BAD_STATE;
5157 goto exit;
5158 }
5159
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005161 status = PSA_ERROR_BAD_STATE;
5162 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005163 }
5164
Paul Elliotte193ea82021-10-01 13:00:16 +01005165 /* For CCM, this size may not be correct according to the PSA
5166 * specification. The PSA Crypto 1.0.1 specification states:
5167 *
5168 * CCM encodes the plaintext length pLen in L octets, with L the smallest
5169 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
5170 *
5171 * However this restriction that L has to be the smallest integer is not
5172 * applied in practice, and it is not implementable here since the
5173 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
5175 operation->alg);
5176 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005177 status = PSA_ERROR_BUFFER_TOO_SMALL;
5178 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005179 }
5180
David Horstmann6e99bb22024-02-06 15:27:49 +00005181 status = psa_generate_random_internal(local_nonce, required_nonce_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005183 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005185
David Horstmannfed23772023-12-19 17:49:20 +00005186 status = psa_aead_set_nonce_internal(operation, local_nonce,
5187 required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005188
Paul Elliott39dc6b82021-05-11 19:16:09 +01005189exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 if (status == PSA_SUCCESS) {
5191 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005192 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 } else {
5194 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005195 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005196
David Horstmannd3cad8b2023-12-11 14:46:04 +00005197 LOCAL_OUTPUT_FREE(nonce_external, nonce);
5198
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005200}
5201
5202/* Set the nonce for a multipart authenticated encryption or decryption
5203 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005204psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
David Horstmann8f0ef512023-12-11 15:17:11 +00005205 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005207{
David Horstmannfed23772023-12-19 17:49:20 +00005208 psa_status_t status;
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005209
David Horstmann8f0ef512023-12-11 15:17:11 +00005210 LOCAL_INPUT_DECLARE(nonce_external, nonce);
5211 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
Paul Elliottcee785c2021-05-20 14:29:20 +01005212
David Horstmannfed23772023-12-19 17:49:20 +00005213 status = psa_aead_set_nonce_internal(operation, nonce, nonce_length);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005214
David Horstmann18dc0322023-12-20 16:16:43 +00005215/* Exit label is only needed for buffer copying, prevent unused warnings. */
5216#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Paul Elliott39dc6b82021-05-11 19:16:09 +01005217exit:
David Horstmann18dc0322023-12-20 16:16:43 +00005218#endif
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005219
David Horstmann8f0ef512023-12-11 15:17:11 +00005220 LOCAL_INPUT_FREE(nonce_external, nonce);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005221
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005223}
5224
5225/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005226psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5227 size_t ad_length,
5228 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005229{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005230 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5231
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005233 status = PSA_ERROR_BAD_STATE;
5234 goto exit;
5235 }
5236
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 if (operation->lengths_set || operation->ad_started ||
5238 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005239 status = PSA_ERROR_BAD_STATE;
5240 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005241 }
5242
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005244#if defined(PSA_WANT_ALG_GCM)
5245 case PSA_ALG_GCM:
5246 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 * bits. Without the guard this code will generate warnings on 32bit
5248 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005249#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 if (((uint64_t) ad_length) >> 61 != 0 ||
5251 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005252 status = PSA_ERROR_INVALID_ARGUMENT;
5253 goto exit;
5254 }
Paul Elliott325d3742021-09-27 17:56:28 +01005255#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005256 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005257#endif /* PSA_WANT_ALG_GCM */
5258#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005259 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005261 status = PSA_ERROR_INVALID_ARGUMENT;
5262 goto exit;
5263 }
5264 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005265#endif /* PSA_WANT_ALG_CCM */
5266#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005267 case PSA_ALG_CHACHA20_POLY1305:
5268 /* No length restrictions for ChaChaPoly. */
5269 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005270#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005271 default:
5272 break;
5273 }
Paul Elliott325d3742021-09-27 17:56:28 +01005274
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5276 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005277
Paul Elliott39dc6b82021-05-11 19:16:09 +01005278exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005280 operation->ad_remaining = ad_length;
5281 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005282 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 } else {
5284 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005285 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005286
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005288}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005289
5290/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005291psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
David Horstmann25dac6e2023-12-11 15:23:13 +00005292 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005294{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005295 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5296
David Horstmann25dac6e2023-12-11 15:23:13 +00005297 LOCAL_INPUT_DECLARE(input_external, input);
5298 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5299
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005301 status = PSA_ERROR_BAD_STATE;
5302 goto exit;
5303 }
5304
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005306 status = PSA_ERROR_BAD_STATE;
5307 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005308 }
5309
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 if (operation->lengths_set) {
5311 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005312 status = PSA_ERROR_INVALID_ARGUMENT;
5313 goto exit;
5314 }
5315
5316 operation->ad_remaining -= input_length;
5317 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005318#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005320 status = PSA_ERROR_BAD_STATE;
5321 goto exit;
5322 }
5323#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005324
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 status = psa_driver_wrapper_aead_update_ad(operation, input,
5326 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005327
Paul Elliott39dc6b82021-05-11 19:16:09 +01005328exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005330 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 } else {
5332 psa_aead_abort(operation);
5333 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005334
David Horstmann25dac6e2023-12-11 15:23:13 +00005335 LOCAL_INPUT_FREE(input_external, input);
5336
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005338}
5339
5340/* Encrypt or decrypt a message fragment in an active multipart AEAD
5341 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005342psa_status_t psa_aead_update(psa_aead_operation_t *operation,
David Horstmann2914fac2023-12-11 15:28:37 +00005343 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 size_t input_length,
David Horstmann2914fac2023-12-11 15:28:37 +00005345 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 size_t output_size,
5347 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005348{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005349 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005350
David Horstmann2914fac2023-12-11 15:28:37 +00005351
5352 LOCAL_INPUT_DECLARE(input_external, input);
5353 LOCAL_OUTPUT_DECLARE(output_external, output);
5354
5355 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5356 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
5357
Paul Elliott302ff6b2021-04-20 18:10:30 +01005358 *output_length = 0;
5359
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005361 status = PSA_ERROR_BAD_STATE;
5362 goto exit;
5363 }
5364
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005366 status = PSA_ERROR_BAD_STATE;
5367 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005368 }
5369
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005371 /* Additional data length was supplied, but not all the additional
5372 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005374 status = PSA_ERROR_INVALID_ARGUMENT;
5375 goto exit;
5376 }
5377
5378 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005380 status = PSA_ERROR_INVALID_ARGUMENT;
5381 goto exit;
5382 }
5383
5384 operation->body_remaining -= input_length;
5385 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005386#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005388 status = PSA_ERROR_BAD_STATE;
5389 goto exit;
5390 }
5391#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005392
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5394 output, output_size,
5395 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005396
Paul Elliott39dc6b82021-05-11 19:16:09 +01005397exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005399 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 } else {
5401 psa_aead_abort(operation);
5402 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005403
David Horstmann2914fac2023-12-11 15:28:37 +00005404 LOCAL_INPUT_FREE(input_external, input);
5405 LOCAL_OUTPUT_FREE(output_external, output);
5406
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005408}
5409
Gilles Peskine449bd832023-01-11 14:50:10 +01005410static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005411{
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 if (operation->id == 0 || !operation->nonce_set) {
5413 return PSA_ERROR_BAD_STATE;
5414 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005415
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5417 operation->body_remaining != 0)) {
5418 return PSA_ERROR_INVALID_ARGUMENT;
5419 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005420
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005422}
5423
Paul Elliott302ff6b2021-04-20 18:10:30 +01005424/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005425psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
David Horstmann6db0e732023-12-11 15:35:59 +00005426 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 size_t ciphertext_size,
5428 size_t *ciphertext_length,
David Horstmann6db0e732023-12-11 15:35:59 +00005429 uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 size_t tag_size,
5431 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005432{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005433 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5434
David Horstmann6db0e732023-12-11 15:35:59 +00005435 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
5436 LOCAL_OUTPUT_DECLARE(tag_external, tag);
5437
5438 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
5439 LOCAL_OUTPUT_ALLOC(tag_external, tag_size, tag);
5440
Paul Elliott302ff6b2021-04-20 18:10:30 +01005441 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005442 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005443
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 status = psa_aead_final_checks(operation);
5445 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005446 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005447 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005448
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005450 status = PSA_ERROR_BAD_STATE;
5451 goto exit;
5452 }
5453
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5455 ciphertext_size,
5456 ciphertext_length,
5457 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005458
Paul Elliott39dc6b82021-05-11 19:16:09 +01005459exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005460
5461
Paul Elliottf47b0952021-05-21 18:02:33 +01005462 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005463 * the zero tag size, make sure the tag is set to something implausible.
5464 * Even if the operation succeeds, make sure we clear the rest of the
5465 * buffer to prevent potential leakage of anything previously placed in
5466 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005467 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005468
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005470
David Horstmann6db0e732023-12-11 15:35:59 +00005471 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
5472 LOCAL_OUTPUT_FREE(tag_external, tag);
5473
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005475}
5476
5477/* Finish authenticating and decrypting a message in a multipart AEAD
5478 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005479psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
David Horstmanne000a0a2023-12-11 16:37:04 +00005480 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 size_t plaintext_size,
5482 size_t *plaintext_length,
David Horstmanne000a0a2023-12-11 16:37:04 +00005483 const uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005485{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005486 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5487
David Horstmanne000a0a2023-12-11 16:37:04 +00005488 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
5489 LOCAL_INPUT_DECLARE(tag_external, tag);
5490
5491 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
5492 LOCAL_INPUT_ALLOC(tag_external, tag_length, tag);
5493
Paul Elliott302ff6b2021-04-20 18:10:30 +01005494 *plaintext_length = 0;
5495
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 status = psa_aead_final_checks(operation);
5497 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005498 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005500
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005502 status = PSA_ERROR_BAD_STATE;
5503 goto exit;
5504 }
5505
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5507 plaintext_size,
5508 plaintext_length,
5509 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005510
5511exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005513
David Horstmanne000a0a2023-12-11 16:37:04 +00005514 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
5515 LOCAL_INPUT_FREE(tag_external, tag);
5516
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005518}
5519
5520/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005521psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005522{
5523 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5524
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005526 /* The object has (apparently) been initialized but it is not (yet)
5527 * in use. It's ok to call abort on such an object, and there's
5528 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005530 }
5531
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005533
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005535
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005537}
5538
Gilles Peskinee59236f2018-01-27 23:32:46 +01005539/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005540/* Generators */
5541/****************************************************************/
5542
Przemek Stekiel69c46792022-06-10 12:59:51 +02005543#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005544 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005545 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305546 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305547 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005548#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005549#endif /* At least one builtin KDF */
5550
Przemek Stekiel69c46792022-06-10 12:59:51 +02005551#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005552 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5553 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5554static psa_status_t psa_key_derivation_start_hmac(
5555 psa_mac_operation_t *operation,
5556 psa_algorithm_t hash_alg,
5557 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005559{
5560 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5561 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005562 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5563 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5564 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005565
Steven Cooreman72f736a2021-05-07 14:14:37 +02005566 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005568
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 status = psa_driver_wrapper_mac_sign_setup(operation,
5570 &attributes,
5571 hmac_key, hmac_key_length,
5572 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005573
Gilles Peskine449bd832023-01-11 14:50:10 +01005574 psa_reset_key_attributes(&attributes);
5575 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005576}
5577#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005578
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005579#define HKDF_STATE_INIT 0 /* no input yet */
5580#define HKDF_STATE_STARTED 1 /* got salt */
5581#define HKDF_STATE_KEYED 2 /* got key */
5582#define HKDF_STATE_OUTPUT 3 /* output started */
5583
Gilles Peskinecbe66502019-05-16 16:59:18 +02005584static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005586{
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5588 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5589 } else {
5590 return operation->alg;
5591 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005592}
5593
Gilles Peskine449bd832023-01-11 14:50:10 +01005594psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005595{
5596 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5598 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005599 /* The object has (apparently) been initialized but it is not
5600 * in use. It's ok to call abort on such an object, and there's
5601 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005603#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5605 mbedtls_free(operation->ctx.hkdf.info);
5606 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5607 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005608#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005609#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5610 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5612 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5613 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5614 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005615 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005617 }
5618
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005620 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005622 }
5623
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005625 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005627 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005628#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005630 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005632 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005633#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005634 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005635
5636 /* We leave the fields Ai and output_block to be erased safely by the
5637 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005639#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5640 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005641#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5643 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5644 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5645 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005646#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305647#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305648 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305649 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005650 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305651 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305652 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305653
5654 status = PSA_SUCCESS;
5655 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305656#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005657 {
5658 status = PSA_ERROR_BAD_STATE;
5659 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 mbedtls_platform_zeroize(operation, sizeof(*operation));
5661 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005662}
5663
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005664psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005666{
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005668 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005670 }
5671
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005672 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005674}
5675
Gilles Peskine449bd832023-01-11 14:50:10 +01005676psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5677 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005678{
Gilles Peskine449bd832023-01-11 14:50:10 +01005679 if (operation->alg == 0) {
5680 return PSA_ERROR_BAD_STATE;
5681 }
5682 if (capacity > operation->capacity) {
5683 return PSA_ERROR_INVALID_ARGUMENT;
5684 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005685 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005687}
5688
Przemek Stekiel69c46792022-06-10 12:59:51 +02005689#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005690/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005691static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5692 psa_algorithm_t kdf_alg,
5693 uint8_t *output,
5694 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005695{
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5697 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005698 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005699 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005700#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005702#else
5703 const uint8_t last_block = 0xff;
5704#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005705
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 if (hkdf->state < HKDF_STATE_KEYED ||
5707 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005708#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005710#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 )) {
5712 return PSA_ERROR_BAD_STATE;
5713 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005714 hkdf->state = HKDF_STATE_OUTPUT;
5715
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005717 /* Copy what remains of the current block */
5718 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005720 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 }
5722 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005723 output += n;
5724 output_length -= n;
5725 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005727 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005729 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005730 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005731 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005732 * object was corrupted or if this function is called directly
5733 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 if (hkdf->block_number == last_block) {
5735 return PSA_ERROR_BAD_STATE;
5736 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005737
5738 /* We need a new block */
5739 ++hkdf->block_number;
5740 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005741
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5743 hash_alg,
5744 hkdf->prk,
5745 hash_length);
5746 if (status != PSA_SUCCESS) {
5747 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005748 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005749
5750 if (hkdf->block_number != 1) {
5751 status = psa_mac_update(&hkdf->hmac,
5752 hkdf->output_block,
5753 hash_length);
5754 if (status != PSA_SUCCESS) {
5755 return status;
5756 }
5757 }
5758 status = psa_mac_update(&hkdf->hmac,
5759 hkdf->info,
5760 hkdf->info_length);
5761 if (status != PSA_SUCCESS) {
5762 return status;
5763 }
5764 status = psa_mac_update(&hkdf->hmac,
5765 &hkdf->block_number, 1);
5766 if (status != PSA_SUCCESS) {
5767 return status;
5768 }
5769 status = psa_mac_sign_finish(&hkdf->hmac,
5770 hkdf->output_block,
5771 sizeof(hkdf->output_block),
5772 &hmac_output_length);
5773 if (status != PSA_SUCCESS) {
5774 return status;
5775 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005776 }
5777
Gilles Peskine449bd832023-01-11 14:50:10 +01005778 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005779}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005780#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005781
John Durkop07cc04a2020-11-16 22:08:34 -08005782#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5783 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005784static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5785 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005787{
Gilles Peskine449bd832023-01-11 14:50:10 +01005788 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5789 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005790 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5791 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005792 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005793
Janos Follath7742fee2019-06-17 12:58:10 +01005794 /* We can't be wanting more output after block 0xff, otherwise
5795 * the capacity check in psa_key_derivation_output_bytes() would have
5796 * prevented this call. It could happen only if the operation
5797 * object was corrupted or if this function is called directly
5798 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005799 if (tls12_prf->block_number == 0xff) {
5800 return PSA_ERROR_CORRUPTION_DETECTED;
5801 }
Janos Follath7742fee2019-06-17 12:58:10 +01005802
5803 /* We need a new block */
5804 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005805 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005806
5807 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5808 *
5809 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5810 *
5811 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5812 * HMAC_hash(secret, A(2) + seed) +
5813 * HMAC_hash(secret, A(3) + seed) + ...
5814 *
5815 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005816 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005817 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005818 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005819 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005820 * is currently extracted as `output_block` and where i is
5821 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005822 */
5823
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 status = psa_key_derivation_start_hmac(&hmac,
5825 hash_alg,
5826 tls12_prf->secret,
5827 tls12_prf->secret_length);
5828 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005829 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005831
5832 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005834 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5835 * the variable seed and in this instance means it in the context of the
5836 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 status = psa_mac_update(&hmac,
5838 tls12_prf->label,
5839 tls12_prf->label_length);
5840 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005841 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005842 }
5843 status = psa_mac_update(&hmac,
5844 tls12_prf->seed,
5845 tls12_prf->seed_length);
5846 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005847 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 }
5849 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005850 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5852 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005853 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005855 }
5856
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 status = psa_mac_sign_finish(&hmac,
5858 tls12_prf->Ai, hash_length,
5859 &hmac_output_length);
5860 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005861 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 }
5863 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005864 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005866
5867 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005868 status = psa_key_derivation_start_hmac(&hmac,
5869 hash_alg,
5870 tls12_prf->secret,
5871 tls12_prf->secret_length);
5872 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005873 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 }
5875 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5876 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005877 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 }
5879 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5880 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005881 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 }
5883 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5884 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005885 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 }
5887 status = psa_mac_sign_finish(&hmac,
5888 tls12_prf->output_block, hash_length,
5889 &hmac_output_length);
5890 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005891 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005893
Janos Follath7742fee2019-06-17 12:58:10 +01005894
5895cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 cleanup_status = psa_mac_abort(&hmac);
5897 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005898 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005900
Gilles Peskine449bd832023-01-11 14:50:10 +01005901 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005902}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005903
Janos Follath844eb0e2019-06-19 12:10:49 +01005904static psa_status_t psa_key_derivation_tls12_prf_read(
5905 psa_tls12_prf_key_derivation_t *tls12_prf,
5906 psa_algorithm_t alg,
5907 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005909{
Gilles Peskine449bd832023-01-11 14:50:10 +01005910 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5911 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005912 psa_status_t status;
5913 uint8_t offset, length;
5914
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005916 case PSA_TLS12_PRF_STATE_LABEL_SET:
5917 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5918 break;
5919 case PSA_TLS12_PRF_STATE_OUTPUT:
5920 break;
5921 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005923 }
5924
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005926 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 if (tls12_prf->left_in_block == 0) {
5928 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5929 alg);
5930 if (status != PSA_SUCCESS) {
5931 return status;
5932 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005933
5934 continue;
5935 }
5936
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005938 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005940 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005942
5943 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005945 output += length;
5946 output_length -= length;
5947 tls12_prf->left_in_block -= length;
5948 }
5949
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005951}
John Durkop07cc04a2020-11-16 22:08:34 -08005952#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5953 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005954
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005955#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5956static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5957 psa_tls12_ecjpake_to_pms_t *ecjpake,
5958 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005960{
5961 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005962 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005963
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 if (output_length != 32) {
5965 return PSA_ERROR_INVALID_ARGUMENT;
5966 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005967
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5969 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5970 &output_size);
5971 if (status != PSA_SUCCESS) {
5972 return status;
5973 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005974
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 if (output_size != output_length) {
5976 return PSA_ERROR_GENERIC_ERROR;
5977 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005978
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005980}
5981#endif
5982
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305983#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305984static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5985 psa_pbkdf2_key_derivation_t *pbkdf2,
5986 psa_algorithm_t prf_alg,
5987 uint8_t prf_output_length,
5988 psa_key_attributes_t *attributes)
5989{
5990 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305991 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305992 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305993 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305994 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305995 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305996 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305997
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305998 mac_operation.is_sign = 1;
5999 mac_operation.mac_size = prf_output_length;
6000 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306001
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306002 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
6003 attributes,
6004 pbkdf2->password,
6005 pbkdf2->password_length,
6006 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306007 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306008 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306009 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306010 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
6011 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306012 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306013 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05306014 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306015 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306016 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306017 }
6018 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
6019 &mac_output_length);
6020 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306021 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306022 }
6023
6024 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05306025 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306026 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306027 }
6028
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05306029 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306030
6031 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05306032 /* We are passing prf_output_length as mac_size because the driver
6033 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306034 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306035 status = psa_driver_wrapper_mac_compute(attributes,
6036 pbkdf2->password,
6037 pbkdf2->password_length,
6038 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05306039 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306040 &mac_output_length);
6041 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306042 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306043 }
6044
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05306045 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306046 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306047
6048cleanup:
6049 /* Zeroise buffers to clear sensitive data from memory. */
6050 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
6051 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306052}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306053
6054static psa_status_t psa_key_derivation_pbkdf2_read(
6055 psa_pbkdf2_key_derivation_t *pbkdf2,
6056 psa_algorithm_t kdf_alg,
6057 uint8_t *output,
6058 size_t output_length)
6059{
6060 psa_status_t status;
6061 psa_algorithm_t prf_alg;
6062 uint8_t prf_output_length;
6063 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6064 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
6065 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
6066
6067 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6068 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
6069 prf_output_length = PSA_HASH_LENGTH(prf_alg);
6070 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05306071 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6072 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306073 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05306074 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05306075 } else {
6076 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306077 }
6078
6079 switch (pbkdf2->state) {
6080 case PSA_PBKDF2_STATE_PASSWORD_SET:
6081 /* Initially we need a new block so bytes_used is equal to block size*/
6082 pbkdf2->bytes_used = prf_output_length;
6083 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
6084 break;
6085 case PSA_PBKDF2_STATE_OUTPUT:
6086 break;
6087 default:
6088 return PSA_ERROR_BAD_STATE;
6089 }
6090
6091 while (output_length != 0) {
6092 uint8_t n = prf_output_length - pbkdf2->bytes_used;
6093 if (n > output_length) {
6094 n = (uint8_t) output_length;
6095 }
6096 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
6097 output += n;
6098 output_length -= n;
6099 pbkdf2->bytes_used += n;
6100
6101 if (output_length == 0) {
6102 break;
6103 }
6104
6105 /* We need a new block */
6106 pbkdf2->bytes_used = 0;
6107 pbkdf2->block_number++;
6108
6109 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
6110 prf_output_length,
6111 &attributes);
6112 if (status != PSA_SUCCESS) {
6113 return status;
6114 }
6115 }
6116
6117 return PSA_SUCCESS;
6118}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306119#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306120
Janos Follath6c6c8fc2019-06-17 12:38:20 +01006121psa_status_t psa_key_derivation_output_bytes(
6122 psa_key_derivation_operation_t *operation,
Ryan Everettf943e222024-01-19 14:46:39 +00006123 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006125{
6126 psa_status_t status;
Ryan Everettf943e222024-01-19 14:46:39 +00006127 LOCAL_OUTPUT_DECLARE(output_external, output);
6128
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02006130
Gilles Peskine449bd832023-01-11 14:50:10 +01006131 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006132 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006134 }
6135
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006137 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006138 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02006139 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
6140 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006141 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02006142 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006143 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006144 }
Ryan Everettf943e222024-01-19 14:46:39 +00006145
6146 LOCAL_OUTPUT_ALLOC(output_external, output_length, output);
Ryan Everettda9227d2024-01-25 11:37:22 +00006147 if (output_length > operation->capacity) {
6148 operation->capacity = 0;
6149 /* Go through the error path to wipe all confidential data now
6150 * that the operation object is useless. */
6151 status = PSA_ERROR_INSUFFICIENT_DATA;
6152 goto exit;
6153 }
6154
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006155 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006156
Przemek Stekiel69c46792022-06-10 12:59:51 +02006157#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6159 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
6160 output, output_length);
6161 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006162#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006163#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6164 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6166 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6167 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
6168 kdf_alg, output,
6169 output_length);
6170 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006171#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
6172 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006173#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006175 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
6177 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006178#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306179#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306180 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306181 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
6182 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05306183 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306184#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006185
Gilles Peskineeab56e42018-07-12 17:12:33 +02006186 {
Steven Cooreman74afe472021-02-10 17:19:22 +01006187 (void) kdf_alg;
Ryan Everettf943e222024-01-19 14:46:39 +00006188 status = PSA_ERROR_BAD_STATE;
6189 LOCAL_OUTPUT_FREE(output_external, output);
6190
6191 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006192 }
6193
6194exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006196 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006197 * This allows us to differentiate between exhausted operations and
6198 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
6199 * operations. */
6200 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006202 operation->alg = alg;
Ryan Everettee5920a2024-02-09 15:09:28 +00006203 if (output != NULL) {
6204 memset(output, '!', output_length);
6205 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006206 }
Ryan Everettda9227d2024-01-25 11:37:22 +00006207
6208 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006210}
6211
David Brown7807bf72021-02-09 16:28:23 -07006212#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006213static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02006214{
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 if (data_size >= 8) {
6216 mbedtls_des_key_set_parity(data);
6217 }
6218 if (data_size >= 16) {
6219 mbedtls_des_key_set_parity(data + 8);
6220 }
6221 if (data_size >= 24) {
6222 mbedtls_des_key_set_parity(data + 16);
6223 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006224}
David Brown7807bf72021-02-09 16:28:23 -07006225#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006226
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006227/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 * ECC keys on a Weierstrass elliptic curve require the generation
6229 * of a private key which is an integer
6230 * in the range [1, N - 1], where N is the boundary of the private key domain:
6231 * N is the prime p for Diffie-Hellman, or the order of the
6232 * curve’s base point for ECC.
6233 *
6234 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6235 * This function generates the private key using the following process:
6236 *
6237 * 1. Draw a byte string of length ceiling(m/8) bytes.
6238 * 2. If m is not a multiple of 8, set the most significant
6239 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6240 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6241 * 4. If k > N - 2, discard the result and return to step 1.
6242 * 5. Output k + 1 as the private key.
6243 *
6244 * This method allows compliance to NIST standards, specifically the methods titled
6245 * Key-Pair Generation by Testing Candidates in the following publications:
6246 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6247 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6248 * Diffie-Hellman keys.
6249 *
6250 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6251 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6252 *
6253 * Note: Function allocates memory for *data buffer, so given *data should be
6254 * always NULL.
6255 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006256#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6257#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006258static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006259 psa_key_slot_t *slot,
6260 size_t bits,
6261 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006262 uint8_t **data
6263 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006264{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006265 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006266 mbedtls_mpi k;
6267 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006268 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006269 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006270 size_t m;
6271 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006272
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 mbedtls_mpi_init(&k);
6274 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006275
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006276 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006278 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01006279 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006280
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006282 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006283 goto cleanup;
6284 }
6285
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006286 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006288
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006290
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006291 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006292 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006293 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006294
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006295 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006296
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006297 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006299
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006300 /* Note: This function is always called with *data == NULL and it
6301 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 *data = mbedtls_calloc(1, m_bytes);
6303 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006304 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006305 goto cleanup;
6306 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006307
Gilles Peskine449bd832023-01-11 14:50:10 +01006308 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006309 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006311 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006313
6314 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006315 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006316 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006317 * (8 * ceiling(m/8) - m) bits of the first byte in
6318 * the string to zero.
6319 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006321 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006322 }
6323
6324 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 * big-endian byte string.
6326 */
6327 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006328
6329 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 * Result of comparison is returned. When it indicates error
6331 * then this function is called again.
6332 */
6333 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006334 }
6335
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006336 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6338 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006339cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 if (ret != 0) {
6341 status = mbedtls_to_psa_error(ret);
6342 }
6343 if (status != PSA_SUCCESS) {
6344 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006345 *data = NULL;
6346 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 mbedtls_mpi_free(&k);
6348 mbedtls_mpi_free(&diff_N_2);
6349 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006350}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006351
6352/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6353 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6354 *
6355 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6356 * draw a 32-byte string and process it as specified in
6357 * Elliptic Curves for Security [RFC7748] §5.
6358 *
6359 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6360 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6361 *
6362 * Note: Function allocates memory for *data buffer, so given *data should be
6363 * always NULL.
6364 */
6365
6366static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6367 size_t bits,
6368 psa_key_derivation_operation_t *operation,
6369 uint8_t **data
6370 )
6371{
6372 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006373 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006374
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006376 case 255:
6377 output_length = 32;
6378 break;
6379 case 448:
6380 output_length = 56;
6381 break;
6382 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006384 break;
6385 }
6386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006388
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 if (*data == NULL) {
6390 return PSA_ERROR_INSUFFICIENT_MEMORY;
6391 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006392
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006394
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006396 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006398
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006400 case 255:
6401 (*data)[0] &= 248;
6402 (*data)[31] &= 127;
6403 (*data)[31] |= 64;
6404 break;
6405 case 448:
6406 (*data)[0] &= 252;
6407 (*data)[55] |= 128;
6408 break;
6409 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006411 break;
6412 }
6413
6414 return status;
6415}
Valerio Setti86587ab2023-06-27 13:09:30 +02006416#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6417static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6418 psa_key_slot_t *slot, size_t bits,
6419 psa_key_derivation_operation_t *operation, uint8_t **data)
6420{
6421 (void) slot;
6422 (void) bits;
6423 (void) operation;
6424 (void) data;
6425 return PSA_ERROR_NOT_SUPPORTED;
6426}
6427
6428static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6429 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6430{
6431 (void) bits;
6432 (void) operation;
6433 (void) data;
6434 return PSA_ERROR_NOT_SUPPORTED;
6435}
6436#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6437#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006438
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006439static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006440 psa_key_slot_t *slot,
6441 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006443{
6444 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006445 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306446 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006447 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006448 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006449
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6451 return PSA_ERROR_INVALID_ARGUMENT;
6452 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006453
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006454#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006455 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6457 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6458 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006459 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6461 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006462 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 }
6464 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006465 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6467 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006468 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006469 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006470 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006471 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006472#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006473 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 if (key_type_is_raw_bytes(slot->attr.type)) {
6475 if (bits % 8 != 0) {
6476 return PSA_ERROR_INVALID_ARGUMENT;
6477 }
6478 data = mbedtls_calloc(1, bytes);
6479 if (data == NULL) {
6480 return PSA_ERROR_INSUFFICIENT_MEMORY;
6481 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006482
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 status = psa_key_derivation_output_bytes(operation, data, bytes);
6484 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006485 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 }
David Brown12ca5032021-02-11 11:02:00 -07006487#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6489 psa_des_set_key_parity(data, bytes);
6490 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006491#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006492 } else {
6493 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006494 }
Ronald Crondd04d422020-11-28 15:14:42 +01006495
Ronald Cronbf33c932020-11-28 18:06:53 +01006496 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006497 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006499 };
6500
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6502 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6503 &storage_size);
6504 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306505 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 }
Archanad8a83dc2021-06-14 10:04:16 +05306507 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 status = psa_allocate_buffer_to_slot(slot, storage_size);
6509 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306510 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 }
Archanad8a83dc2021-06-14 10:04:16 +05306512
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 status = psa_driver_wrapper_import_key(&attributes,
6514 data, bytes,
6515 slot->key.data,
6516 slot->key.bytes,
6517 &slot->key.bytes, &bits);
6518 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006519 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006521
6522exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 mbedtls_free(data);
6524 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006525}
6526
Gilles Peskine449bd832023-01-11 14:50:10 +01006527psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6528 psa_key_derivation_operation_t *operation,
6529 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006530{
6531 psa_status_t status;
6532 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006533 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006534
Ronald Cron81709fc2020-11-14 12:10:32 +01006535 *key = MBEDTLS_SVC_KEY_ID_INIT;
6536
Gilles Peskine0f84d622019-09-12 19:03:13 +02006537 /* Reject any attempt to create a zero-length key so that we don't
6538 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 if (psa_get_key_bits(attributes) == 0) {
6540 return PSA_ERROR_INVALID_ARGUMENT;
6541 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006542
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 if (operation->alg == PSA_ALG_NONE) {
6544 return PSA_ERROR_BAD_STATE;
6545 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006546
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 if (!operation->can_output_key) {
6548 return PSA_ERROR_NOT_PERMITTED;
6549 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006550
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6552 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006553#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006555 /* Deriving a key in a secure element is not implemented yet. */
6556 status = PSA_ERROR_NOT_SUPPORTED;
6557 }
6558#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 if (status == PSA_SUCCESS) {
6560 status = psa_generate_derived_key_internal(slot,
6561 attributes->core.bits,
6562 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006563 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 if (status == PSA_SUCCESS) {
6565 status = psa_finish_key_creation(slot, driver, key);
6566 }
6567 if (status != PSA_SUCCESS) {
6568 psa_fail_key_creation(slot, driver);
6569 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006570
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006572}
6573
Gilles Peskineeab56e42018-07-12 17:12:33 +02006574
6575
6576/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006577/* Key derivation */
6578/****************************************************************/
6579
Steven Cooreman932ffb72021-02-15 12:14:32 +01006580#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006581static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006582{
6583#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6585 return 1;
6586 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006587#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006588#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6590 return 1;
6591 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006592#endif
6593#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6595 return 1;
6596 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006597#endif
6598#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006599 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6600 return 1;
6601 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006602#endif
6603#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6605 return 1;
6606 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006607#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006608#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6610 return 1;
6611 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006612#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306613#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6614 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6615 return 1;
6616 }
6617#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306618#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6619 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6620 return 1;
6621 }
6622#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006624}
6625
Gilles Peskine449bd832023-01-11 14:50:10 +01006626static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006627{
6628 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 psa_status_t status = psa_hash_setup(&operation, alg);
6630 psa_hash_abort(&operation);
6631 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006632}
6633
Gilles Peskine969c5d62019-01-16 15:53:06 +01006634static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006635 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006637{
Janos Follath5fe19732019-06-20 15:09:30 +01006638 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6639 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006641
Gilles Peskine969c5d62019-01-16 15:53:06 +01006642 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 if (!is_kdf_alg_supported(kdf_alg)) {
6644 return PSA_ERROR_NOT_SUPPORTED;
6645 }
John Durkop07cc04a2020-11-16 22:08:34 -08006646
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006647 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306648 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6650 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306651 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6652 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6653 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306654 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306655 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 if (hash_size == 0) {
6657 return PSA_ERROR_NOT_SUPPORTED;
6658 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006659
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006660 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6661 * we might fail later, which is somewhat unfriendly and potentially
6662 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 psa_status_t status = psa_hash_try_support(hash_alg);
6664 if (status != PSA_SUCCESS) {
6665 return status;
6666 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006667 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006668
Gilles Peskine449bd832023-01-11 14:50:10 +01006669 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6670 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6671 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6672 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006673 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006674#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006675 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006676 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6677 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006678 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006680#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6681 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006682 operation->capacity = 255 * hash_size;
6683 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006684}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006685
Gilles Peskine449bd832023-01-11 14:50:10 +01006686static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006687{
6688#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 if (alg == PSA_ALG_ECDH) {
6690 return PSA_SUCCESS;
6691 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006692#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006693#if defined(PSA_WANT_ALG_FFDH)
6694 if (alg == PSA_ALG_FFDH) {
6695 return PSA_SUCCESS;
6696 }
6697#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006698 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006699 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006700}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006701
6702static int psa_key_derivation_allows_free_form_secret_input(
6703 psa_algorithm_t kdf_alg)
6704{
6705#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6706 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6707 return 0;
6708 }
6709#endif
6710 (void) kdf_alg;
6711 return 1;
6712}
John Durkop07cc04a2020-11-16 22:08:34 -08006713#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006714
Gilles Peskine449bd832023-01-11 14:50:10 +01006715psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6716 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006717{
6718 psa_status_t status;
6719
Gilles Peskine449bd832023-01-11 14:50:10 +01006720 if (operation->alg != 0) {
6721 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006722 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006723
Gilles Peskine449bd832023-01-11 14:50:10 +01006724 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6725 return PSA_ERROR_INVALID_ARGUMENT;
6726 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6727#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6728 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6729 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6730 status = psa_key_agreement_try_support(ka_alg);
6731 if (status != PSA_SUCCESS) {
6732 return status;
6733 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006734 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6735 return PSA_ERROR_INVALID_ARGUMENT;
6736 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006737 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6738#else
6739 return PSA_ERROR_NOT_SUPPORTED;
6740#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6741 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6742#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6743 status = psa_key_derivation_setup_kdf(operation, alg);
6744#else
6745 return PSA_ERROR_NOT_SUPPORTED;
6746#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6747 } else {
6748 return PSA_ERROR_INVALID_ARGUMENT;
6749 }
6750
6751 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006752 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006753 }
6754 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006755}
6756
Przemek Stekiel69c46792022-06-10 12:59:51 +02006757#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006758static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6759 psa_algorithm_t kdf_alg,
6760 psa_key_derivation_step_t step,
6761 const uint8_t *data,
6762 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006763{
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006765 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006767 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006768#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6770 return PSA_ERROR_INVALID_ARGUMENT;
6771 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006772#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 if (hkdf->state != HKDF_STATE_INIT) {
6774 return PSA_ERROR_BAD_STATE;
6775 } else {
6776 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6777 hash_alg,
6778 data, data_length);
6779 if (status != PSA_SUCCESS) {
6780 return status;
6781 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006782 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006784 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006785 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006786#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006788 /* We shouldn't be in different state as HKDF_EXPAND only allows
6789 * two inputs: SECRET (this case) and INFO which does not modify
6790 * the state. It could happen only if the hkdf
6791 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 if (hkdf->state != HKDF_STATE_INIT) {
6793 return PSA_ERROR_BAD_STATE;
6794 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006795
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006796 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6798 return PSA_ERROR_INVALID_ARGUMENT;
6799 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006800
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 memcpy(hkdf->prk, data, data_length);
6802 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006803#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006804 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006805 /* HKDF: If no salt was provided, use an empty salt.
6806 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006808#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6810 return PSA_ERROR_BAD_STATE;
6811 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006812#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6814 hash_alg,
6815 NULL, 0);
6816 if (status != PSA_SUCCESS) {
6817 return status;
6818 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006819 hkdf->state = HKDF_STATE_STARTED;
6820 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 if (hkdf->state != HKDF_STATE_STARTED) {
6822 return PSA_ERROR_BAD_STATE;
6823 }
6824 status = psa_mac_update(&hkdf->hmac,
6825 data, data_length);
6826 if (status != PSA_SUCCESS) {
6827 return status;
6828 }
6829 status = psa_mac_sign_finish(&hkdf->hmac,
6830 hkdf->prk,
6831 sizeof(hkdf->prk),
6832 &data_length);
6833 if (status != PSA_SUCCESS) {
6834 return status;
6835 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006836 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006837
Gilles Peskine2b522db2019-04-12 15:11:49 +02006838 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006839 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006840#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006842 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006844 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006846#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006847 {
6848 /* Block 0 is empty, and the next block will be
6849 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006851 }
6852
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006854 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006855#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6857 return PSA_ERROR_INVALID_ARGUMENT;
6858 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006859#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006860#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6862 hkdf->state == HKDF_STATE_INIT) {
6863 return PSA_ERROR_BAD_STATE;
6864 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006865#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006866 if (hkdf->state == HKDF_STATE_OUTPUT) {
6867 return PSA_ERROR_BAD_STATE;
6868 }
6869 if (hkdf->info_set) {
6870 return PSA_ERROR_BAD_STATE;
6871 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006872 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 if (data_length != 0) {
6874 hkdf->info = mbedtls_calloc(1, data_length);
6875 if (hkdf->info == NULL) {
6876 return PSA_ERROR_INSUFFICIENT_MEMORY;
6877 }
6878 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006879 }
6880 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006882 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006884 }
6885}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006886#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006887
John Durkop07cc04a2020-11-16 22:08:34 -08006888#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6889 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006890static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6891 const uint8_t *data,
6892 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006893{
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6895 return PSA_ERROR_BAD_STATE;
6896 }
Janos Follathf08e2652019-06-13 09:05:41 +01006897
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 if (data_length != 0) {
6899 prf->seed = mbedtls_calloc(1, data_length);
6900 if (prf->seed == NULL) {
6901 return PSA_ERROR_INSUFFICIENT_MEMORY;
6902 }
Janos Follathf08e2652019-06-13 09:05:41 +01006903
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006905 prf->seed_length = data_length;
6906 }
Janos Follathf08e2652019-06-13 09:05:41 +01006907
Gilles Peskine43f958b2020-12-13 14:55:14 +01006908 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006911}
6912
Gilles Peskine449bd832023-01-11 14:50:10 +01006913static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6914 const uint8_t *data,
6915 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006916{
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6918 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6919 return PSA_ERROR_BAD_STATE;
6920 }
Janos Follath81550542019-06-13 14:26:34 +01006921
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 if (data_length != 0) {
6923 prf->secret = mbedtls_calloc(1, data_length);
6924 if (prf->secret == NULL) {
6925 return PSA_ERROR_INSUFFICIENT_MEMORY;
6926 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006927
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006929 prf->secret_length = data_length;
6930 }
Janos Follath81550542019-06-13 14:26:34 +01006931
Gilles Peskine43f958b2020-12-13 14:55:14 +01006932 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006933
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006935}
6936
Gilles Peskine449bd832023-01-11 14:50:10 +01006937static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6938 const uint8_t *data,
6939 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006940{
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6942 return PSA_ERROR_BAD_STATE;
6943 }
Janos Follath63028dd2019-06-13 09:15:47 +01006944
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 if (data_length != 0) {
6946 prf->label = mbedtls_calloc(1, data_length);
6947 if (prf->label == NULL) {
6948 return PSA_ERROR_INSUFFICIENT_MEMORY;
6949 }
Janos Follath63028dd2019-06-13 09:15:47 +01006950
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006952 prf->label_length = data_length;
6953 }
Janos Follath63028dd2019-06-13 09:15:47 +01006954
Gilles Peskine43f958b2020-12-13 14:55:14 +01006955 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006956
Gilles Peskine449bd832023-01-11 14:50:10 +01006957 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006958}
6959
Gilles Peskine449bd832023-01-11 14:50:10 +01006960static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6961 psa_key_derivation_step_t step,
6962 const uint8_t *data,
6963 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006964{
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006966 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006967 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006968 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006970 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006972 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006974 }
6975}
John Durkop07cc04a2020-11-16 22:08:34 -08006976#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6977 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6978
6979#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6980static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6981 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006982 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006983 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006984{
6985 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6987 4 + data_length + prf->other_secret_length :
6988 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006989
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6991 return PSA_ERROR_INVALID_ARGUMENT;
6992 }
John Durkop07cc04a2020-11-16 22:08:34 -08006993
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 uint8_t *pms = mbedtls_calloc(1, pms_len);
6995 if (pms == NULL) {
6996 return PSA_ERROR_INSUFFICIENT_MEMORY;
6997 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006998 uint8_t *cur = pms;
6999
7000 /* pure-PSK:
7001 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08007002 *
7003 * The premaster secret is formed as follows: if the PSK is N octets
7004 * long, concatenate a uint16 with the value N, N zero octets, a second
7005 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02007006 *
7007 * mixed-PSK:
7008 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
7009 * follows: concatenate a uint16 with the length of the other secret,
7010 * the other secret itself, uint16 with the length of PSK, and the
7011 * PSK itself.
7012 * For details please check:
7013 * - RFC 4279, Section 4 for the definition of RSA-PSK,
7014 * - RFC 4279, Section 3 for the definition of DHE-PSK,
7015 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08007016 */
7017
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
7019 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
7020 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
7021 if (prf->other_secret_length != 0) {
7022 memcpy(cur, prf->other_secret, prf->other_secret_length);
7023 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02007024 cur += prf->other_secret_length;
7025 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 } else {
7027 *cur++ = MBEDTLS_BYTE_1(data_length);
7028 *cur++ = MBEDTLS_BYTE_0(data_length);
7029 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02007030 cur += data_length;
7031 }
7032
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 *cur++ = MBEDTLS_BYTE_1(data_length);
7034 *cur++ = MBEDTLS_BYTE_0(data_length);
7035 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08007036 cur += data_length;
7037
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007038 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08007039
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007040 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08007042}
Janos Follath6660f0e2019-06-17 08:44:03 +01007043
Przemek Stekiele47201b2022-04-19 13:53:28 +02007044static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
7045 psa_tls12_prf_key_derivation_t *prf,
7046 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02007048{
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
7050 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007051 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007052
7053 if (data_length != 0) {
7054 prf->other_secret = mbedtls_calloc(1, data_length);
7055 if (prf->other_secret == NULL) {
7056 return PSA_ERROR_INSUFFICIENT_MEMORY;
7057 }
7058
7059 memcpy(prf->other_secret, data, data_length);
7060 prf->other_secret_length = data_length;
7061 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007062 prf->other_secret_length = 0;
7063 }
7064
7065 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
7066
Gilles Peskine449bd832023-01-11 14:50:10 +01007067 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007068}
7069
Janos Follath6660f0e2019-06-17 08:44:03 +01007070static psa_status_t psa_tls12_prf_psk_to_ms_input(
7071 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01007072 psa_key_derivation_step_t step,
7073 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01007075{
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007077 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 return psa_tls12_prf_psk_to_ms_set_key(prf,
7079 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007080 break;
7081 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007082 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
7083 data,
7084 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007085 break;
7086 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007088 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01007089
Przemek Stekiele47201b2022-04-19 13:53:28 +02007090 }
Janos Follath6660f0e2019-06-17 08:44:03 +01007091}
John Durkop07cc04a2020-11-16 22:08:34 -08007092#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007093
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007094#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
7095static psa_status_t psa_tls12_ecjpake_to_pms_input(
7096 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04007097 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007098 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007099 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007100{
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
7102 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
7103 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04007104 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007105
7106 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 if (data[0] != 0x04) {
7108 return PSA_ERROR_INVALID_ARGUMENT;
7109 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007110
7111 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007113
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007115}
7116#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307117
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307118#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307119static psa_status_t psa_pbkdf2_set_input_cost(
7120 psa_pbkdf2_key_derivation_t *pbkdf2,
7121 psa_key_derivation_step_t step,
7122 uint64_t data)
7123{
7124 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
7125 return PSA_ERROR_INVALID_ARGUMENT;
7126 }
7127
7128 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
7129 return PSA_ERROR_BAD_STATE;
7130 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307131
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307132 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307133 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307134 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307135
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307136 if (data == 0) {
7137 return PSA_ERROR_INVALID_ARGUMENT;
7138 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307139
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307140 pbkdf2->input_cost = data;
7141 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
7142
7143 return PSA_SUCCESS;
7144}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307145
7146static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
7147 const uint8_t *data,
7148 size_t data_length)
7149{
Gilles Peskineead17662023-08-20 22:02:51 +02007150 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
7151 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
7152 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
7153 /* Appending to existing salt. No state change. */
7154 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307155 return PSA_ERROR_BAD_STATE;
7156 }
7157
Gilles Peskineca57d782023-07-20 19:08:06 +02007158 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02007159 /* Appending an empty string, nothing to do. */
7160 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307161 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05307162
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307163 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
7164 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307165 return PSA_ERROR_INSUFFICIENT_MEMORY;
7166 }
7167
Gilles Peskineead17662023-08-20 22:02:51 +02007168 if (pbkdf2->salt_length != 0) {
7169 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
7170 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307171 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307172 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307173 mbedtls_free(pbkdf2->salt);
7174 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307175 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307176 return PSA_SUCCESS;
7177}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307178
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307179#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307180static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307181 const uint8_t *input,
7182 size_t input_len,
7183 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05307184 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307185{
7186 psa_status_t status = PSA_SUCCESS;
7187 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007188 return psa_hash_compute(hash_alg, input, input_len, output,
7189 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
7190 } else if (input_len > 0) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307191 memcpy(output, input, input_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307192 }
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007193 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307194 return status;
7195}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307196#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307197
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307198#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307199static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
7200 size_t input_len,
7201 uint8_t *output,
7202 size_t *output_len)
7203{
7204 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307205 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307206 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05307207 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307208 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
7209 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
7210 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307211 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05307212 * mac_size as the driver function sets mac_output_length = mac_size
7213 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307214 status = psa_driver_wrapper_mac_compute(&attributes,
7215 zeros, sizeof(zeros),
7216 PSA_ALG_CMAC, input, input_len,
7217 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307218 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7219 128U,
7220 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307221 output_len);
7222 } else {
7223 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307224 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307225 }
7226 return status;
7227}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307228#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307229
7230static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307231 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307232 const uint8_t *data,
7233 size_t data_length)
7234{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307235 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307236 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7237 return PSA_ERROR_BAD_STATE;
7238 }
7239
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307240#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307241 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7242 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7243 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7244 pbkdf2->password,
7245 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307246 } else
7247#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7248#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7249 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307250 status = psa_pbkdf2_cmac_set_password(data, data_length,
7251 pbkdf2->password,
7252 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307253 } else
7254#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7255 {
7256 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307257 }
7258
7259 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7260
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307261 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307262}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307263
7264static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307265 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307266 psa_key_derivation_step_t step,
7267 const uint8_t *data,
7268 size_t data_length)
7269{
7270 switch (step) {
7271 case PSA_KEY_DERIVATION_INPUT_SALT:
7272 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7273 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307274 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307275 default:
7276 return PSA_ERROR_INVALID_ARGUMENT;
7277 }
7278}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307279#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307280
Gilles Peskineb8965192019-09-24 16:21:10 +02007281/** Check whether the given key type is acceptable for the given
7282 * input step of a key derivation.
7283 *
7284 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7285 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7286 * Both secret and non-secret inputs can alternatively have the type
7287 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7288 * that the input was passed as a buffer rather than via a key object.
7289 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007290static int psa_key_derivation_check_input_type(
7291 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007292 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007293{
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007295 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 if (key_type == PSA_KEY_TYPE_DERIVE) {
7297 return PSA_SUCCESS;
7298 }
7299 if (key_type == PSA_KEY_TYPE_NONE) {
7300 return PSA_SUCCESS;
7301 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007302 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007303 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 if (key_type == PSA_KEY_TYPE_DERIVE) {
7305 return PSA_SUCCESS;
7306 }
7307 if (key_type == PSA_KEY_TYPE_NONE) {
7308 return PSA_SUCCESS;
7309 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007310 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007311 case PSA_KEY_DERIVATION_INPUT_LABEL:
7312 case PSA_KEY_DERIVATION_INPUT_SALT:
7313 case PSA_KEY_DERIVATION_INPUT_INFO:
7314 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7316 return PSA_SUCCESS;
7317 }
7318 if (key_type == PSA_KEY_TYPE_NONE) {
7319 return PSA_SUCCESS;
7320 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007321 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307322 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7323 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7324 return PSA_SUCCESS;
7325 }
7326 if (key_type == PSA_KEY_TYPE_DERIVE) {
7327 return PSA_SUCCESS;
7328 }
7329 if (key_type == PSA_KEY_TYPE_NONE) {
7330 return PSA_SUCCESS;
7331 }
7332 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007333 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007335}
7336
Janos Follathb80a94e2019-06-12 15:54:46 +01007337static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007338 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007339 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007340 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007341 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007342 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007343{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007344 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007345 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007346
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 status = psa_key_derivation_check_input_type(step, key_type);
7348 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007349 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007350 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007351
Przemek Stekiel69c46792022-06-10 12:59:51 +02007352#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7354 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7355 step, data, data_length);
7356 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007357#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007358#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7360 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7361 step, data, data_length);
7362 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007363#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7364#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7366 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7367 step, data, data_length);
7368 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007369#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007370#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007371 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007372 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7374 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007375#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307376#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307377 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307378 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7379 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307380 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307381#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007382 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007383 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007384 (void) data;
7385 (void) data_length;
7386 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007388 }
7389
Gilles Peskine224b0d62019-09-23 18:13:17 +02007390exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 if (status != PSA_SUCCESS) {
7392 psa_key_derivation_abort(operation);
7393 }
7394 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007395}
7396
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307397static psa_status_t psa_key_derivation_input_integer_internal(
7398 psa_key_derivation_operation_t *operation,
7399 psa_key_derivation_step_t step,
7400 uint64_t value)
7401{
7402 psa_status_t status;
7403 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7404
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307405#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307406 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307407 status = psa_pbkdf2_set_input_cost(
7408 &operation->ctx.pbkdf2, step, value);
7409 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307410#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307411 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307412 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307413 (void) value;
7414 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307415 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307416 }
7417
7418 if (status != PSA_SUCCESS) {
7419 psa_key_derivation_abort(operation);
7420 }
7421 return status;
7422}
7423
Janos Follath51f4a0f2019-06-14 11:35:55 +01007424psa_status_t psa_key_derivation_input_bytes(
7425 psa_key_derivation_operation_t *operation,
7426 psa_key_derivation_step_t step,
Ryan Everettd1e398c2024-01-19 14:46:00 +00007427 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007429{
Ryan Everettd1e398c2024-01-19 14:46:00 +00007430 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7431 LOCAL_INPUT_DECLARE(data_external, data);
7432
7433 LOCAL_INPUT_ALLOC(data_external, data_length, data);
7434
7435 status = psa_key_derivation_input_internal(operation, step,
7436 PSA_KEY_TYPE_NONE,
7437 data, data_length);
Ryan Everettb41c3c92024-01-25 11:56:35 +00007438#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everettd1e398c2024-01-19 14:46:00 +00007439exit:
Ryan Everettb41c3c92024-01-25 11:56:35 +00007440#endif
Ryan Everettd1e398c2024-01-19 14:46:00 +00007441 LOCAL_INPUT_FREE(data_external, data);
7442 return status;
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007443}
7444
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307445psa_status_t psa_key_derivation_input_integer(
7446 psa_key_derivation_operation_t *operation,
7447 psa_key_derivation_step_t step,
7448 uint64_t value)
7449{
7450 return psa_key_derivation_input_integer_internal(operation, step, value);
7451}
7452
Janos Follath51f4a0f2019-06-14 11:35:55 +01007453psa_status_t psa_key_derivation_input_key(
7454 psa_key_derivation_operation_t *operation,
7455 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007457{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007458 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007459 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007460 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007461
Ronald Cron5c522922020-11-14 16:35:34 +01007462 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7464 if (status != PSA_SUCCESS) {
7465 psa_key_derivation_abort(operation);
7466 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007467 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007468
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307469 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7470 * permission to output to a key object. */
7471 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7472 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007473 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007475
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 status = psa_key_derivation_input_internal(operation,
7477 step, slot->attr.type,
7478 slot->key.data,
7479 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007480
Ryan Everett1b70a072024-01-04 10:32:49 +00007481 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007482
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007484}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007485
7486
7487
7488/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007489/* Key agreement */
7490/****************************************************************/
7491
Gilles Peskine449bd832023-01-11 14:50:10 +01007492psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7493 const uint8_t *key_buffer,
7494 size_t key_buffer_size,
7495 psa_algorithm_t alg,
7496 const uint8_t *peer_key,
7497 size_t peer_key_length,
7498 uint8_t *shared_secret,
7499 size_t shared_secret_size,
7500 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007501{
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007503#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007504 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7506 key_buffer_size, alg,
7507 peer_key, peer_key_length,
7508 shared_secret,
7509 shared_secret_size,
7510 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007511#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007512
7513#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7514 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007515 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007516 peer_key,
7517 peer_key_length,
7518 key_buffer,
7519 key_buffer_size,
7520 shared_secret,
7521 shared_secret_size,
7522 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007523#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7524
Gilles Peskine01d718c2018-09-18 12:01:02 +02007525 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007526 (void) attributes;
7527 (void) key_buffer;
7528 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007529 (void) peer_key;
7530 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007531 (void) shared_secret;
7532 (void) shared_secret_size;
7533 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007535 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007536}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007537
Aditya Deshpande17845b82022-10-13 17:21:01 +01007538/** Internal function for raw key agreement
7539 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007540 * to the driver's implementation if a driver is present.
7541 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007542 * (psa_key_agreement_raw_builtin).
7543 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007544static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7545 psa_key_slot_t *private_key,
7546 const uint8_t *peer_key,
7547 size_t peer_key_length,
7548 uint8_t *shared_secret,
7549 size_t shared_secret_size,
7550 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007551{
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7553 return PSA_ERROR_NOT_SUPPORTED;
7554 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007555
7556 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007558 };
7559
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 return psa_driver_wrapper_key_agreement(&attributes,
7561 private_key->key.data,
7562 private_key->key.bytes, alg,
7563 peer_key, peer_key_length,
7564 shared_secret,
7565 shared_secret_size,
7566 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007567}
7568
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007569/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007570 * to potentially free embedded data structures and wipe confidential data.
7571 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007572static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7573 psa_key_derivation_step_t step,
7574 psa_key_slot_t *private_key,
7575 const uint8_t *peer_key,
7576 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007577{
7578 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007579 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007580 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007582
7583 /* Step 1: run the secret agreement algorithm to generate the shared
7584 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 status = psa_key_agreement_raw_internal(ka_alg,
7586 private_key,
7587 peer_key, peer_key_length,
7588 shared_secret,
7589 sizeof(shared_secret),
7590 &shared_secret_length);
7591 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007592 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007594
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007595 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007596 * the shared secret. A shared secret is permitted wherever a key
7597 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 status = psa_key_derivation_input_internal(operation, step,
7599 PSA_KEY_TYPE_DERIVE,
7600 shared_secret,
7601 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007602exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7604 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007605}
7606
Gilles Peskine449bd832023-01-11 14:50:10 +01007607psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7608 psa_key_derivation_step_t step,
7609 mbedtls_svc_key_id_t private_key,
Thomas Daubney9739ac02024-02-15 13:15:47 +00007610 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007612{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007613 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007614 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007615 psa_key_slot_t *slot;
Thomas Daubney9739ac02024-02-15 13:15:47 +00007616 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007617
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7619 return PSA_ERROR_INVALID_ARGUMENT;
7620 }
Ronald Cron5c522922020-11-14 16:35:34 +01007621 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7623 if (status != PSA_SUCCESS) {
7624 return status;
7625 }
Thomas Daubney9739ac02024-02-15 13:15:47 +00007626
7627 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key)
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 status = psa_key_agreement_internal(operation, step,
7629 slot,
7630 peer_key, peer_key_length);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007631
Thomas Daubney50f58fc2024-02-15 14:24:03 +00007632#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney9739ac02024-02-15 13:15:47 +00007633exit:
Thomas Daubney50f58fc2024-02-15 14:24:03 +00007634#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 if (status != PSA_SUCCESS) {
7636 psa_key_derivation_abort(operation);
7637 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007638 /* If a private key has been added as SECRET, we allow the derived
7639 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007641 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007643 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007644
Ryan Everett1b70a072024-01-04 10:32:49 +00007645 unlock_status = psa_unregister_read(slot);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007646 LOCAL_INPUT_FREE(peer_key_external, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007648}
7649
Gilles Peskine449bd832023-01-11 14:50:10 +01007650psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7651 mbedtls_svc_key_id_t private_key,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007652 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 size_t peer_key_length,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007654 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 size_t output_size,
7656 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007657{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007658 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007659 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007660 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007661 size_t expected_length;
Thomas Daubney81899ab2024-02-15 12:57:26 +00007662 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
7663 LOCAL_OUTPUT_DECLARE(output_external, output);
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007664 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007665
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007667 status = PSA_ERROR_INVALID_ARGUMENT;
7668 goto exit;
7669 }
Ronald Cron5c522922020-11-14 16:35:34 +01007670 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7672 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007673 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007675
Gilles Peskine3e561302022-04-14 00:17:15 +02007676 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7677 * for the output size. The PSA specification only guarantees that this
7678 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7679 * but it might be nice to allow smaller buffers if the output fits.
7680 * At the time of writing this comment, with only ECDH implemented,
7681 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7682 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7683 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007684 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7686 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007687 status = PSA_ERROR_BUFFER_TOO_SMALL;
7688 goto exit;
7689 }
7690
Thomas Daubney81899ab2024-02-15 12:57:26 +00007691 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 status = psa_key_agreement_raw_internal(alg, slot,
7693 peer_key, peer_key_length,
7694 output, output_size,
7695 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007696
7697exit:
Thomas Daubney5390aca2024-02-22 11:06:04 +00007698 /* Check for successful allocation of output,
7699 * with an unsuccessful status. */
Thomas Daubney0576a6a2024-02-21 15:15:00 +00007700 if (output != NULL && status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007701 /* If an error happens and is not handled properly, the output
7702 * may be used as a key to protect sensitive data. Arrange for such
7703 * a key to be random, which is likely to result in decryption or
7704 * verification errors. This is better than filling the buffer with
7705 * some constant data such as zeros, which would result in the data
7706 * being protected with a reproducible, easily knowable key.
7707 */
David Horstmann6e99bb22024-02-06 15:27:49 +00007708 psa_generate_random_internal(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007709 *output_length = output_size;
7710 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007711
Thomas Daubney5390aca2024-02-22 11:06:04 +00007712 if (output == NULL) {
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007713 /* output allocation failed. */
7714 *output_length = 0;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007715 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007716
Ryan Everett1b70a072024-01-04 10:32:49 +00007717 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007718
Thomas Daubney81899ab2024-02-15 12:57:26 +00007719 LOCAL_INPUT_FREE(peer_key_external, peer_key);
7720 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007722}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007723
7724
7725/****************************************************************/
7726/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007727/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007728
Gilles Peskine672a7712023-04-28 21:00:28 +02007729#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7730#include "entropy_poll.h"
7731#endif
7732
Gilles Peskine30524eb2020-11-13 17:02:26 +01007733/** Initialize the PSA random generator.
7734 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007735static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007736{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007737#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007738 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007739#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7740
Gilles Peskine30524eb2020-11-13 17:02:26 +01007741 /* Set default configuration if
7742 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007744 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 }
7746 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007747 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007748 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007749
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007751#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7752 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7753 /* The PSA entropy injection feature depends on using NV seed as an entropy
7754 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007755 mbedtls_entropy_add_source(&rng->entropy,
7756 mbedtls_nv_seed_poll, NULL,
7757 MBEDTLS_ENTROPY_BLOCK_SIZE,
7758 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007759#endif
7760
Gilles Peskine449bd832023-01-11 14:50:10 +01007761 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007762#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007763}
7764
7765/** Deinitialize the PSA random generator.
7766 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007767static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007768{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007769#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007771#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007772 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7773 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007774#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007775}
7776
7777/** Seed the PSA random generator.
7778 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007779static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007780{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007781#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7782 /* Do nothing: the external RNG seeds itself. */
7783 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007785#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007786 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7788 drbg_seed, sizeof(drbg_seed) - 1);
7789 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007790#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007791}
7792
David Horstmann6e99bb22024-02-06 15:27:49 +00007793psa_status_t psa_generate_random(uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007795{
David Horstmann6e99bb22024-02-06 15:27:49 +00007796 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007797
David Horstmann6e99bb22024-02-06 15:27:49 +00007798 LOCAL_OUTPUT_DECLARE(output_external, output);
7799 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007800
David Horstmann6e99bb22024-02-06 15:27:49 +00007801 status = psa_generate_random_internal(output, output_size);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007802
David Horstmanne097bbd2024-02-28 14:17:10 +00007803#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
David Horstmann6e99bb22024-02-06 15:27:49 +00007804exit:
David Horstmanne097bbd2024-02-28 14:17:10 +00007805#endif
David Horstmann6e99bb22024-02-06 15:27:49 +00007806 LOCAL_OUTPUT_FREE(output_external, output);
7807 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007808}
7809
Gilles Peskine8814fc42020-12-14 15:33:44 +01007810/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007811 *
7812 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7813 * `psa_generate_random(...)`. The state parameter is ignored since the
7814 * PSA API doesn't support passing an explicit state.
7815 *
7816 * In the non-external case, psa_generate_random() calls an
7817 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7818 * and semantics as mbedtls_psa_get_random(). As an optimization,
7819 * instead of doing this back-and-forth between the PSA API and the
7820 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7821 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007822 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007823#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7824int mbedtls_psa_get_random(void *p_rng,
7825 unsigned char *output,
7826 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007827{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007828 /* This function takes a pointer to the RNG state because that's what
7829 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7830 * its own state internally and doesn't let the caller access that state.
7831 * So we just ignore the state parameter, and in practice we'll pass
7832 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007833 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007834 psa_status_t status = psa_generate_random(output, output_size);
7835 if (status == PSA_SUCCESS) {
7836 return 0;
7837 } else {
7838 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7839 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007840}
7841#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7842
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007843#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007844psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7845 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007846{
Gilles Peskine449bd832023-01-11 14:50:10 +01007847 if (global_data.initialized) {
7848 return PSA_ERROR_NOT_PERMITTED;
7849 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007850
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7852 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7853 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7854 return PSA_ERROR_INVALID_ARGUMENT;
7855 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007856
Gilles Peskine449bd832023-01-11 14:50:10 +01007857 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007858}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007859#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007860
Ronald Cron3772afe2021-02-08 16:10:05 +01007861/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007862 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007863 * \param type The key type
7864 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007865 *
7866 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007867 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007868 * \retval #PSA_ERROR_INVALID_ARGUMENT
7869 * The size in bits of the key is not valid.
7870 * \retval #PSA_ERROR_NOT_SUPPORTED
7871 * The type and/or the size in bits of the key or the combination of
7872 * the two is not supported.
7873 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007874static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007875 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007876{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007877 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007878
Gilles Peskine449bd832023-01-11 14:50:10 +01007879 if (key_type_is_raw_bytes(type)) {
7880 status = psa_validate_unstructured_key_bit_size(type, bits);
7881 if (status != PSA_SUCCESS) {
7882 return status;
7883 }
7884 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007885#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7887 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7888 return PSA_ERROR_NOT_SUPPORTED;
7889 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007890 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007891 return PSA_ERROR_NOT_SUPPORTED;
7892 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007893
Ronald Cron01b2aba2020-10-05 09:42:02 +02007894 /* Accept only byte-aligned keys, for the same reasons as
7895 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 if (bits % 8 != 0) {
7897 return PSA_ERROR_NOT_SUPPORTED;
7898 }
7899 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007900#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007901
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007902#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007904 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 return PSA_SUCCESS;
7906 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007907#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007908
Valerio Settia55f0422023-07-10 15:34:41 +02007909#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007910 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007911 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007912 return PSA_ERROR_NOT_SUPPORTED;
7913 }
7914 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007915#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007916 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007917 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007918 }
7919
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007921}
7922
Ronald Cron55ed0592020-10-05 10:30:40 +02007923psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007924 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007925 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007926{
7927 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007928 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007929
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 if ((attributes->domain_parameters == NULL) &&
7931 (attributes->domain_parameters_size != 0)) {
7932 return PSA_ERROR_INVALID_ARGUMENT;
7933 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007934
Gilles Peskine449bd832023-01-11 14:50:10 +01007935 if (key_type_is_raw_bytes(type)) {
7936 status = psa_generate_random(key_buffer, key_buffer_size);
7937 if (status != PSA_SUCCESS) {
7938 return status;
7939 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007940
David Brown12ca5032021-02-11 11:02:00 -07007941#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 if (type == PSA_KEY_TYPE_DES) {
7943 psa_des_set_key_parity(key_buffer, key_buffer_size);
7944 }
David Brown8107e312021-02-12 08:08:46 -07007945#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007946 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007947
Valerio Setti76df8c12023-07-11 14:11:28 +02007948#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007949 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7950 return mbedtls_psa_rsa_generate_key(attributes,
7951 key_buffer,
7952 key_buffer_size,
7953 key_buffer_length);
7954 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007955#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007956
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007957#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7959 return mbedtls_psa_ecp_generate_key(attributes,
7960 key_buffer,
7961 key_buffer_size,
7962 key_buffer_length);
7963 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007964#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007965
Valerio Settia55f0422023-07-10 15:34:41 +02007966#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007967 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7968 return mbedtls_psa_ffdh_generate_key(attributes,
7969 key_buffer,
7970 key_buffer_size,
7971 key_buffer_length);
7972 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007973#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007974 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 (void) key_buffer_length;
7976 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007977 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007978
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007980}
Darryl Green0c6575a2018-11-07 16:05:30 +00007981
Gilles Peskine449bd832023-01-11 14:50:10 +01007982psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7983 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007984{
7985 psa_status_t status;
7986 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007987 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007988 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007989
Ronald Cron81709fc2020-11-14 12:10:32 +01007990 *key = MBEDTLS_SVC_KEY_ID_INIT;
7991
Gilles Peskine0f84d622019-09-12 19:03:13 +02007992 /* Reject any attempt to create a zero-length key so that we don't
7993 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 if (psa_get_key_bits(attributes) == 0) {
7995 return PSA_ERROR_INVALID_ARGUMENT;
7996 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007997
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007998 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
8000 return PSA_ERROR_INVALID_ARGUMENT;
8001 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02008002
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
8004 &slot, &driver);
8005 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02008006 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 }
Gilles Peskine11792082019-08-06 18:36:36 +02008008
Ronald Cron977c2472020-10-13 08:32:21 +02008009 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05308010 * storage ( thus not in the case of generating a key in a secure element
8011 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
8012 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 if (slot->key.data == NULL) {
8014 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
8015 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008016 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 attributes->core.type, attributes->core.bits);
8018 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008019 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 }
Ronald Cron3772afe2021-02-08 16:10:05 +01008021
8022 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 attributes->core.type,
8024 attributes->core.bits);
8025 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02008026 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 attributes, &key_buffer_size);
8028 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008029 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 }
Ronald Cron977c2472020-10-13 08:32:21 +02008031 }
Ronald Cron977c2472020-10-13 08:32:21 +02008032
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
8034 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02008035 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008036 }
Ronald Cron977c2472020-10-13 08:32:21 +02008037 }
8038
Gilles Peskine449bd832023-01-11 14:50:10 +01008039 status = psa_driver_wrapper_generate_key(attributes,
8040 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02008041
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 if (status != PSA_SUCCESS) {
8043 psa_remove_key_data_from_memory(slot);
8044 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02008045
Gilles Peskine11792082019-08-06 18:36:36 +02008046exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 if (status == PSA_SUCCESS) {
8048 status = psa_finish_key_creation(slot, driver, key);
8049 }
8050 if (status != PSA_SUCCESS) {
8051 psa_fail_key_creation(slot, driver);
8052 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02008053
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008055}
8056
Gilles Peskinee59236f2018-01-27 23:32:46 +01008057/****************************************************************/
8058/* Module setup */
8059/****************************************************************/
8060
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008061#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01008062psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 void (* entropy_init)(mbedtls_entropy_context *ctx),
8064 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01008065{
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
8067 return PSA_ERROR_BAD_STATE;
8068 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01008069 global_data.rng.entropy_init = entropy_init;
8070 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01008071 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01008072}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008073#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01008074
Gilles Peskine449bd832023-01-11 14:50:10 +01008075void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008076{
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 psa_wipe_all_key_slots();
8078 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
8079 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01008080 }
8081 /* Wipe all remaining data, including configuration.
8082 * In particular, this sets all state indicator to the value
8083 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02008085
8086 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01008088}
8089
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008090#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
8091/** Recover a transaction that was interrupted by a power failure.
8092 *
8093 * This function is called during initialization, before psa_crypto_init()
8094 * returns. If this function returns a failure status, the initialization
8095 * fails.
8096 */
8097static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008099{
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008101 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
8102 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 /* TODO - fall through to the failure case until this
8104 * is implemented.
8105 * https://github.com/ARMmbed/mbed-crypto/issues/218
8106 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008107 default:
8108 /* We found an unsupported transaction in the storage.
8109 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008111 }
8112}
8113#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
8114
Gilles Peskine449bd832023-01-11 14:50:10 +01008115psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008116{
Gilles Peskine66fb1262018-12-10 16:29:04 +01008117 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008118
Gilles Peskinec6b69072018-11-20 21:42:52 +01008119 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 if (global_data.initialized != 0) {
8121 return PSA_SUCCESS;
8122 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008123
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01008124 /* Init drivers */
8125 status = psa_driver_wrapper_init();
8126 if (status != PSA_SUCCESS) {
8127 goto exit;
8128 }
8129 global_data.drivers_initialized = 1;
8130
Valerio Setti402cfba2023-11-13 10:24:32 +01008131 status = psa_initialize_key_slots();
8132 if (status != PSA_SUCCESS) {
8133 goto exit;
8134 }
8135
Gilles Peskine30524eb2020-11-13 17:02:26 +01008136 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008137 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01008138 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008139 status = mbedtls_psa_random_seed(&global_data.rng);
8140 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01008141 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01008143 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008144
Gilles Peskine4b734222019-07-24 15:56:31 +02008145#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 status = psa_crypto_load_transaction();
8147 if (status == PSA_SUCCESS) {
8148 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
8149 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008150 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 }
8152 status = psa_crypto_stop_transaction();
8153 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02008154 /* There's no transaction to complete. It's all good. */
8155 status = PSA_SUCCESS;
8156 }
Gilles Peskine4b734222019-07-24 15:56:31 +02008157#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02008158
Gilles Peskinec6b69072018-11-20 21:42:52 +01008159 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01008160 global_data.initialized = 1;
8161
8162exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008163 if (status != PSA_SUCCESS) {
8164 mbedtls_psa_crypto_free();
8165 }
8166 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008167}
8168
Yanray Wangffc3c482023-07-11 12:01:04 +08008169#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008170psa_status_t psa_crypto_driver_pake_get_password_len(
8171 const psa_crypto_driver_pake_inputs_t *inputs,
8172 size_t *password_len)
8173{
8174 if (inputs->password_len == 0) {
8175 return PSA_ERROR_BAD_STATE;
8176 }
8177
8178 *password_len = inputs->password_len;
8179
8180 return PSA_SUCCESS;
8181}
8182
8183psa_status_t psa_crypto_driver_pake_get_password(
8184 const psa_crypto_driver_pake_inputs_t *inputs,
8185 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
8186{
8187 if (inputs->password_len == 0) {
8188 return PSA_ERROR_BAD_STATE;
8189 }
8190
8191 if (buffer_size < inputs->password_len) {
8192 return PSA_ERROR_BUFFER_TOO_SMALL;
8193 }
8194
8195 memcpy(buffer, inputs->password, inputs->password_len);
8196 *buffer_length = inputs->password_len;
8197
8198 return PSA_SUCCESS;
8199}
8200
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008201psa_status_t psa_crypto_driver_pake_get_user_len(
8202 const psa_crypto_driver_pake_inputs_t *inputs,
8203 size_t *user_len)
8204{
8205 if (inputs->user_len == 0) {
8206 return PSA_ERROR_BAD_STATE;
8207 }
8208
8209 *user_len = inputs->user_len;
8210
8211 return PSA_SUCCESS;
8212}
8213
8214psa_status_t psa_crypto_driver_pake_get_user(
8215 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008216 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008217{
8218 if (inputs->user_len == 0) {
8219 return PSA_ERROR_BAD_STATE;
8220 }
8221
Przemek Stekielc0e62502023-03-14 11:49:36 +01008222 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008223 return PSA_ERROR_BUFFER_TOO_SMALL;
8224 }
8225
Przemek Stekielc0e62502023-03-14 11:49:36 +01008226 memcpy(user_id, inputs->user, inputs->user_len);
8227 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008228
8229 return PSA_SUCCESS;
8230}
8231
8232psa_status_t psa_crypto_driver_pake_get_peer_len(
8233 const psa_crypto_driver_pake_inputs_t *inputs,
8234 size_t *peer_len)
8235{
8236 if (inputs->peer_len == 0) {
8237 return PSA_ERROR_BAD_STATE;
8238 }
8239
8240 *peer_len = inputs->peer_len;
8241
8242 return PSA_SUCCESS;
8243}
8244
8245psa_status_t psa_crypto_driver_pake_get_peer(
8246 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008247 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008248{
8249 if (inputs->peer_len == 0) {
8250 return PSA_ERROR_BAD_STATE;
8251 }
8252
Przemek Stekielc0e62502023-03-14 11:49:36 +01008253 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008254 return PSA_ERROR_BUFFER_TOO_SMALL;
8255 }
8256
Przemek Stekielc0e62502023-03-14 11:49:36 +01008257 memcpy(peer_id, inputs->peer, inputs->peer_len);
8258 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008259
8260 return PSA_SUCCESS;
8261}
8262
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008263psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8264 const psa_crypto_driver_pake_inputs_t *inputs,
8265 psa_pake_cipher_suite_t *cipher_suite)
8266{
8267 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8268 return PSA_ERROR_BAD_STATE;
8269 }
8270
8271 *cipher_suite = inputs->cipher_suite;
8272
8273 return PSA_SUCCESS;
8274}
8275
Neil Armstronga7d08c32022-06-01 18:21:20 +02008276psa_status_t psa_pake_setup(
8277 psa_pake_operation_t *operation,
8278 const psa_pake_cipher_suite_t *cipher_suite)
8279{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008280 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008281
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008282 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008283 status = PSA_ERROR_BAD_STATE;
8284 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008285 }
8286
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008287 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008288 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008289 status = PSA_ERROR_INVALID_ARGUMENT;
8290 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008291 }
8292
Przemek Stekiel51eac532022-12-07 11:04:51 +01008293 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8294
Przemek Stekiele12ed362022-12-21 12:54:46 +01008295 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008296 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8297 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008298 operation->data.inputs.cipher_suite = *cipher_suite;
8299
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008300#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008301 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008302 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008303 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008304
David Horstmann16f01512023-06-14 17:21:07 +01008305 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008306 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008307 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008308#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008309 {
8310 status = PSA_ERROR_NOT_SUPPORTED;
8311 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008312 }
8313
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008314 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8315
Przemek Stekiel51eac532022-12-07 11:04:51 +01008316 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008317exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008318 psa_pake_abort(operation);
8319 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008320}
8321
8322psa_status_t psa_pake_set_password_key(
8323 psa_pake_operation_t *operation,
8324 mbedtls_svc_key_id_t password)
8325{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008326 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008327 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8328 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008329 psa_key_attributes_t attributes;
8330 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008331
Przemek Stekiel51eac532022-12-07 11:04:51 +01008332 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008333 status = PSA_ERROR_BAD_STATE;
8334 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008335 }
8336
Przemek Stekiel6c764412022-11-22 14:05:12 +01008337 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8338 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008339 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008340 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008341 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008342 }
8343
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008344 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008345 .core = slot->attr
8346 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008347
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008348 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008349
Przemek Stekiel51eac532022-12-07 11:04:51 +01008350 if (type != PSA_KEY_TYPE_PASSWORD &&
8351 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8352 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008353 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008354 }
8355
Przemek Stekiel51eac532022-12-07 11:04:51 +01008356 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8357 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008358 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008359 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008360 }
8361
8362 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8363 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008364 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008365exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008366 if (status != PSA_SUCCESS) {
8367 psa_pake_abort(operation);
8368 }
Ryan Everett1b70a072024-01-04 10:32:49 +00008369 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008370 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008371}
8372
8373psa_status_t psa_pake_set_user(
8374 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008375 const uint8_t *user_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008376 size_t user_id_len)
8377{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008378 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008379 LOCAL_INPUT_DECLARE(user_id_external, user_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008380
8381 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008382 status = PSA_ERROR_BAD_STATE;
8383 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008384 }
8385
Przemek Stekiel51eac532022-12-07 11:04:51 +01008386 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008387 status = PSA_ERROR_INVALID_ARGUMENT;
8388 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008389 }
8390
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008391 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008392 status = PSA_ERROR_BAD_STATE;
8393 goto exit;
8394 }
8395
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008396 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8397 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008398 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8399 goto exit;
8400 }
8401
David Horstmann4f534ae2024-01-22 17:35:59 +00008402 LOCAL_INPUT_ALLOC(user_id_external, user_id_len, user_id);
8403
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008404 memcpy(operation->data.inputs.user, user_id, user_id_len);
8405 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008406
David Horstmann4f534ae2024-01-22 17:35:59 +00008407 status = PSA_SUCCESS;
8408
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008409exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008410 LOCAL_INPUT_FREE(user_id_external, user_id);
8411 if (status != PSA_SUCCESS) {
8412 psa_pake_abort(operation);
8413 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008414 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008415}
8416
8417psa_status_t psa_pake_set_peer(
8418 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008419 const uint8_t *peer_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008420 size_t peer_id_len)
8421{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008422 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008423 LOCAL_INPUT_DECLARE(peer_id_external, peer_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008424
8425 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008426 status = PSA_ERROR_BAD_STATE;
8427 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008428 }
8429
Przemek Stekiel51eac532022-12-07 11:04:51 +01008430 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008431 status = PSA_ERROR_INVALID_ARGUMENT;
8432 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008433 }
8434
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008435 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008436 status = PSA_ERROR_BAD_STATE;
8437 goto exit;
8438 }
8439
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008440 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8441 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008442 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8443 goto exit;
8444 }
8445
David Horstmann4f534ae2024-01-22 17:35:59 +00008446 LOCAL_INPUT_ALLOC(peer_id_external, peer_id_len, peer_id);
8447
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008448 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8449 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008450
David Horstmann4f534ae2024-01-22 17:35:59 +00008451 status = PSA_SUCCESS;
8452
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008453exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008454 LOCAL_INPUT_FREE(peer_id_external, peer_id);
8455 if (status != PSA_SUCCESS) {
8456 psa_pake_abort(operation);
8457 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008458 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008459}
8460
8461psa_status_t psa_pake_set_role(
8462 psa_pake_operation_t *operation,
8463 psa_pake_role_t role)
8464{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008465 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008466
Przemek Stekiel51eac532022-12-07 11:04:51 +01008467 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008468 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008469 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008470 }
8471
Przemek Stekiel09104b82023-03-06 14:11:51 +01008472 switch (operation->alg) {
8473#if defined(PSA_WANT_ALG_JPAKE)
8474 case PSA_ALG_JPAKE:
8475 if (role == PSA_PAKE_ROLE_NONE) {
8476 return PSA_SUCCESS;
8477 }
8478 status = PSA_ERROR_INVALID_ARGUMENT;
8479 break;
8480#endif
8481 default:
8482 (void) role;
8483 status = PSA_ERROR_NOT_SUPPORTED;
8484 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008485 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008486exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008487 psa_pake_abort(operation);
8488 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008489}
8490
David Horstmanne7f21e62023-05-12 18:17:21 +01008491/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008492#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008493static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008494 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008495{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008496 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008497 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008498 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008499
David Horstmann024e5c52023-06-14 15:48:21 +01008500 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008501 is_x1 = (stage->outputs < 1);
8502 } else {
8503 is_x1 = (stage->inputs < 1);
8504 }
8505
David Horstmann74a3d8c2023-06-14 18:28:19 +01008506 key_share_step = is_x1 ?
8507 PSA_JPAKE_X1_STEP_KEY_SHARE :
8508 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008509 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008510 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8511 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8512 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8513 } else {
8514 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008515 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008516 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008517}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008518#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008519
Przemek Stekiel2797d372022-12-22 11:19:22 +01008520static psa_status_t psa_pake_complete_inputs(
8521 psa_pake_operation_t *operation)
8522{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008523 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008524 /* Create copy of the inputs on stack as inputs share memory
8525 with the driver context which will be setup by the driver. */
8526 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008527
Przemek Stekielfde11282023-03-13 16:06:09 +01008528 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008529 return PSA_ERROR_BAD_STATE;
8530 }
8531
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008532 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008533 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8534 return PSA_ERROR_BAD_STATE;
8535 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008536 }
8537
Przemek Stekiel18620a32023-01-17 16:34:52 +01008538 /* Clear driver context */
8539 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8540
8541 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008542
8543 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008544 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008545
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008546 /* User and peer are translated to role. */
8547 mbedtls_free(inputs.user);
8548 mbedtls_free(inputs.peer);
8549
Przemek Stekiel2797d372022-12-22 11:19:22 +01008550 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008551#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008552 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008553 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008554 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008555#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008556 {
8557 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008558 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008559 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008560 return status;
8561}
8562
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008563#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008564static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008565 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008566 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008567 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008568{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008569 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8570 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8571 step != PSA_PAKE_STEP_ZK_PROOF) {
8572 return PSA_ERROR_INVALID_ARGUMENT;
8573 }
8574
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008575 psa_jpake_computation_stage_t *computation_stage =
8576 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008577
David Horstmann5da95602023-06-08 15:37:12 +01008578 if (computation_stage->round != PSA_JPAKE_FIRST &&
8579 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008580 return PSA_ERROR_BAD_STATE;
8581 }
8582
David Horstmanne7f21e62023-05-12 18:17:21 +01008583 /* Check that the step we are given is the one we were expecting */
8584 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008585 return PSA_ERROR_BAD_STATE;
8586 }
8587
David Horstmanne7f21e62023-05-12 18:17:21 +01008588 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8589 computation_stage->inputs == 0 &&
8590 computation_stage->outputs == 0) {
8591 /* Start of the round, so function decides whether we are inputting
8592 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008593 computation_stage->io_mode = io_mode;
8594 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008595 /* Middle of the round so the mode we are in must match the function
8596 * called by the user */
8597 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008598 }
8599
8600 return PSA_SUCCESS;
8601}
8602
David Horstmanne7f21e62023-05-12 18:17:21 +01008603static psa_status_t psa_jpake_epilogue(
8604 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008605 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008606{
David Horstmanne7f21e62023-05-12 18:17:21 +01008607 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008608 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008609
David Horstmanne7f21e62023-05-12 18:17:21 +01008610 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8611 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008612 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008613 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008614 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008615 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008616 }
8617 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008618 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008619 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008620 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008621 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008622 }
8623 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008624 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8625 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008626 /* End of a round, move to the next round */
8627 stage->inputs = 0;
8628 stage->outputs = 0;
8629 stage->round++;
8630 }
8631 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008632 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008633 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008634 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008635 return PSA_SUCCESS;
8636}
David Horstmanne7f21e62023-05-12 18:17:21 +01008637
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008638#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008639
Neil Armstronga7d08c32022-06-01 18:21:20 +02008640psa_status_t psa_pake_output(
8641 psa_pake_operation_t *operation,
8642 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00008643 uint8_t *output_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008644 size_t output_size,
8645 size_t *output_length)
8646{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008647 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008648 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
David Horstmannc75639d2024-01-22 17:56:39 +00008649 LOCAL_OUTPUT_DECLARE(output_external, output);
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008650 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008651
8652 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008653 status = psa_pake_complete_inputs(operation);
8654 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008655 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008656 }
8657 }
8658
8659 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008660 status = PSA_ERROR_BAD_STATE;
8661 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008662 }
8663
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008664 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008665 status = PSA_ERROR_INVALID_ARGUMENT;
8666 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008667 }
8668
Przemek Stekiele12ed362022-12-21 12:54:46 +01008669 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008670#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008671 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008672 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008673 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008674 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008675 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008676 driver_step = convert_jpake_computation_stage_to_driver_step(
8677 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008678 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008679#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008680 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008681 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008682 status = PSA_ERROR_NOT_SUPPORTED;
8683 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008684 }
8685
David Horstmannc75639d2024-01-22 17:56:39 +00008686 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
8687
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008688 status = psa_driver_wrapper_pake_output(operation, driver_step,
8689 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008690
8691 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008692 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008693 }
8694
8695 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008696#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008697 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008698 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008699 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008700 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008701 }
8702 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008703#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008704 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008705 status = PSA_ERROR_NOT_SUPPORTED;
8706 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008707 }
8708
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008709exit:
David Horstmannc75639d2024-01-22 17:56:39 +00008710 LOCAL_OUTPUT_FREE(output_external, output);
8711 if (status != PSA_SUCCESS) {
8712 psa_pake_abort(operation);
8713 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008714 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008715}
8716
8717psa_status_t psa_pake_input(
8718 psa_pake_operation_t *operation,
8719 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00008720 const uint8_t *input_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008721 size_t input_length)
8722{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008723 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008724 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008725 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8726 operation->primitive,
8727 step);
David Horstmannc75639d2024-01-22 17:56:39 +00008728 LOCAL_INPUT_DECLARE(input_external, input);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008729
8730 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008731 status = psa_pake_complete_inputs(operation);
8732 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008733 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008734 }
8735 }
8736
8737 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008738 status = PSA_ERROR_BAD_STATE;
8739 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008740 }
8741
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008742 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008743 status = PSA_ERROR_INVALID_ARGUMENT;
8744 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008745 }
8746
Przemek Stekiele12ed362022-12-21 12:54:46 +01008747 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008748#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008749 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008750 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008751 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008752 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008753 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008754 driver_step = convert_jpake_computation_stage_to_driver_step(
8755 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008756 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008757#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008758 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008759 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008760 status = PSA_ERROR_NOT_SUPPORTED;
8761 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008762 }
8763
David Horstmannc75639d2024-01-22 17:56:39 +00008764 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008765 status = psa_driver_wrapper_pake_input(operation, driver_step,
8766 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008767
8768 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008769 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008770 }
8771
8772 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008773#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008774 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008775 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008776 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008777 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008778 }
8779 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008780#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008781 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008782 status = PSA_ERROR_NOT_SUPPORTED;
8783 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008784 }
8785
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008786exit:
David Horstmannc75639d2024-01-22 17:56:39 +00008787 LOCAL_INPUT_FREE(input_external, input);
8788 if (status != PSA_SUCCESS) {
8789 psa_pake_abort(operation);
8790 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008791 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008792}
8793
8794psa_status_t psa_pake_get_implicit_key(
8795 psa_pake_operation_t *operation,
8796 psa_key_derivation_operation_t *output)
8797{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008798 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008799 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008800 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008801 size_t shared_key_len = 0;
8802
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008803 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008804 status = PSA_ERROR_BAD_STATE;
8805 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008806 }
8807
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008808#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008809 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008810 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008811 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008812 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008813 status = PSA_ERROR_BAD_STATE;
8814 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008815 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008816 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008817#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008818 {
8819 status = PSA_ERROR_NOT_SUPPORTED;
8820 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008821 }
8822
Przemek Stekiel0c781802022-11-29 14:53:13 +01008823 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8824 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008825 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008826 &shared_key_len);
8827
8828 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008829 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008830 }
8831
8832 status = psa_key_derivation_input_bytes(output,
8833 PSA_KEY_DERIVATION_INPUT_SECRET,
8834 shared_key,
8835 shared_key_len);
8836
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008837 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008838exit:
8839 abort_status = psa_pake_abort(operation);
8840 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008841}
8842
8843psa_status_t psa_pake_abort(
8844 psa_pake_operation_t *operation)
8845{
Przemek Stekield69dca92023-01-31 19:59:20 +01008846 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008847
Przemek Stekield69dca92023-01-31 19:59:20 +01008848 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008849 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008850 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008851
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008852 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8853 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008854 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008855 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008856 }
8857 if (operation->data.inputs.user != NULL) {
8858 mbedtls_free(operation->data.inputs.user);
8859 }
8860 if (operation->data.inputs.peer != NULL) {
8861 mbedtls_free(operation->data.inputs.peer);
8862 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008863 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008864 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008865
Przemek Stekield69dca92023-01-31 19:59:20 +01008866 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008867}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008868#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008869
David Horstmann00d7a042023-12-07 18:39:17 +00008870/* Memory copying test hooks. These are called before input copy, after input
8871 * copy, before output copy and after output copy, respectively.
8872 * They are used by memory-poisoning tests to temporarily unpoison buffers
8873 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008874#if defined(MBEDTLS_TEST_HOOKS)
8875void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8876void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8877void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8878void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8879#endif
David Horstmannfde97392023-10-30 20:29:43 +00008880
David Horstmann1b7279a2023-11-15 15:18:30 +00008881/** Copy from an input buffer to a local copy.
8882 *
8883 * \param[in] input Pointer to input buffer.
8884 * \param[in] input_len Length of the input buffer.
8885 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8886 * \param[out] input_copy_len Length of the local copy buffer.
8887 * \return #PSA_SUCCESS, if the buffer was successfully
8888 * copied.
8889 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8890 * copy is too small to hold contents of the
8891 * input buffer.
8892 */
8893MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008894psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8895 uint8_t *input_copy, size_t input_copy_len)
8896{
8897 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008898 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008899 }
8900
David Horstmann372b8bb2023-11-24 16:21:04 +00008901#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008902 if (psa_input_pre_copy_hook != NULL) {
8903 psa_input_pre_copy_hook(input, input_len);
8904 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008905#endif
8906
David Horstmann777e7412023-11-15 17:33:47 +00008907 if (input_len > 0) {
8908 memcpy(input_copy, input, input_len);
8909 }
David Horstmannfde97392023-10-30 20:29:43 +00008910
David Horstmann372b8bb2023-11-24 16:21:04 +00008911#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008912 if (psa_input_post_copy_hook != NULL) {
8913 psa_input_post_copy_hook(input, input_len);
8914 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008915#endif
8916
David Horstmannfde97392023-10-30 20:29:43 +00008917 return PSA_SUCCESS;
8918}
8919
David Horstmann1b7279a2023-11-15 15:18:30 +00008920/** Copy from a local output buffer into a user-supplied one.
8921 *
8922 * \param[in] output_copy Pointer to a local buffer containing the output.
8923 * \param[in] output_copy_len Length of the local buffer.
8924 * \param[out] output Pointer to user-supplied output buffer.
8925 * \param[out] output_len Length of the user-supplied output buffer.
8926 * \return #PSA_SUCCESS, if the buffer was successfully
8927 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008928 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008929 * user-supplied output buffer is too small to
8930 * hold the contents of the local buffer.
8931 */
8932MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008933psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8934 uint8_t *output, size_t output_len)
8935{
8936 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008937 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008938 }
David Horstmann777e7412023-11-15 17:33:47 +00008939
David Horstmann372b8bb2023-11-24 16:21:04 +00008940#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008941 if (psa_output_pre_copy_hook != NULL) {
8942 psa_output_pre_copy_hook(output, output_len);
8943 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008944#endif
8945
David Horstmann777e7412023-11-15 17:33:47 +00008946 if (output_copy_len > 0) {
8947 memcpy(output, output_copy, output_copy_len);
8948 }
8949
David Horstmann372b8bb2023-11-24 16:21:04 +00008950#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008951 if (psa_output_post_copy_hook != NULL) {
8952 psa_output_post_copy_hook(output, output_len);
8953 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008954#endif
8955
David Horstmann8978f5c2023-10-30 20:37:12 +00008956 return PSA_SUCCESS;
8957}
8958
David Horstmannf1734052023-11-20 17:15:32 +00008959psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8960 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008961{
8962 psa_status_t status;
8963
David Horstmann9db14482023-11-23 15:50:37 +00008964 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008965
David Horstmannc5cc1c32023-11-15 18:11:26 +00008966 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008967 return PSA_SUCCESS;
8968 }
8969
David Horstmannf1734052023-11-20 17:15:32 +00008970 local_input->buffer = mbedtls_calloc(input_len, 1);
8971 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008972 /* Since we dealt with the zero-length case above, we know that
8973 * a NULL return value means a failure of allocation. */
8974 return PSA_ERROR_INSUFFICIENT_MEMORY;
8975 }
David Horstmannf1734052023-11-20 17:15:32 +00008976 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008977
David Horstmannf1734052023-11-20 17:15:32 +00008978 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008979
8980 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008981 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008982 if (status != PSA_SUCCESS) {
8983 goto error;
8984 }
8985
8986 return PSA_SUCCESS;
8987
8988error:
David Horstmannf1734052023-11-20 17:15:32 +00008989 mbedtls_free(local_input->buffer);
8990 local_input->buffer = NULL;
8991 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008992 return status;
8993}
8994
David Horstmannf1734052023-11-20 17:15:32 +00008995void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008996{
David Horstmannf1734052023-11-20 17:15:32 +00008997 mbedtls_free(local_input->buffer);
8998 local_input->buffer = NULL;
8999 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00009000}
9001
David Horstmann89875a42023-11-20 12:54:09 +00009002psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
9003 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00009004{
David Horstmann9db14482023-11-23 15:50:37 +00009005 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00009006
David Horstmannc5cc1c32023-11-15 18:11:26 +00009007 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00009008 return PSA_SUCCESS;
9009 }
David Horstmann89875a42023-11-20 12:54:09 +00009010 local_output->buffer = mbedtls_calloc(output_len, 1);
9011 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00009012 /* Since we dealt with the zero-length case above, we know that
9013 * a NULL return value means a failure of allocation. */
9014 return PSA_ERROR_INSUFFICIENT_MEMORY;
9015 }
David Horstmann89875a42023-11-20 12:54:09 +00009016 local_output->length = output_len;
9017 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00009018
9019 return PSA_SUCCESS;
9020}
9021
Gabor Mezei1882c512024-01-24 13:07:17 +01009022psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
9023 psa_crypto_local_output_t *local_output)
9024{
9025 psa_status_t status;
9026 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
9027
9028 if (output_len == 0) {
9029 return PSA_SUCCESS;
9030 }
9031 local_output->buffer = mbedtls_calloc(output_len, 1);
9032 if (local_output->buffer == NULL) {
9033 /* Since we dealt with the zero-length case above, we know that
9034 * a NULL return value means a failure of allocation. */
9035 return PSA_ERROR_INSUFFICIENT_MEMORY;
9036 }
9037 local_output->length = output_len;
9038 local_output->original = output;
9039
9040 status = psa_crypto_copy_input(output, output_len,
9041 local_output->buffer, local_output->length);
9042 if (status != PSA_SUCCESS) {
9043 goto error;
9044 }
9045
9046 return PSA_SUCCESS;
9047
9048error:
9049 mbedtls_free(local_output->buffer);
9050 local_output->buffer = NULL;
9051 local_output->length = 0;
9052 return status;
9053}
9054
David Horstmann89875a42023-11-20 12:54:09 +00009055psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00009056{
David Horstmannc335a4e2023-11-15 15:57:32 +00009057 psa_status_t status;
9058
David Horstmann89875a42023-11-20 12:54:09 +00009059 if (local_output->buffer == NULL) {
9060 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009061 return PSA_SUCCESS;
9062 }
David Horstmann89875a42023-11-20 12:54:09 +00009063 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00009064 /* We have an internal copy but nothing to copy back to. */
9065 return PSA_ERROR_CORRUPTION_DETECTED;
9066 }
9067
David Horstmann89875a42023-11-20 12:54:09 +00009068 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
9069 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00009070 if (status != PSA_SUCCESS) {
9071 return status;
9072 }
David Horstmann9467ea32023-11-08 17:44:18 +00009073
David Horstmann89875a42023-11-20 12:54:09 +00009074 mbedtls_free(local_output->buffer);
9075 local_output->buffer = NULL;
9076 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009077
9078 return PSA_SUCCESS;
9079}
9080
Gilles Peskinee59236f2018-01-27 23:32:46 +01009081#endif /* MBEDTLS_PSA_CRYPTO_C */