blob: b78e8696bb3902aa33a43cbe05b331278e0f63f1 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskinee59236f2018-01-27 23:32:46 +01007 */
8
Gilles Peskinedb09ef62020-06-03 01:43:33 +02009#include "common.h"
Ronald Cronafbc7ed2023-01-24 16:02:04 +010010#include "psa_crypto_core_common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010011
12#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030013
John Durkop07cc04a2020-11-16 22:08:34 -080014#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
15#include "check_crypto_config.h"
16#endif
17
Gilles Peskinee59236f2018-01-27 23:32:46 +010018#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010019#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010020
Ronald Crond6d28882020-12-14 14:56:02 +010021#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010022#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010023#include "psa_crypto_invasive.h"
Xiaokang Qiane9c39c42023-08-09 08:50:19 +000024#include "psa_crypto_driver_wrappers.h"
Xiaokang Qianfe9666b2023-09-11 10:36:20 +000025#include "psa_crypto_driver_wrappers_no_static.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010026#include "psa_crypto_ecp.h"
Przemek Stekiel359f4622022-12-05 14:11:55 +010027#include "psa_crypto_ffdh.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010028#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010029#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010030#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010031#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020033#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020034#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010035#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010036/* Include internal declarations that are useful for implementing persistently
37 * stored keys. */
38#include "psa_crypto_storage.h"
39
Gilles Peskineb2b64d32020-12-14 16:43:58 +010040#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010041
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include <stdlib.h>
43#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010045
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010046#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020047#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000048#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020049#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010050#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020051#include "mbedtls/chacha20.h"
52#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010053#include "mbedtls/cipher.h"
54#include "mbedtls/ccm.h"
55#include "mbedtls/cmac.h"
Dave Rodgman78701152023-08-29 14:20:18 +010056#include "mbedtls/constant_time.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020058#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010059#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010060#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/error.h"
62#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/md5.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010064#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000065#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010066#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000067#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010069#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/sha1.h"
71#include "mbedtls/sha256.h"
72#include "mbedtls/sha512.h"
Valerio Setti384fbde2024-01-02 13:26:40 +010073#include "mbedtls/psa_util.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020075#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
76 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
77 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020078#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020079#endif
80
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010081/****************************************************************/
82/* Global data, support functions and library management */
83/****************************************************************/
84
Gilles Peskine449bd832023-01-11 14:50:10 +010085static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020088}
89
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010090/* Values for psa_global_data_t::rng_state */
91#define RNG_NOT_INITIALIZED 0
92#define RNG_INITIALIZED 1
93#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010094
Gilles Peskine449bd832023-01-11 14:50:10 +010095typedef struct {
Dave Rodgman864f5942023-08-16 18:04:44 +010096 uint8_t initialized;
97 uint8_t rng_state;
98 uint8_t drivers_initialized;
Gilles Peskine2d8a1822021-11-08 22:20:03 +010099 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100100} psa_global_data_t;
101
102static psa_global_data_t global_data;
103
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100104#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
105mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
106 &global_data.rng.drbg;
107#endif
108
itayzafrir0adf0fc2018-09-06 16:24:41 +0300109#define GUARD_MODULE_INITIALIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (global_data.initialized == 0) \
111 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300112
David Horstmann513101b2023-11-29 17:24:08 +0000113#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
David Horstmann36df4b22023-12-13 15:55:25 +0000114
David Horstmann62a56d92023-12-14 18:12:47 +0000115/* Declare a local copy of an input buffer and a variable that will be used
116 * to store a pointer to the start of the buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000117 *
118 * Note: This macro must be called before any operations which may jump to
119 * the exit label, so that the local input copy object is safe to be freed.
120 *
121 * Assumptions:
122 * - input is the name of a pointer to the buffer to be copied
123 * - The name LOCAL_INPUT_COPY_OF_input is unused in the current scope
David Horstmann62a56d92023-12-14 18:12:47 +0000124 * - input_copy_name is a name that is unused in the current scope
David Horstmann36df4b22023-12-13 15:55:25 +0000125 */
David Horstmann62a56d92023-12-14 18:12:47 +0000126#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
127 psa_crypto_local_input_t LOCAL_INPUT_COPY_OF_##input = PSA_CRYPTO_LOCAL_INPUT_INIT; \
128 const uint8_t *input_copy_name = NULL;
David Horstmann36df4b22023-12-13 15:55:25 +0000129
David Horstmann62a56d92023-12-14 18:12:47 +0000130/* Allocate a copy of the buffer input and set the pointer input_copy to
131 * point to the start of the copy.
David Horstmann36df4b22023-12-13 15:55:25 +0000132 *
David Horstmanne9a88ab2023-11-29 17:07:13 +0000133 * Assumptions:
134 * - psa_status_t status exists
135 * - An exit label is declared
David Horstmann36df4b22023-12-13 15:55:25 +0000136 * - input is the name of a pointer to the buffer to be copied
David Horstmann62a56d92023-12-14 18:12:47 +0000137 * - LOCAL_INPUT_DECLARE(input, input_copy) has previously been called
David Horstmanne9a88ab2023-11-29 17:07:13 +0000138 */
David Horstmann62a56d92023-12-14 18:12:47 +0000139#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
David Horstmann36df4b22023-12-13 15:55:25 +0000140 status = psa_crypto_local_input_alloc(input, length, \
141 &LOCAL_INPUT_COPY_OF_##input); \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000142 if (status != PSA_SUCCESS) { \
143 goto exit; \
144 } \
David Horstmann62a56d92023-12-14 18:12:47 +0000145 input_copy = LOCAL_INPUT_COPY_OF_##input.buffer;
David Horstmanne9a88ab2023-11-29 17:07:13 +0000146
David Horstmann36df4b22023-12-13 15:55:25 +0000147/* Free the local input copy allocated previously by LOCAL_INPUT_ALLOC()
148 *
David Horstmann3e72db42023-12-08 14:08:18 +0000149 * Assumptions:
David Horstmann62a56d92023-12-14 18:12:47 +0000150 * - input_copy is the name of the input copy pointer set by LOCAL_INPUT_ALLOC()
David Horstmann36df4b22023-12-13 15:55:25 +0000151 * - input is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000152 */
David Horstmann62a56d92023-12-14 18:12:47 +0000153#define LOCAL_INPUT_FREE(input, input_copy) \
154 input_copy = NULL; \
David Horstmann36df4b22023-12-13 15:55:25 +0000155 psa_crypto_local_input_free(&LOCAL_INPUT_COPY_OF_##input);
David Horstmanne9a88ab2023-11-29 17:07:13 +0000156
David Horstmann62a56d92023-12-14 18:12:47 +0000157/* Declare a local copy of an output buffer and a variable that will be used
158 * to store a pointer to the start of the buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000159 *
160 * Note: This macro must be called before any operations which may jump to
161 * the exit label, so that the local output copy object is safe to be freed.
162 *
163 * Assumptions:
164 * - output is the name of a pointer to the buffer to be copied
165 * - The name LOCAL_OUTPUT_COPY_OF_output is unused in the current scope
David Horstmann62a56d92023-12-14 18:12:47 +0000166 * - output_copy_name is a name that is unused in the current scope
David Horstmann36df4b22023-12-13 15:55:25 +0000167 */
David Horstmann62a56d92023-12-14 18:12:47 +0000168#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
169 psa_crypto_local_output_t LOCAL_OUTPUT_COPY_OF_##output = PSA_CRYPTO_LOCAL_OUTPUT_INIT; \
170 uint8_t *output_copy_name = NULL;
David Horstmann36df4b22023-12-13 15:55:25 +0000171
David Horstmann62a56d92023-12-14 18:12:47 +0000172/* Allocate a copy of the buffer output and set the pointer output_copy to
173 * point to the start of the copy.
David Horstmann36df4b22023-12-13 15:55:25 +0000174 *
David Horstmanne9a88ab2023-11-29 17:07:13 +0000175 * Assumptions:
176 * - psa_status_t status exists
177 * - An exit label is declared
David Horstmann36df4b22023-12-13 15:55:25 +0000178 * - output is the name of a pointer to the buffer to be copied
David Horstmann62a56d92023-12-14 18:12:47 +0000179 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
David Horstmanne9a88ab2023-11-29 17:07:13 +0000180 */
David Horstmann62a56d92023-12-14 18:12:47 +0000181#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
David Horstmann36df4b22023-12-13 15:55:25 +0000182 status = psa_crypto_local_output_alloc(output, length, \
183 &LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000184 if (status != PSA_SUCCESS) { \
185 goto exit; \
186 } \
David Horstmann62a56d92023-12-14 18:12:47 +0000187 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
David Horstmanne9a88ab2023-11-29 17:07:13 +0000188
Gabor Mezei1882c512024-01-24 13:07:17 +0100189/* Allocate a copy of the buffer output and set the pointer output_copy to
190 * point to the start of the copy.
191 *
192 * Assumptions:
193 * - psa_status_t status exists
194 * - An exit label is declared
195 * - output is the name of a pointer to the buffer to be copied
196 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
197 */
198#define LOCAL_OUTPUT_ALLOC_WITH_COPY(output, length, output_copy) \
199 status = psa_crypto_local_output_alloc_with_copy(output, length, \
200 &LOCAL_OUTPUT_COPY_OF_##output); \
201 if (status != PSA_SUCCESS) { \
202 goto exit; \
203 } \
204 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
205
David Horstmann62a56d92023-12-14 18:12:47 +0000206/* Free the local output copy allocated previously by LOCAL_OUTPUT_ALLOC()
David Horstmann3e72db42023-12-08 14:08:18 +0000207 * after first copying back its contents to the original buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000208 *
David Horstmann3e72db42023-12-08 14:08:18 +0000209 * Assumptions:
David Horstmann3e72db42023-12-08 14:08:18 +0000210 * - psa_status_t status exists
David Horstmann62a56d92023-12-14 18:12:47 +0000211 * - output_copy is the name of the output copy pointer set by LOCAL_OUTPUT_ALLOC()
212 * - output is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000213 */
David Horstmann62a56d92023-12-14 18:12:47 +0000214#define LOCAL_OUTPUT_FREE(output, output_copy) \
215 output_copy = NULL; \
David Horstmann5a945f52023-12-13 14:09:08 +0000216 do { \
217 psa_status_t local_output_status; \
David Horstmann36df4b22023-12-13 15:55:25 +0000218 local_output_status = psa_crypto_local_output_free(&LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmann5a945f52023-12-13 14:09:08 +0000219 if (local_output_status != PSA_SUCCESS) { \
220 /* Since this error case is an internal error, it's more serious than \
221 * any existing error code and so it's fine to overwrite the existing \
222 * status. */ \
223 status = local_output_status; \
224 } \
225 } while (0)
David Horstmann513101b2023-11-29 17:24:08 +0000226#else /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmann62a56d92023-12-14 18:12:47 +0000227#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
228 const uint8_t *input_copy_name = NULL;
229#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
230 input_copy = input;
231#define LOCAL_INPUT_FREE(input, input_copy) \
232 input_copy = NULL;
233#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
234 uint8_t *output_copy_name = NULL;
235#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
236 output_copy = output;
237#define LOCAL_OUTPUT_FREE(output, output_copy) \
238 output_copy = NULL;
David Horstmann513101b2023-11-29 17:24:08 +0000239#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000240
241
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100242int psa_can_do_hash(psa_algorithm_t hash_alg)
243{
244 (void) hash_alg;
245 return global_data.drivers_initialized;
246}
Valerio Settic6f004f2023-12-12 11:27:36 +0100247
Valerio Setti1fff4f22023-12-28 14:19:34 +0100248int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg)
Valerio Settic6f004f2023-12-12 11:27:36 +0100249{
Valerio Setti1fff4f22023-12-28 14:19:34 +0100250 (void) key_type;
Valerio Settic6f004f2023-12-12 11:27:36 +0100251 (void) cipher_alg;
252 return global_data.drivers_initialized;
253}
254
255
Valerio Settia55f0422023-07-10 15:34:41 +0200256#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200257 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200258 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200259static int psa_is_dh_key_size_valid(size_t bits)
260{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200261 if (bits != 2048 && bits != 3072 && bits != 4096 &&
262 bits != 6144 && bits != 8192) {
263 return 0;
264 }
265
266 return 1;
267}
Valerio Settia55f0422023-07-10 15:34:41 +0200268#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200269 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200270 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100271
Gilles Peskine449bd832023-01-11 14:50:10 +0100272psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100273{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100274 /* Mbed TLS error codes can combine a high-level error code and a
275 * low-level error code. The low-level error usually reflects the
276 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100277 int low_level_ret = -(-ret & 0x007f);
278 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100279 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100280 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100281
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100282#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100283 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
284 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100286 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
287 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100288#endif
289
290#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200291 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
292 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
293 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
294 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
295 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200297 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200299 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100301#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200302
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100303#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000304 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100305 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100307#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100308
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100309#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100310 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100312 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100313 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100314#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100315
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100316#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200317 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100319#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200320
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100321#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200322 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200324 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100326#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200327
Dave Rodgman509b5672023-08-16 19:26:23 +0100328#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100329 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100331 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100333 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100335 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100336 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100337 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100339 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100341 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100343#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100344
Gilles Peskine449bd832023-01-11 14:50:10 +0100345#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
346 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100347 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
348 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100349 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100351 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
352 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100354 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100356#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100357
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100358#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100359 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100361#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100362
Gilles Peskinee59236f2018-01-27 23:32:46 +0100363 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
364 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
365 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100367
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100368#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100369 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200371 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100373 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100375#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100376
Gilles Peskine82e57d12020-11-13 21:31:17 +0100377#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100379 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
380 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100381 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100383 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
384 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100386 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100388#endif
389
Dave Rodgmandea266f2023-08-31 11:52:43 +0100390#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100391 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100393 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100394 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100395 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100396 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100397#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100398 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100400#endif
401#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100402
Dave Rodgman509b5672023-08-16 19:26:23 +0100403#if defined(MBEDTLS_BIGNUM_C)
404#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100405 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100407#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100408 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100410 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100412 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100414 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100416 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100418 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100420 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100422#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100423
Dave Rodgman509b5672023-08-16 19:26:23 +0100424#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100425 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100427 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
428 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100429 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100430#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
431 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100432 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100434#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100435 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
436 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100438 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100440 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
441 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100443 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100444 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100445 case MBEDTLS_ERR_PK_INVALID_ALG:
446 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
447 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100448 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100449 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200451 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100453#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100454
Gilles Peskineff2d2002019-05-06 15:26:23 +0200455 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200457 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200459
Dave Rodgman509b5672023-08-16 19:26:23 +0100460#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100461 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100463 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100465 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100466 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100467 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100469 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
470 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100471 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100472 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100474 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100476 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100478#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200479
Dave Rodgman1dab4452023-09-01 09:59:51 +0100480#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300481 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300482 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300484 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300486 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300488 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
489 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100490 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300491 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100493 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100495
Dave Rodgman509b5672023-08-16 19:26:23 +0100496#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000497 case MBEDTLS_ERR_ECP_IN_PROGRESS:
498 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100499#endif
500#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000501
Janos Follatha13b9052019-11-22 12:48:59 +0000502 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300504
Gilles Peskinee59236f2018-01-27 23:32:46 +0100505 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100507 }
508}
509
Paul Elliottdc42ca82023-02-24 18:11:59 +0000510/**
511 * \brief For output buffers which contain "tags"
512 * (outputs that may be checked for validity like
513 * hashes, MACs and signatures), fill the unused
514 * part of the output buffer (the whole buffer on
515 * error, the trailing part on success) with
516 * something that isn't a valid tag (barring an
517 * attack on the tag and deliberately-crafted
518 * input), in case the caller doesn't check the
519 * return status properly.
520 *
521 * \param output_buffer Pointer to buffer to wipe. May not be NULL
522 * unless \p output_buffer_size is zero.
523 * \param status Status of function called to generate
524 * output_buffer originally
525 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
526 * could be NULL.
527 * \param output_buffer_length Length of data written to output_buffer, must be
528 * less than \p output_buffer_size
529 */
530static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000531 size_t output_buffer_size, size_t output_buffer_length)
532{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000533 size_t offset = 0;
534
535 if (output_buffer_size == 0) {
536 /* If output_buffer_size is 0 then we have nothing to do. We must not
537 call memset because output_buffer may be NULL in this case */
538 return;
539 }
540
541 if (status == PSA_SUCCESS) {
542 offset = output_buffer_length;
543 }
544
545 memset(output_buffer + offset, '!', output_buffer_size - offset);
546}
547
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200548
Gilles Peskine449bd832023-01-11 14:50:10 +0100549psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
550 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200551{
552 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200554 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200555 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200556 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200557 case PSA_KEY_TYPE_PASSWORD:
558 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200559 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100560#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200561 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 if (bits != 128 && bits != 192 && bits != 256) {
563 return PSA_ERROR_INVALID_ARGUMENT;
564 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200565 break;
566#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200567#if defined(PSA_WANT_KEY_TYPE_ARIA)
568 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 if (bits != 128 && bits != 192 && bits != 256) {
570 return PSA_ERROR_INVALID_ARGUMENT;
571 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200572 break;
573#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100574#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200575 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 if (bits != 128 && bits != 192 && bits != 256) {
577 return PSA_ERROR_INVALID_ARGUMENT;
578 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200579 break;
580#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100581#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200582 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 if (bits != 64 && bits != 128 && bits != 192) {
584 return PSA_ERROR_INVALID_ARGUMENT;
585 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200586 break;
587#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100588#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200589 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 if (bits != 256) {
591 return PSA_ERROR_INVALID_ARGUMENT;
592 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200593 break;
594#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200595 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100596 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200597 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 if (bits % 8 != 0) {
599 return PSA_ERROR_INVALID_ARGUMENT;
600 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200601
Gilles Peskine449bd832023-01-11 14:50:10 +0100602 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200603}
604
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100605/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100606 *
Steven Cooremancd640932021-03-08 12:00:27 +0100607 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
608 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100609 *
610 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100611 * \param[in] key_type The key type of the key to be used with the
612 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100613 *
614 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100615 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100616 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100617 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100618 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100619MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100620 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100622{
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 if (PSA_ALG_IS_HMAC(algorithm)) {
624 if (key_type == PSA_KEY_TYPE_HMAC) {
625 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100626 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100627 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100628
Gilles Peskine449bd832023-01-11 14:50:10 +0100629 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
630 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
631 * key. */
632 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
633 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
634 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
635 * the block length (larger than 1) for block ciphers. */
636 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
637 return PSA_SUCCESS;
638 }
639 }
640 }
641
642 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100643}
644
Gilles Peskine449bd832023-01-11 14:50:10 +0100645psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
646 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200647{
Gilles Peskine449bd832023-01-11 14:50:10 +0100648 if (slot->key.data != NULL) {
649 return PSA_ERROR_ALREADY_EXISTS;
650 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200651
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 slot->key.data = mbedtls_calloc(1, buffer_length);
653 if (slot->key.data == NULL) {
654 return PSA_ERROR_INSUFFICIENT_MEMORY;
655 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200656
Ronald Cronea0f8a62020-11-25 17:52:23 +0100657 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100658 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200659}
660
Gilles Peskine449bd832023-01-11 14:50:10 +0100661psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
662 const uint8_t *data,
663 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200664{
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 psa_status_t status = psa_allocate_buffer_to_slot(slot,
666 data_length);
667 if (status != PSA_SUCCESS) {
668 return status;
669 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 memcpy(slot->key.data, data, data_length);
672 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200673}
674
Ronald Crona0fe59f2020-11-29 11:14:53 +0100675psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100676 const psa_key_attributes_t *attributes,
677 const uint8_t *data, size_t data_length,
678 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100680{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100681 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
682 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100683
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200684 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 if (data_length == 0) {
686 return PSA_ERROR_NOT_SUPPORTED;
687 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200688
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 if (key_type_is_raw_bytes(type)) {
690 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
693 *bits);
694 if (status != PSA_SUCCESS) {
695 return status;
696 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200697
Ronald Crondd04d422020-11-28 15:14:42 +0100698 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100700 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200702
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 return PSA_SUCCESS;
704 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200705#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200706 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100707 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200708 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100709 return PSA_ERROR_INVALID_ARGUMENT;
710 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200711 return mbedtls_psa_ffdh_import_key(attributes,
712 data, data_length,
713 key_buffer, key_buffer_size,
714 key_buffer_length,
715 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100716 }
Valerio Settia55f0422023-07-10 15:34:41 +0200717#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200718 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200719#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
721 if (PSA_KEY_TYPE_IS_ECC(type)) {
722 return mbedtls_psa_ecp_import_key(attributes,
723 data, data_length,
724 key_buffer, key_buffer_size,
725 key_buffer_length,
726 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100727 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200728#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800729 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200730#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
731 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
733 if (PSA_KEY_TYPE_IS_RSA(type)) {
734 return mbedtls_psa_rsa_import_key(attributes,
735 data, data_length,
736 key_buffer, key_buffer_size,
737 key_buffer_length,
738 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200739 }
Valerio Settife478902023-07-25 12:27:19 +0200740#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
741 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800742 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100743 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100744
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100746}
747
Gilles Peskinef603c712019-01-19 13:40:11 +0100748/** Calculate the intersection of two algorithm usage policies.
749 *
750 * Return 0 (which allows no operation) on incompatibility.
751 */
752static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100753 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100754 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100756{
Gilles Peskine549ea862019-05-22 11:45:59 +0200757 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 if (alg1 == alg2) {
759 return alg1;
760 }
Steven Cooreman03488022021-02-18 12:07:20 +0100761 /* If the policies are from the same hash-and-sign family, check
762 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100763 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
764 PSA_ALG_IS_SIGN_HASH(alg2) &&
765 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
766 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
767 return alg2;
768 }
769 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
770 return alg1;
771 }
Steven Cooreman03488022021-02-18 12:07:20 +0100772 }
773 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100774 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100775 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
777 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
778 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
779 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
780 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100781 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100782
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100783 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
785 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
786 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
787 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100788 }
789 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
791 (alg1_len <= alg2_len)) {
792 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100793 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
795 (alg2_len <= alg1_len)) {
796 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100797 }
798 }
799 /* If the policies are from the same MAC family, check whether one
800 * of them is a minimum-MAC-length policy. Calculate the most
801 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
803 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
804 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100805 /* Validate the combination of key type and algorithm. Since the base
806 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
808 return 0;
809 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100810
Steven Cooreman31a876d2021-03-03 20:47:40 +0100811 /* Get the (exact or at-least) output lengths for both sides of the
812 * requested intersection. None of the currently supported algorithms
813 * have an output length dependent on the actual key size, so setting it
814 * to a bogus value of 0 is currently OK.
815 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100816 * Note that for at-least-this-length wildcard algorithms, the output
817 * length is set to the shortest allowed length, which allows us to
818 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100819 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
820 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100821 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100822
Steven Cooremana1d83222021-02-25 10:20:29 +0100823 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100824 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
825 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
826 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100827 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100828
829 /* If only one is an at-least-this-length policy, the intersection would
830 * be the other (fixed-length) policy as long as said fixed length is
831 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
833 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100834 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100835 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
836 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100837 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100838
Steven Cooremancd640932021-03-08 12:00:27 +0100839 /* If none of them are wildcards, check whether they define the same tag
840 * length. This is still possible here when one is default-length and
841 * the other specific-length. Ensure to always return the
842 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100843 if (alg1_len == alg2_len) {
844 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
845 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100846 }
847 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100848 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100849}
850
Gilles Peskine449bd832023-01-11 14:50:10 +0100851static int psa_key_algorithm_permits(psa_key_type_t key_type,
852 psa_algorithm_t policy_alg,
853 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200854{
Gilles Peskine549ea862019-05-22 11:45:59 +0200855 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100856 if (requested_alg == policy_alg) {
857 return 1;
858 }
Steven Cooreman03488022021-02-18 12:07:20 +0100859 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
860 * and requested_alg is the same hash-and-sign family with any hash,
861 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100862 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
863 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
864 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
865 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100866 }
867 /* If policy_alg is a wildcard AEAD algorithm of the same base as
868 * the requested algorithm, check the requested tag length to be
869 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100870 if (PSA_ALG_IS_AEAD(policy_alg) &&
871 PSA_ALG_IS_AEAD(requested_alg) &&
872 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
873 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
874 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
875 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
876 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100877 }
Steven Cooremancd640932021-03-08 12:00:27 +0100878 /* If policy_alg is a MAC algorithm of the same base as the requested
879 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100880 if (PSA_ALG_IS_MAC(policy_alg) &&
881 PSA_ALG_IS_MAC(requested_alg) &&
882 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
883 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100884 /* Validate the combination of key type and algorithm. Since the policy
885 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100886 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
887 return 0;
888 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100889
Steven Cooreman31a876d2021-03-03 20:47:40 +0100890 /* Get both the requested output length for the algorithm which is to be
891 * verified, and the default output length for the base algorithm.
892 * Note that none of the currently supported algorithms have an output
893 * length dependent on actual key size, so setting it to a bogus value
894 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100895 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100896 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100897 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 key_type, 0,
899 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100900
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100901 /* If the policy is default-length, only allow an algorithm with
902 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
904 return requested_output_length == default_output_length;
905 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100906
907 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100908 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
910 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
911 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100912 }
913
Steven Cooremancd640932021-03-08 12:00:27 +0100914 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
915 * check for the requested MAC length to be equal to or longer than the
916 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
918 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
919 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100920 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200921 }
Steven Cooremance48e852020-10-05 16:02:45 +0200922 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200923 * a key derivation with that key agreement should also be allowed. This
924 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
926 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
927 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
928 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200929 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100930 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200932}
933
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100934/** Test whether a policy permits an algorithm.
935 *
936 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100937 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100938 * \note This function requires providing the key type for which the policy is
939 * being validated, since some algorithm policy definitions (e.g. MAC)
940 * have different properties depending on what kind of cipher it is
941 * combined with.
942 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100943 * \retval PSA_SUCCESS When \p alg is a specific algorithm
944 * allowed by the \p policy.
945 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
946 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
947 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100948 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100949static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
950 psa_key_type_t key_type,
951 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100952{
Steven Cooremand788fab2021-02-25 11:29:17 +0100953 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100954 if (alg == 0) {
955 return PSA_ERROR_INVALID_ARGUMENT;
956 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100957
Steven Cooreman7e39f052021-02-23 14:18:32 +0100958 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 if (PSA_ALG_IS_WILDCARD(alg)) {
960 return PSA_ERROR_INVALID_ARGUMENT;
961 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100962
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
964 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
965 return PSA_SUCCESS;
966 } else {
967 return PSA_ERROR_NOT_PERMITTED;
968 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100969}
970
Gilles Peskinef603c712019-01-19 13:40:11 +0100971/** Restrict a key policy based on a constraint.
972 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100973 * \note This function requires providing the key type for which the policy is
974 * being restricted, since some algorithm policy definitions (e.g. MAC)
975 * have different properties depending on what kind of cipher it is
976 * combined with.
977 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100978 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100979 * \param[in,out] policy The policy to restrict.
980 * \param[in] constraint The policy constraint to apply.
981 *
982 * \retval #PSA_SUCCESS
983 * \c *policy contains the intersection of the original value of
984 * \c *policy and \c *constraint.
985 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100986 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100987 * \c *policy is unchanged.
988 */
989static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100990 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100991 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100993{
994 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 psa_key_policy_algorithm_intersection(key_type, policy->alg,
996 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200997 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
999 constraint->alg2);
1000 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1001 return PSA_ERROR_INVALID_ARGUMENT;
1002 }
1003 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1004 return PSA_ERROR_INVALID_ARGUMENT;
1005 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001006 policy->usage &= constraint->usage;
1007 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001008 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001010}
1011
Przemek Stekiel061f6942022-11-30 10:51:35 +01001012/** Get the description of a key given its identifier and policy constraints
1013 * and lock it.
1014 *
1015 * The key must have allow all the usage flags set in \p usage. If \p alg is
1016 * nonzero, the key must allow operations with this algorithm. If \p alg is
1017 * zero, the algorithm is not checked.
1018 *
1019 * In case of a persistent key, the function loads the description of the key
1020 * into a key slot if not already done.
1021 *
Ryan Everett098c6652024-01-03 13:03:36 +00001022 * On success, the returned key slot has been registered for reading.
1023 * It is the responsibility of the caller to call psa_unregister_read(slot)
1024 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +01001025 */
1026static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001027 mbedtls_svc_key_id_t key,
1028 psa_key_slot_t **p_slot,
1029 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001031{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001032 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001033 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001034
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 status = psa_get_and_lock_key_slot(key, p_slot);
1036 if (status != PSA_SUCCESS) {
1037 return status;
1038 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001039 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001040
1041 /* Enforce that usage policy for the key slot contains all the flags
1042 * required by the usage parameter. There is one exception: public
1043 * keys can always be exported, so we treat public key objects as
1044 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001046 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001048
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001050 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001051 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001052 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001053
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001054 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (alg != 0) {
1056 status = psa_key_policy_permits(&slot->attr.policy,
1057 slot->attr.type,
1058 alg);
1059 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001060 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001062 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001065
1066error:
1067 *p_slot = NULL;
Ryan Everett098c6652024-01-03 13:03:36 +00001068 psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001069
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001071}
Darryl Green940d72c2018-07-13 13:18:51 +01001072
Ronald Cron5c522922020-11-14 16:35:34 +01001073/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001074 *
1075 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001076 * available, as opposed to a key in a secure element and/or to be used
1077 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001078 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001079 * This is a temporary function that may be used instead of
1080 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1081 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001082 *
Ryan Everett098c6652024-01-03 13:03:36 +00001083 * On success, the returned key slot has been registered for reading.
1084 * It is the responsibility of the caller to call psa_unregister_read(slot)
1085 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001086 */
Ronald Cron5c522922020-11-14 16:35:34 +01001087static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1088 mbedtls_svc_key_id_t key,
1089 psa_key_slot_t **p_slot,
1090 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001092{
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1094 usage, alg);
1095 if (status != PSA_SUCCESS) {
1096 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001097 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001098
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everett098c6652024-01-03 13:03:36 +00001100 psa_unregister_read(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 *p_slot = NULL;
1102 return PSA_ERROR_NOT_SUPPORTED;
1103 }
1104
1105 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001106}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001107
Gilles Peskine449bd832023-01-11 14:50:10 +01001108psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001109{
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001111 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001113
Ronald Cronea0f8a62020-11-25 17:52:23 +01001114 slot->key.data = NULL;
1115 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001116
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001118}
1119
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001120/** Completely wipe a slot in memory, including its policy.
1121 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001122psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001123{
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001125
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 /*
1127 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001128 * do our best to report an unexpected amount of registered readers or
1129 * an unexpected state.
1130 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1131 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1133 * function is called as part of the execution of a test suite, the
1134 * execution of the test suite is stopped in error if the assertion fails.
1135 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001136 switch (slot->state) {
1137 case PSA_SLOT_FULL:
1138 /* In this state psa_wipe_key_slot() must only be called if the
1139 * caller is the last reader. */
1140 case PSA_SLOT_PENDING_DELETION:
1141 /* In this state psa_wipe_key_slot() must only be called if the
1142 * caller is the last reader. */
1143 if (slot->registered_readers != 1) {
1144 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1145 status = PSA_ERROR_CORRUPTION_DETECTED;
1146 }
1147 break;
1148 case PSA_SLOT_FILLING:
1149 /* In this state registered_readers must be 0. */
1150 if (slot->registered_readers != 0) {
1151 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1152 status = PSA_ERROR_CORRUPTION_DETECTED;
1153 }
1154 break;
1155 case PSA_SLOT_EMPTY:
1156 /* The slot is already empty, it cannot be wiped. */
1157 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1158 status = PSA_ERROR_CORRUPTION_DETECTED;
1159 break;
1160 default:
1161 /* The slot's state is invalid. */
1162 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001163 }
1164
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001165 /* Multipart operations may still be using the key. This is safe
1166 * because all multipart operation objects are independent from
1167 * the key slot: if they need to access the key after the setup
1168 * phase, they have a copy of the key. Note that this means that
1169 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001170 /* At this point, key material and other type-specific content has
1171 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001172 * zeroize because the metadata is not particularly sensitive.
1173 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 memset(slot, 0, sizeof(*slot));
1175 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001176}
1177
Gilles Peskine449bd832023-01-11 14:50:10 +01001178psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001179{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001180 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001181 psa_status_t status; /* status of the last operation */
1182 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001183#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1184 psa_se_drv_table_entry_t *driver;
1185#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001186
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 if (mbedtls_svc_key_id_is_null(key)) {
1188 return PSA_SUCCESS;
1189 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001190
Ronald Cronf2911112020-10-29 17:51:10 +01001191 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001192 * Get the description of the key in a key slot, and register to read it.
1193 * In the case of a persistent key, this will load the key description
1194 * from persistent memory if not done yet.
1195 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001196 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001197 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 status = psa_get_and_lock_key_slot(key, &slot);
1199 if (status != PSA_SUCCESS) {
1200 return status;
1201 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001202
Ryan Everett7ed542e2024-01-17 11:39:09 +00001203 /* Set the key slot containing the key description's state to
1204 * PENDING_DELETION. This stops new operations from registering
1205 * to read the slot. Current readers can safely continue to access
1206 * the key within the slot; the last registered reader will
1207 * automatically wipe the slot when they call psa_unregister_read().
1208 * If the key is persistent, we can now delete the copy of the key
1209 * from memory. If the key is opaque, we require the driver to
1210 * deal with the deletion. */
Ryan Everettc70ce572024-01-03 16:04:33 +00001211 slot->state = PSA_SLOT_PENDING_DELETION;
Ronald Cronf2911112020-10-29 17:51:10 +01001212
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001214 /* Refuse the destruction of a read-only key (which may or may not work
1215 * if we attempt it, depending on whether the key is merely read-only
1216 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001217 * Just do the best we can, which is to wipe the copy in memory
1218 * (done in this function's cleanup code). */
1219 overall_status = PSA_ERROR_NOT_PERMITTED;
1220 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001221 }
1222
Gilles Peskine354f7672019-07-12 23:46:38 +02001223#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1225 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001226 /* For a key in a secure element, we need to do three things:
1227 * remove the key file in internal storage, destroy the
1228 * key inside the secure element, and update the driver's
1229 * persistent data. Start a transaction that will encompass these
1230 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001232 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001234 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 status = psa_crypto_save_transaction();
1236 if (status != PSA_SUCCESS) {
1237 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001238 /* We should still try to destroy the key in the secure
1239 * element and the key metadata in storage. This is especially
1240 * important if the error is that the storage is full.
1241 * But how to do it exactly without risking an inconsistent
1242 * state after a reset?
1243 * https://github.com/ARMmbed/mbed-crypto/issues/215
1244 */
1245 overall_status = status;
1246 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001247 }
1248
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 status = psa_destroy_se_key(driver,
1250 psa_key_slot_get_slot_number(slot));
1251 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001252 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001253 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001254 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001255#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1256
Darryl Greend49a4992018-06-18 17:27:26 +01001257#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001258 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001259 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001260 * The slot will still hold a copy of the key until the last reader
1261 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001262 status = psa_destroy_persistent_key(slot->attr.id);
1263 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001264 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001265 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001266
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001267 /* TODO: other slots may have a copy of the same key. We should
1268 * invalidate them.
1269 * https://github.com/ARMmbed/mbed-crypto/issues/214
1270 */
Darryl Greend49a4992018-06-18 17:27:26 +01001271 }
1272#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001273
Gilles Peskinefc762652019-07-22 19:30:34 +02001274#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001275 if (driver != NULL) {
1276 status = psa_save_se_persistent_data(driver);
1277 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001278 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001279 }
1280 status = psa_crypto_stop_transaction();
1281 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001282 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001284 }
1285#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1286
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001287exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001288 /* Unregister from reading the slot. If we are the last active reader
1289 * then this will wipe the slot. */
1290 status = psa_unregister_read(slot);
1291 /* Prioritize CORRUPTION_DETECTED from unregistering over
1292 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001294 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 }
1296 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001297}
1298
Valerio Settib2bcedb2023-07-10 11:24:00 +02001299#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001300 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001301static psa_status_t psa_get_rsa_public_exponent(
1302 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001304{
1305 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001307 uint8_t *buffer = NULL;
1308 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001309 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001310
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1312 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001313 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 }
1315 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001316 /* It's the default value, which is reported as an empty string,
1317 * so there's nothing to do. */
1318 goto exit;
1319 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001320
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 buflen = mbedtls_mpi_size(&mpi);
1322 buffer = mbedtls_calloc(1, buflen);
1323 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001324 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1325 goto exit;
1326 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1328 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001329 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001331 attributes->domain_parameters = buffer;
1332 attributes->domain_parameters_size = buflen;
1333
1334exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 mbedtls_mpi_free(&mpi);
1336 if (ret != 0) {
1337 mbedtls_free(buffer);
1338 }
1339 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001340}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001341#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001342 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001343
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001344/** Retrieve all the publicly-accessible attributes of a key.
1345 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001346psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1347 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001348{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001349 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001350 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001351 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001352
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001354
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1356 if (status != PSA_SUCCESS) {
1357 return status;
1358 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001359
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001360 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1362 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001363
1364#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1366 psa_set_key_slot_number(attributes,
1367 psa_key_slot_get_slot_number(slot));
1368 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001369#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001372#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1373 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001374 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001375 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001376 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001377 /* TODO: This is a temporary situation where domain parameters are deprecated,
1378 * but we need it for namely generating an RSA key with a non-default exponent.
1379 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001381 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001382 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001383
Ronald Cron90857082020-11-25 14:58:33 +01001384 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001385 slot->attr.type,
1386 slot->key.data,
1387 slot->key.bytes,
1388 &rsa);
1389 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001390 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001392
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 status = psa_get_rsa_public_exponent(rsa,
1394 attributes);
1395 mbedtls_rsa_free(rsa);
1396 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001397 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001398 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001399#else
1400 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1401 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1402 attributes->domain_parameters = NULL;
1403 attributes->domain_parameters_size = SIZE_MAX;
1404 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001405#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1406 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001407 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001408 default:
1409 /* Nothing else to do. */
1410 break;
1411 }
1412
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 if (status != PSA_SUCCESS) {
1414 psa_reset_key_attributes(attributes);
1415 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001416
Ryan Everett1b70a072024-01-04 10:32:49 +00001417 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001420}
1421
Gilles Peskinec8000c02019-08-02 20:15:51 +02001422#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1423psa_status_t psa_get_key_slot_number(
1424 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001426{
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001428 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 return PSA_SUCCESS;
1430 } else {
1431 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001432 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001433}
1434#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1435
Gilles Peskine449bd832023-01-11 14:50:10 +01001436static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1437 size_t key_buffer_size,
1438 uint8_t *data,
1439 size_t data_size,
1440 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001441{
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 if (key_buffer_size > data_size) {
1443 return PSA_ERROR_BUFFER_TOO_SMALL;
1444 }
1445 memcpy(data, key_buffer, key_buffer_size);
1446 memset(data + key_buffer_size, 0,
1447 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001448 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001450}
1451
Ronald Cron7285cda2020-11-26 14:46:37 +01001452psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001453 const psa_key_attributes_t *attributes,
1454 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001455 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001456{
Ronald Crond18b5f82020-11-25 16:46:05 +01001457 psa_key_type_t type = attributes->core.type;
1458
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 if (key_type_is_raw_bytes(type) ||
1460 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001461 PSA_KEY_TYPE_IS_ECC(type) ||
1462 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 return psa_export_key_buffer_internal(
1464 key_buffer, key_buffer_size,
1465 data, data_size, data_length);
1466 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001467 /* This shouldn't happen in the reference implementation, but
1468 it is valid for a special-purpose implementation to omit
1469 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001470 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001471 }
1472}
1473
Gilles Peskine449bd832023-01-11 14:50:10 +01001474psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
Ryan Everett45ac5262024-01-08 17:15:19 +00001475 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 size_t data_size,
1477 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001478{
1479 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1480 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1481 psa_key_slot_t *slot;
Ryan Everett45ac5262024-01-08 17:15:19 +00001482 LOCAL_OUTPUT_DECLARE(data_external, data);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001483
Ronald Crone907e552021-01-18 13:22:38 +01001484 /* Reject a zero-length output buffer now, since this can never be a
1485 * valid key representation. This way we know that data must be a valid
1486 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 if (data_size == 0) {
1488 return PSA_ERROR_BUFFER_TOO_SMALL;
1489 }
Ronald Crone907e552021-01-18 13:22:38 +01001490
Ronald Cron9486f9d2020-11-26 13:36:23 +01001491 /* Set the key to empty now, so that even when there are errors, we always
1492 * set data_length to a value between 0 and data_size. On error, setting
1493 * the key to empty is a good choice because an empty key representation is
1494 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001495 *data_length = 0;
1496
Ronald Cron9486f9d2020-11-26 13:36:23 +01001497 /* Export requires the EXPORT flag. There is an exception for public keys,
1498 * which don't require any flag, but
1499 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1500 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1502 PSA_KEY_USAGE_EXPORT, 0);
1503 if (status != PSA_SUCCESS) {
1504 return status;
1505 }
mohammad160306e79202018-03-28 13:17:44 +03001506
Ryan Everett45ac5262024-01-08 17:15:19 +00001507 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1508
Ronald Crond18b5f82020-11-25 16:46:05 +01001509 psa_key_attributes_t attributes = {
1510 .core = slot->attr
1511 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 status = psa_driver_wrapper_export_key(&attributes,
1513 slot->key.data, slot->key.bytes,
1514 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001515
Ryan Everett35f68532024-01-25 12:02:03 +00001516#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everett45ac5262024-01-08 17:15:19 +00001517exit:
Ryan Everett35f68532024-01-25 12:02:03 +00001518#endif
Ryan Everett1b70a072024-01-04 10:32:49 +00001519 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001520
Ryan Everett45ac5262024-01-08 17:15:19 +00001521 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001523}
1524
Ronald Cron7285cda2020-11-26 14:46:37 +01001525psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001526 const psa_key_attributes_t *attributes,
1527 const uint8_t *key_buffer,
1528 size_t key_buffer_size,
1529 uint8_t *data,
1530 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001532{
Ronald Crond18b5f82020-11-25 16:46:05 +01001533 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001534
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001535 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001536 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1537 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001538 /* Exporting public -> public */
1539 return psa_export_key_buffer_internal(
1540 key_buffer, key_buffer_size,
1541 data, data_size, data_length);
1542 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001543#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001544 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1545 return mbedtls_psa_rsa_export_public_key(attributes,
1546 key_buffer,
1547 key_buffer_size,
1548 data,
1549 data_size,
1550 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001551#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001552 /* We don't know how to convert a private RSA key to public. */
1553 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001554#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001555 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001556 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001557#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001558 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1559 return mbedtls_psa_ecp_export_public_key(attributes,
1560 key_buffer,
1561 key_buffer_size,
1562 data,
1563 data_size,
1564 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001565#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001566 /* We don't know how to convert a private ECC key to public */
1567 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001568#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001569 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001570 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001571#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001572 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001573 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001574 key_buffer,
1575 key_buffer_size,
1576 data, data_size,
1577 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001578#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001579 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001580#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001581 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001583 (void) key_buffer;
1584 (void) key_buffer_size;
1585 (void) data;
1586 (void) data_size;
1587 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001589 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001590}
Ronald Crond18b5f82020-11-25 16:46:05 +01001591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
Ryan Everettb1d2c672024-01-08 17:19:30 +00001593 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 size_t data_size,
1595 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001596{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001597 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001598 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001599 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001600 psa_key_attributes_t attributes;
Ryan Everettb1d2c672024-01-08 17:19:30 +00001601 LOCAL_OUTPUT_DECLARE(data_external, data);
Darryl Greendd8fb772018-11-07 16:00:44 +00001602
Ronald Crone907e552021-01-18 13:22:38 +01001603 /* Reject a zero-length output buffer now, since this can never be a
1604 * valid key representation. This way we know that data must be a valid
1605 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 if (data_size == 0) {
1607 return PSA_ERROR_BUFFER_TOO_SMALL;
1608 }
Ronald Crone907e552021-01-18 13:22:38 +01001609
Darryl Greendd8fb772018-11-07 16:00:44 +00001610 /* Set the key to empty now, so that even when there are errors, we always
1611 * set data_length to a value between 0 and data_size. On error, setting
1612 * the key to empty is a good choice because an empty key representation is
1613 * unlikely to be accepted anywhere. */
1614 *data_length = 0;
1615
1616 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1618 if (status != PSA_SUCCESS) {
1619 return status;
1620 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001621
Ryan Everettb1d2c672024-01-08 17:19:30 +00001622 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1623
Gilles Peskine449bd832023-01-11 14:50:10 +01001624 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1625 status = PSA_ERROR_INVALID_ARGUMENT;
1626 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001627 }
1628
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001629 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001630 .core = slot->attr
1631 };
Ronald Cron67227982020-11-26 15:16:05 +01001632 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001633 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001635
1636exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001637 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001638
Ryan Everettb1d2c672024-01-08 17:19:30 +00001639 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001640 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001641}
1642
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001643MBEDTLS_STATIC_ASSERT(
1644 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1645 "One or more key attribute flag is listed as both external-only and dual-use")
1646MBEDTLS_STATIC_ASSERT(
1647 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1648 "One or more key attribute flag is listed as both internal-only and dual-use")
1649MBEDTLS_STATIC_ASSERT(
1650 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1651 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001652
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001653/** Validate that a key policy is internally well-formed.
1654 *
1655 * This function only rejects invalid policies. It does not validate the
1656 * consistency of the policy with respect to other attributes of the key
1657 * such as the key type.
1658 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001659static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001660{
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1662 PSA_KEY_USAGE_COPY |
1663 PSA_KEY_USAGE_ENCRYPT |
1664 PSA_KEY_USAGE_DECRYPT |
1665 PSA_KEY_USAGE_SIGN_MESSAGE |
1666 PSA_KEY_USAGE_VERIFY_MESSAGE |
1667 PSA_KEY_USAGE_SIGN_HASH |
1668 PSA_KEY_USAGE_VERIFY_HASH |
1669 PSA_KEY_USAGE_VERIFY_DERIVATION |
1670 PSA_KEY_USAGE_DERIVE)) != 0) {
1671 return PSA_ERROR_INVALID_ARGUMENT;
1672 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001673
Gilles Peskine449bd832023-01-11 14:50:10 +01001674 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001675}
1676
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001677/** Validate the internal consistency of key attributes.
1678 *
1679 * This function only rejects invalid attribute values. If does not
1680 * validate the consistency of the attributes with any key data that may
1681 * be involved in the creation of the key.
1682 *
1683 * Call this function early in the key creation process.
1684 *
1685 * \param[in] attributes Key attributes for the new key.
1686 * \param[out] p_drv On any return, the driver for the key, if any.
1687 * NULL for a transparent key.
1688 *
1689 */
1690static psa_status_t psa_validate_key_attributes(
1691 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001693{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001694 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1696 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698 status = psa_validate_key_location(lifetime, p_drv);
1699 if (status != PSA_SUCCESS) {
1700 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001701 }
1702
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 status = psa_validate_key_persistence(lifetime);
1704 if (status != PSA_SUCCESS) {
1705 return status;
1706 }
1707
1708 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1709 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1710 return PSA_ERROR_INVALID_ARGUMENT;
1711 }
1712 } else {
1713 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1714 return PSA_ERROR_INVALID_ARGUMENT;
1715 }
1716 }
1717
1718 status = psa_validate_key_policy(&attributes->core.policy);
1719 if (status != PSA_SUCCESS) {
1720 return status;
1721 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001722
1723 /* Refuse to create overly large keys.
1724 * Note that this doesn't trigger on import if the attributes don't
1725 * explicitly specify a size (so psa_get_key_bits returns 0), so
1726 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1728 return PSA_ERROR_NOT_SUPPORTED;
1729 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001730
Gilles Peskine91e8c332019-08-02 19:19:39 +02001731 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1733 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1734 return PSA_ERROR_INVALID_ARGUMENT;
1735 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001736
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001738}
1739
Gilles Peskine4747d192019-04-17 15:05:45 +02001740/** Prepare a key slot to receive key material.
1741 *
1742 * This function allocates a key slot and sets its metadata.
1743 *
1744 * If this function fails, call psa_fail_key_creation().
1745 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001746 * This function is intended to be used as follows:
1747 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001748 * it with the specified attributes, and in case of a volatile key assign it
1749 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001750 * -# Populate the slot with the key material.
1751 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1752 * In case of failure at any step, stop the sequence and call
1753 * psa_fail_key_creation().
1754 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001755 * On success, the key slot's state is PSA_SLOT_FILLING.
1756 * It is the responsibility of the caller to change the slot's state to
1757 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001758 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001759 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001760 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001761 * \param[out] p_slot On success, a pointer to the prepared slot.
1762 * \param[out] p_drv On any return, the driver for the key, if any.
1763 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001764 *
1765 * \retval #PSA_SUCCESS
1766 * The key slot is ready to receive key material.
1767 * \return If this function fails, the key slot is an invalid state.
1768 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001769 */
1770static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001771 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001772 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001773 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001775{
1776 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001777 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001778 psa_key_slot_t *slot;
1779
Gilles Peskinedf179142019-07-15 22:02:14 +02001780 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001781 *p_drv = NULL;
1782
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 status = psa_validate_key_attributes(attributes, p_drv);
1784 if (status != PSA_SUCCESS) {
1785 return status;
1786 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001787
Ryan Everettb69118e2024-01-02 15:54:32 +00001788 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 if (status != PSA_SUCCESS) {
1790 return status;
1791 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001792 slot = *p_slot;
1793
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001794 /* We're storing the declared bit-size of the key. It's up to each
1795 * creation mechanism to verify that this information is correct.
1796 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001797 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001798 * is optional (import, copy). In case of a volatile key, assign it the
1799 * volatile key identifier associated to the slot returned to contain its
1800 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001801
1802 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001804#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1805 slot->attr.id = volatile_key_id;
1806#else
1807 slot->attr.id.key_id = volatile_key_id;
1808#endif
1809 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001810
Gilles Peskine91e8c332019-08-02 19:19:39 +02001811 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001812 * external-only flags, query `attributes`. Thanks to the check
1813 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001814 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001815 * may have set. */
1816 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001817
Gilles Peskinecbaff462019-07-12 23:46:04 +02001818#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001819 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001820 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001821 * create the key file in internal storage, create the
1822 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001823 * persistent data. This is done by starting a transaction that will
1824 * encompass these three actions.
1825 * For registering a volatile key, we just need to find an appropriate
1826 * slot number inside the SE. Since the key is designated volatile, creating
1827 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001828 /* The first thing to do is to find a slot number for the new key.
1829 * We save the slot number in persistent storage as part of the
1830 * transaction data. It will be needed to recover if the power
1831 * fails during the key creation process, to clean up on the secure
1832 * element side after restarting. Obtaining a slot number from the
1833 * secure element driver updates its persistent state, but we do not yet
1834 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001835 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001837 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1839 &slot_number);
1840 if (status != PSA_SUCCESS) {
1841 return status;
1842 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001843
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1845 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001846 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001847 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001848 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 status = psa_crypto_save_transaction();
1850 if (status != PSA_SUCCESS) {
1851 (void) psa_crypto_stop_transaction();
1852 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001853 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001854 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001855
1856 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001858 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001859
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001861 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001863 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001864#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1865
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001867}
Gilles Peskine4747d192019-04-17 15:05:45 +02001868
1869/** Finalize the creation of a key once its key material has been set.
1870 *
1871 * This entails writing the key to persistent storage.
1872 *
1873 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001874 * See the documentation of psa_start_key_creation() for the intended use
1875 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001876 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001877 * If the finalization succeeds, the function sets the key slot's state to
1878 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1879 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001880 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001881 * \param[in,out] slot Pointer to the slot with key material.
1882 * \param[in] driver The secure element driver for the key,
1883 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001884 * \param[out] key On success, identifier of the key. Note that the
1885 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001886 *
1887 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001888 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001889 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1890 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1891 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1892 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1893 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1894 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001895 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001896 * \return If this function fails, the key slot is an invalid state.
1897 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001898 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001899static psa_status_t psa_finish_key_creation(
1900 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001901 psa_se_drv_table_entry_t *driver,
1902 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001903{
1904 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001905 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001906 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001907
1908#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001910#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001912 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001913 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001915
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001916 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1917 sizeof(data.slot_number),
1918 "Slot number size does not match psa_se_key_data_storage_t");
1919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1921 status = psa_save_persistent_key(&slot->attr,
1922 (uint8_t *) &data,
1923 sizeof(data));
1924 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001925#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1926 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001927 /* Key material is saved in export representation in the slot, so
1928 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 status = psa_save_persistent_key(&slot->attr,
1930 slot->key.data,
1931 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001932 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001933 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001934#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1935
Gilles Peskinecbaff462019-07-12 23:46:04 +02001936#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001937 /* Finish the transaction for a key creation. This does not
1938 * happen when registering an existing key. Detect this case
1939 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001940 * creation of a persistent key in a secure element requires a transaction,
1941 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 if (driver != NULL &&
1943 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1944 status = psa_save_se_persistent_data(driver);
1945 if (status != PSA_SUCCESS) {
1946 psa_destroy_persistent_key(slot->attr.id);
1947 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001948 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001950 }
1951#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1952
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001954 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001955 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1956 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001958 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001960 }
Ronald Cron50972942020-11-14 11:28:25 +01001961
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001963}
1964
1965/** Abort the creation of a key.
1966 *
1967 * You may call this function after calling psa_start_key_creation(),
1968 * or after psa_finish_key_creation() fails. In other circumstances, this
1969 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001970 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001971 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001972 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001973 * \param[in,out] slot Pointer to the slot with key material.
1974 * \param[in] driver The secure element driver for the key,
1975 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001976 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001977static void psa_fail_key_creation(psa_key_slot_t *slot,
1978 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001979{
Gilles Peskine011e4282019-06-26 18:34:38 +02001980 (void) driver;
1981
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001983 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001985
1986#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001987 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001988 * element, and the failure happened later (when saving metadata
1989 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001990 * element.
1991 * https://github.com/ARMmbed/mbed-crypto/issues/217
1992 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001993
Gilles Peskined7729582019-08-05 15:55:54 +02001994 /* Abort the ongoing transaction if any (there may not be one if
1995 * the creation process failed before starting one, or if the
1996 * key creation is a registration of a key in a secure element).
1997 * Earlier functions must already have done what it takes to undo any
1998 * partial creation. All that's left is to update the transaction data
1999 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002001#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02002004}
2005
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002006/** Validate optional attributes during key creation.
2007 *
2008 * Some key attributes are optional during key creation. If they are
2009 * specified in the attributes structure, check that they are consistent
2010 * with the data in the slot.
2011 *
2012 * This function should be called near the end of key creation, after
2013 * the slot in memory is fully populated but before saving persistent data.
2014 */
2015static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002016 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002018{
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 if (attributes->core.type != 0) {
2020 if (attributes->core.type != slot->attr.type) {
2021 return PSA_ERROR_INVALID_ARGUMENT;
2022 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002023 }
2024
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002026#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2027 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2029 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002030 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002031 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002032 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002033
Ronald Cron90857082020-11-25 14:58:33 +01002034 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 slot->attr.type,
2036 slot->key.data,
2037 slot->key.bytes,
2038 &rsa);
2039 if (status != PSA_SUCCESS) {
2040 return status;
2041 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002042
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 mbedtls_mpi_init(&actual);
2044 mbedtls_mpi_init(&required);
2045 ret = mbedtls_rsa_export(rsa,
2046 NULL, NULL, NULL, NULL, &actual);
2047 mbedtls_rsa_free(rsa);
2048 mbedtls_free(rsa);
2049 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002050 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 }
2052 ret = mbedtls_mpi_read_binary(&required,
2053 attributes->domain_parameters,
2054 attributes->domain_parameters_size);
2055 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002056 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 }
2058 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002059 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 }
2061rsa_exit:
2062 mbedtls_mpi_free(&actual);
2063 mbedtls_mpi_free(&required);
2064 if (ret != 0) {
2065 return mbedtls_to_psa_error(ret);
2066 }
2067 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002068#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2069 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002070 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002071 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002073 }
2074 }
2075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if (attributes->core.bits != 0) {
2077 if (attributes->core.bits != slot->attr.bits) {
2078 return PSA_ERROR_INVALID_ARGUMENT;
2079 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002080 }
2081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002083}
2084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everettf028fe12024-01-08 17:14:44 +00002086 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 size_t data_length,
2088 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002089{
2090 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002091 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002092 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002093 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002094 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302095 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002096
Ronald Cron81709fc2020-11-14 12:10:32 +01002097 *key = MBEDTLS_SVC_KEY_ID_INIT;
2098
Gilles Peskine0f84d622019-09-12 19:03:13 +02002099 /* Reject zero-length symmetric keys (including raw data key objects).
2100 * This also rejects any key which might be encoded as an empty string,
2101 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 if (data_length == 0) {
2103 return PSA_ERROR_INVALID_ARGUMENT;
2104 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002105
Archana449608b2021-09-08 15:36:05 +05302106 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (data_length > SIZE_MAX / 8) {
2108 return PSA_ERROR_NOT_SUPPORTED;
2109 }
Archana6ed4bda2021-08-04 10:47:15 +05302110
Ryan Everettf028fe12024-01-08 17:14:44 +00002111 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2112
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2114 &slot, &driver);
2115 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002116 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002118
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002119 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302120 * storage ( thus not in the case of importing a key in a secure element
2121 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2122 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 if (slot->key.data == NULL) {
2124 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302125 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 attributes, data, data_length, &storage_size);
2127 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302128 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 }
Archanad8a83dc2021-06-14 10:04:16 +05302130 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 status = psa_allocate_buffer_to_slot(slot, storage_size);
2132 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002133 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002135 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002136
2137 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 status = psa_driver_wrapper_import_key(attributes,
2139 data, data_length,
2140 slot->key.data,
2141 slot->key.bytes,
2142 &slot->key.bytes, &bits);
2143 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002144 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002146
Gilles Peskine449bd832023-01-11 14:50:10 +01002147 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002148 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002150 status = PSA_ERROR_INVALID_ARGUMENT;
2151 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002152 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002153
Archana6ed4bda2021-08-04 10:47:15 +05302154 /* Enforce a size limit, and in particular ensure that the bit
2155 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302157 status = PSA_ERROR_NOT_SUPPORTED;
2158 goto exit;
2159 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 status = psa_validate_optional_attributes(slot, attributes);
2161 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002162 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002164
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002166exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002167 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (status != PSA_SUCCESS) {
2169 psa_fail_key_creation(slot, driver);
2170 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002171
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002173}
2174
Gilles Peskined7729582019-08-05 15:55:54 +02002175#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2176psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002178{
2179 psa_status_t status;
2180 psa_key_slot_t *slot = NULL;
2181 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002182 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002183
2184 /* Leaving attributes unspecified is not currently supported.
2185 * It could make sense to query the key type and size from the
2186 * secure element, but not all secure elements support this
2187 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2189 return PSA_ERROR_NOT_SUPPORTED;
2190 }
2191 if (psa_get_key_bits(attributes) == 0) {
2192 return PSA_ERROR_NOT_SUPPORTED;
2193 }
Gilles Peskined7729582019-08-05 15:55:54 +02002194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2196 &slot, &driver);
2197 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002198 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 }
Gilles Peskined7729582019-08-05 15:55:54 +02002200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002202
2203exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if (status != PSA_SUCCESS) {
2205 psa_fail_key_creation(slot, driver);
2206 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002207
Gilles Peskined7729582019-08-05 15:55:54 +02002208 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 psa_close_key(key);
2210 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002211}
2212#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2215 const psa_key_attributes_t *specified_attributes,
2216 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002217{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002218 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002219 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002220 psa_key_slot_t *source_slot = NULL;
2221 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002222 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002223 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302224 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002225
Ronald Cron81709fc2020-11-14 12:10:32 +01002226 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2227
Archana8a180362021-07-05 02:18:48 +05302228 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2230 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002231 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002233
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 status = psa_validate_optional_attributes(source_slot,
2235 specified_attributes);
2236 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002237 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002239
Archana9d17bf42021-09-10 06:22:44 +05302240 /* The target key type and number of bits have been validated by
2241 * psa_validate_optional_attributes() to be either equal to zero or
2242 * equal to the ones of the source key. So it is safe to inherit
2243 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302244 * */
Archana9d17bf42021-09-10 06:22:44 +05302245 actual_attributes.core.bits = source_slot->attr.bits;
2246 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302247
2248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 status = psa_restrict_key_policy(source_slot->attr.type,
2250 &actual_attributes.core.policy,
2251 &source_slot->attr.policy);
2252 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002253 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2257 &target_slot, &driver);
2258 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002259 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 }
2261 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2262 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302263 /*
Archana9d17bf42021-09-10 06:22:44 +05302264 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302265 * the source key would need to be exported as plaintext and re-imported
2266 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302267 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302268 * appropriate API invocations from the application, if needed.
2269 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002270 status = PSA_ERROR_NOT_SUPPORTED;
2271 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002272 }
Archana8a180362021-07-05 02:18:48 +05302273 /*
2274 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302275 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302276 * - For opaque keys this translates to an invocation of the drivers'
2277 * copy_key entry point through the dispatch layer.
2278 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2280 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2281 &storage_size);
2282 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302283 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 }
Archana374fe5b2021-09-08 15:50:28 +05302285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2287 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302288 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 }
Archana374fe5b2021-09-08 15:50:28 +05302290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 status = psa_driver_wrapper_copy_key(&actual_attributes,
2292 source_slot->key.data,
2293 source_slot->key.bytes,
2294 target_slot->key.data,
2295 target_slot->key.bytes,
2296 &target_slot->key.bytes);
2297 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302298 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 }
2300 } else {
2301 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302302 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 source_slot->key.bytes);
2304 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302305 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 }
Archana8a180362021-07-05 02:18:48 +05302307 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002309exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 if (status != PSA_SUCCESS) {
2311 psa_fail_key_creation(target_slot, driver);
2312 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002313
Ryan Everett1b70a072024-01-04 10:32:49 +00002314 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002317}
2318
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002319
2320
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002321/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002322/* Message digests */
2323/****************************************************************/
2324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002326{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002327 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 if (operation->id == 0) {
2329 return PSA_SUCCESS;
2330 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002333 operation->id = 0;
2334
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002336}
2337
Gilles Peskine449bd832023-01-11 14:50:10 +01002338psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2339 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002340{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002341 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002342
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002343 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002345 status = PSA_ERROR_BAD_STATE;
2346 goto exit;
2347 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002348
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002350 status = PSA_ERROR_INVALID_ARGUMENT;
2351 goto exit;
2352 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002353
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002354 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2355 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002359
2360exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (status != PSA_SUCCESS) {
2362 psa_hash_abort(operation);
2363 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002364
2365 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002366}
2367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368psa_status_t psa_hash_update(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002369 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002371{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002372 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002373 LOCAL_INPUT_DECLARE(input_external, input);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002374
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002376 status = PSA_ERROR_BAD_STATE;
2377 goto exit;
2378 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002379
Steven Cooremanc8288352021-03-04 14:02:19 +01002380 /* Don't require hash implementations to behave correctly on a
2381 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 if (input_length == 0) {
2383 return PSA_SUCCESS;
2384 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002385
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002386 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002388
2389exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 if (status != PSA_SUCCESS) {
2391 psa_hash_abort(operation);
2392 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002393
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002394 LOCAL_INPUT_FREE(input_external, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002396}
2397
Thomas Daubney31d8c0b2024-01-18 15:26:59 +00002398static psa_status_t psa_hash_finish_internal(psa_hash_operation_t *operation,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002399 uint8_t *hash,
2400 size_t hash_size,
2401 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002402{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2404
Steven Cooremanfbe09282021-03-08 18:41:12 +01002405 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 if (operation->id == 0) {
2407 return PSA_ERROR_BAD_STATE;
2408 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002409
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002410 status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 operation, hash, hash_size, hash_length);
2412 psa_hash_abort(operation);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002413
2414 return status;
2415}
2416
2417psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2418 uint8_t *hash_external,
2419 size_t hash_size,
2420 size_t *hash_length)
2421{
2422 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2423 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2424
2425 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2426 status = psa_hash_finish_internal(operation, hash, hash_size, hash_length);
2427
Thomas Daubneydedd1002024-01-25 16:52:50 +00002428#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002429exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002430#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002431 LOCAL_OUTPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002433}
2434
Gilles Peskine449bd832023-01-11 14:50:10 +01002435psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002436 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002438{
Ronald Cron69a63422021-10-18 09:47:58 +02002439 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002440 size_t actual_hash_length;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002441 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2442 LOCAL_INPUT_DECLARE(hash_external, hash);
2443
2444 status = psa_hash_finish_internal(
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 operation,
2446 actual_hash, sizeof(actual_hash),
2447 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002448
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002450 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002454 status = PSA_ERROR_INVALID_SIGNATURE;
2455 goto exit;
2456 }
2457
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002458 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002459 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002460 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002462
2463exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2465 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002466 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 }
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002468 LOCAL_INPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002470}
2471
Gilles Peskine449bd832023-01-11 14:50:10 +01002472psa_status_t psa_hash_compute(psa_algorithm_t alg,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002473 const uint8_t *input_external, size_t input_length,
2474 uint8_t *hash_external, size_t hash_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002476{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002477 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2478 LOCAL_INPUT_DECLARE(input_external, input);
2479 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2480
Steven Cooremanfbe09282021-03-08 18:41:12 +01002481 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 if (!PSA_ALG_IS_HASH(alg)) {
2483 return PSA_ERROR_INVALID_ARGUMENT;
2484 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002485
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002486 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2487 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2488 status = psa_driver_wrapper_hash_compute(alg, input, input_length,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002489 hash, hash_size, hash_length);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002490
Thomas Daubneydedd1002024-01-25 16:52:50 +00002491#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002492exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002493#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002494 LOCAL_INPUT_FREE(input_external, input);
2495 LOCAL_OUTPUT_FREE(hash_external, hash);
2496 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002497}
2498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499psa_status_t psa_hash_compare(psa_algorithm_t alg,
Thomas Daubney51ffac92024-01-18 15:46:26 +00002500 const uint8_t *input_external, size_t input_length,
2501 const uint8_t *hash_external, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002502{
Ronald Cron69a63422021-10-18 09:47:58 +02002503 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002504 size_t actual_hash_length;
Thomas Daubney51ffac92024-01-18 15:46:26 +00002505 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2506
2507 LOCAL_INPUT_DECLARE(input_external, input);
2508 LOCAL_INPUT_DECLARE(hash_external, hash);
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002509
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 if (!PSA_ALG_IS_HASH(alg)) {
Thomas Daubney51ffac92024-01-18 15:46:26 +00002511 status = PSA_ERROR_INVALID_ARGUMENT;
2512 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002514
Thomas Daubney51ffac92024-01-18 15:46:26 +00002515 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2516 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 alg, input, input_length,
2518 actual_hash, sizeof(actual_hash),
2519 &actual_hash_length);
2520 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002521 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 }
2523 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002524 status = PSA_ERROR_INVALID_SIGNATURE;
2525 goto exit;
2526 }
Thomas Daubney51ffac92024-01-18 15:46:26 +00002527
2528 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002529 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002530 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002532
2533exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
Thomas Daubney51ffac92024-01-18 15:46:26 +00002535
2536 LOCAL_INPUT_FREE(input_external, input);
2537 LOCAL_INPUT_FREE(hash_external, hash);
2538
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002540}
2541
Gilles Peskine449bd832023-01-11 14:50:10 +01002542psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2543 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002544{
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 if (source_operation->id == 0 ||
2546 target_operation->id != 0) {
2547 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002548 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2551 target_operation);
2552 if (status != PSA_SUCCESS) {
2553 psa_hash_abort(target_operation);
2554 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002557}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002558
2559
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002560/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002561/* MAC */
2562/****************************************************************/
2563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002565{
Steven Cooremane6804192021-03-19 18:28:56 +01002566 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 if (operation->id == 0) {
2568 return PSA_SUCCESS;
2569 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002570
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002572 operation->mac_size = 0;
2573 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002574 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002577}
2578
Ronald Cron2dff3b22021-06-17 16:33:22 +02002579static psa_status_t psa_mac_finalize_alg_and_key_validation(
2580 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002581 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002583{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002584 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 psa_key_type_t key_type = psa_get_key_type(attributes);
2586 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 if (!PSA_ALG_IS_MAC(alg)) {
2589 return PSA_ERROR_INVALID_ARGUMENT;
2590 }
Steven Cooremane6804192021-03-19 18:28:56 +01002591
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002592 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 status = psa_mac_key_can_do(alg, key_type);
2594 if (status != PSA_SUCCESS) {
2595 return status;
2596 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002597
Steven Cooremand1a68f12021-05-10 11:13:41 +02002598 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002602 /* A very short MAC is too short for security since it can be
2603 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2604 * so we make this our minimum, even though 32 bits is still
2605 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002607 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2610 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002611 /* It's impossible to "truncate" to a larger length than the full length
2612 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002614 }
2615
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002617 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2618 * that is disabled in the compile-time configuration. The result can
2619 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2620 * configuration into account. In this case, force a return of
2621 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2622 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2623 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2624 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2625 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002627 }
2628
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002630}
2631
Gilles Peskine449bd832023-01-11 14:50:10 +01002632static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2633 mbedtls_svc_key_id_t key,
2634 psa_algorithm_t alg,
2635 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002636{
2637 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2638 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002639 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002640 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002641
2642 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002644 status = PSA_ERROR_BAD_STATE;
2645 goto exit;
2646 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002647
2648 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 key,
2650 &slot,
2651 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2652 alg);
2653 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002654 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002656
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002657 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002658 .core = slot->attr
2659 };
2660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2662 &operation->mac_size);
2663 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002664 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002666
2667 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002668 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 if (is_sign) {
2670 status = psa_driver_wrapper_mac_sign_setup(operation,
2671 &attributes,
2672 slot->key.data,
2673 slot->key.bytes,
2674 alg);
2675 } else {
2676 status = psa_driver_wrapper_mac_verify_setup(operation,
2677 &attributes,
2678 slot->key.data,
2679 slot->key.bytes,
2680 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002681 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002682
Gilles Peskinefbfac682018-07-08 20:51:54 +02002683exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 if (status != PSA_SUCCESS) {
2685 psa_mac_abort(operation);
2686 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002687
Ryan Everett1b70a072024-01-04 10:32:49 +00002688 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002691}
2692
Gilles Peskine449bd832023-01-11 14:50:10 +01002693psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2694 mbedtls_svc_key_id_t key,
2695 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002696{
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002698}
2699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2701 mbedtls_svc_key_id_t key,
2702 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002703{
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002705}
2706
Gilles Peskine449bd832023-01-11 14:50:10 +01002707psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2708 const uint8_t *input,
2709 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002710{
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 if (operation->id == 0) {
2712 return PSA_ERROR_BAD_STATE;
2713 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002714
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002715 /* Don't require hash implementations to behave correctly on a
2716 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 if (input_length == 0) {
2718 return PSA_SUCCESS;
2719 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002720
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2722 input, input_length);
2723 if (status != PSA_SUCCESS) {
2724 psa_mac_abort(operation);
2725 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002728}
2729
Gilles Peskine449bd832023-01-11 14:50:10 +01002730psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2731 uint8_t *mac,
2732 size_t mac_size,
2733 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002734{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002735 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2736 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002737
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002739 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002740 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002741 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002744 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002745 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002746 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002747
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002748 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2749 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002751 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002752 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002753 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002754
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002756 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002757 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002758 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002759
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 status = psa_driver_wrapper_mac_sign_finish(operation,
2761 mac, operation->mac_size,
2762 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002763
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002764exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002765 /* In case of success, set the potential excess room in the output buffer
2766 * to an invalid value, to avoid potentially leaking a longer MAC.
2767 * In case of error, set the output length and content to a safe default,
2768 * such that in case the caller misses an error check, the output would be
2769 * an unachievable MAC.
2770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002772 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002773 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002774 }
mohammad16036df908f2018-04-02 08:34:15 -07002775
Paul Elliottdc42ca82023-02-24 18:11:59 +00002776 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002777
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002779
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002781}
2782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2784 const uint8_t *mac,
2785 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002786{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002787 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2788 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002791 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002792 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002793 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002796 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002797 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002798 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002801 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002802 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002803 }
2804
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 status = psa_driver_wrapper_mac_verify_finish(operation,
2806 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002807
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002808exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002810
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002812}
2813
Gilles Peskine449bd832023-01-11 14:50:10 +01002814static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2815 psa_algorithm_t alg,
2816 const uint8_t *input,
2817 size_t input_length,
2818 uint8_t *mac,
2819 size_t mac_size,
2820 size_t *mac_length,
2821 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002822{
2823 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002824 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2825 psa_key_slot_t *slot;
2826 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002827 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002828
Ronald Cron51131b52021-06-17 17:17:20 +02002829 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 key,
2831 &slot,
2832 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2833 alg);
2834 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002835 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002837
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002838 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002839 .core = slot->attr
2840 };
2841
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2843 &operation_mac_size);
2844 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002845 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002847
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002849 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002850 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002851 }
2852
2853 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 &attributes,
2855 slot->key.data, slot->key.bytes,
2856 alg,
2857 input, input_length,
2858 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002859
2860exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002861 /* In case of success, set the potential excess room in the output buffer
2862 * to an invalid value, to avoid potentially leaking a longer MAC.
2863 * In case of error, set the output length and content to a safe default,
2864 * such that in case the caller misses an error check, the output would be
2865 * an unachievable MAC.
2866 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002868 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002869 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002870 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002871
2872 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002873
Ryan Everett1b70a072024-01-04 10:32:49 +00002874 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002877}
2878
Gilles Peskine449bd832023-01-11 14:50:10 +01002879psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002880 psa_algorithm_t alg,
2881 const uint8_t *input,
2882 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 uint8_t *mac,
2884 size_t mac_size,
2885 size_t *mac_length)
2886{
2887 return psa_mac_compute_internal(key, alg,
2888 input, input_length,
2889 mac, mac_size, mac_length, 1);
2890}
2891
2892psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2893 psa_algorithm_t alg,
2894 const uint8_t *input,
2895 size_t input_length,
2896 const uint8_t *mac,
2897 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002898{
2899 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002900 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2901 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002902
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 status = psa_mac_compute_internal(key, alg,
2904 input, input_length,
2905 actual_mac, sizeof(actual_mac),
2906 &actual_mac_length, 0);
2907 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002908 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002912 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002913 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002914 }
Dave Rodgman78701152023-08-29 14:20:18 +01002915 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002916 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002917 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002918 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002919
2920exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002922
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002924}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002925
Gilles Peskinee59236f2018-01-27 23:32:46 +01002926/****************************************************************/
2927/* Asymmetric cryptography */
2928/****************************************************************/
2929
Gilles Peskine449bd832023-01-11 14:50:10 +01002930static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2931 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002932{
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 if (input_is_message) {
2934 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2935 return PSA_ERROR_INVALID_ARGUMENT;
2936 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2939 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2940 return PSA_ERROR_INVALID_ARGUMENT;
2941 }
2942 }
2943 } else {
2944 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2945 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002946 }
2947 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002950}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002951
Gilles Peskine449bd832023-01-11 14:50:10 +01002952static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2953 int input_is_message,
2954 psa_algorithm_t alg,
2955 const uint8_t *input,
2956 size_t input_length,
2957 uint8_t *signature,
2958 size_t signature_size,
2959 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002960{
2961 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2962 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2963 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002964 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002965
2966 *signature_length = 0;
2967
Gilles Peskine449bd832023-01-11 14:50:10 +01002968 status = psa_sign_verify_check_alg(input_is_message, alg);
2969 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002970 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002972
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002973 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002974 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002975 * buffer can in principle be empty since it doesn't actually have
2976 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 if (signature_size == 0) {
2978 return PSA_ERROR_BUFFER_TOO_SMALL;
2979 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002980
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002981 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 key, &slot,
2983 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2984 PSA_KEY_USAGE_SIGN_HASH,
2985 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002986
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002988 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002989 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002990
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002992 status = PSA_ERROR_INVALID_ARGUMENT;
2993 goto exit;
2994 }
2995
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002996 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002998 };
2999
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003001 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003002 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003003 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 signature, signature_size, signature_length);
3005 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003006
3007 status = psa_driver_wrapper_sign_hash(
3008 &attributes, slot->key.data, slot->key.bytes,
3009 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003011 }
3012
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003013
3014exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003015 psa_wipe_tag_output_buffer(signature, status, signature_size,
3016 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003017
Ryan Everett1b70a072024-01-04 10:32:49 +00003018 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003019
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003021}
3022
Gilles Peskine449bd832023-01-11 14:50:10 +01003023static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3024 int input_is_message,
3025 psa_algorithm_t alg,
3026 const uint8_t *input,
3027 size_t input_length,
3028 const uint8_t *signature,
3029 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003030{
3031 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3032 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3033 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003034
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 status = psa_sign_verify_check_alg(input_is_message, alg);
3036 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003037 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003039
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003040 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 key, &slot,
3042 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3043 PSA_KEY_USAGE_VERIFY_HASH,
3044 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 if (status != PSA_SUCCESS) {
3047 return status;
3048 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003049
3050 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003052 };
3053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003055 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003056 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003057 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 signature, signature_length);
3059 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003060 status = psa_driver_wrapper_verify_hash(
3061 &attributes, slot->key.data, slot->key.bytes,
3062 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003064 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003065
Ryan Everett1b70a072024-01-04 10:32:49 +00003066 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003069
3070}
3071
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003072psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003073 const psa_key_attributes_t *attributes,
3074 const uint8_t *key_buffer,
3075 size_t key_buffer_size,
3076 psa_algorithm_t alg,
3077 const uint8_t *input,
3078 size_t input_length,
3079 uint8_t *signature,
3080 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003082{
3083 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003086 size_t hash_length;
3087 uint8_t hash[PSA_HASH_MAX_SIZE];
3088
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003089 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 PSA_ALG_SIGN_GET_HASH(alg),
3091 input, input_length,
3092 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003093
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003095 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003097
3098 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 attributes, key_buffer, key_buffer_size,
3100 alg, hash, hash_length,
3101 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003102 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003105}
3106
Gilles Peskine449bd832023-01-11 14:50:10 +01003107psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3108 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003109 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003111 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 size_t signature_size,
3113 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003114{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003115 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3116 LOCAL_INPUT_DECLARE(input_external, input);
3117 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3118
3119 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3120 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3121 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3122 signature_size, signature_length);
3123
Thomas Daubney3e65f522024-01-30 12:37:25 +00003124#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003125exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003126#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003127 LOCAL_INPUT_FREE(input_external, input);
3128 LOCAL_OUTPUT_FREE(signature_external, signature);
3129 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003130}
3131
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003132psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003133 const psa_key_attributes_t *attributes,
3134 const uint8_t *key_buffer,
3135 size_t key_buffer_size,
3136 psa_algorithm_t alg,
3137 const uint8_t *input,
3138 size_t input_length,
3139 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003141{
3142 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003143
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003145 size_t hash_length;
3146 uint8_t hash[PSA_HASH_MAX_SIZE];
3147
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003148 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 PSA_ALG_SIGN_GET_HASH(alg),
3150 input, input_length,
3151 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003152
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003154 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003155 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003156
3157 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 attributes, key_buffer, key_buffer_size,
3159 alg, hash, hash_length,
3160 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003161 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003162
Gilles Peskine449bd832023-01-11 14:50:10 +01003163 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003164}
3165
Gilles Peskine449bd832023-01-11 14:50:10 +01003166psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3167 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003168 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003169 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003170 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003172{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003173 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3174 LOCAL_INPUT_DECLARE(input_external, input);
3175 LOCAL_INPUT_DECLARE(signature_external, signature);
3176
3177 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3178 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3179 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3180 signature_length);
3181
Thomas Daubney3e65f522024-01-30 12:37:25 +00003182#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003183exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003184#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003185 LOCAL_INPUT_FREE(input_external, input);
3186 LOCAL_INPUT_FREE(signature_external, signature);
3187
3188 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003189}
3190
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003191psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003192 const psa_key_attributes_t *attributes,
3193 const uint8_t *key_buffer, size_t key_buffer_size,
3194 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003195 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003196{
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3198 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3199 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003200#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003201 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3202 return mbedtls_psa_rsa_sign_hash(
3203 attributes,
3204 key_buffer, key_buffer_size,
3205 alg, hash, hash_length,
3206 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003207#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3208 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003209 } else {
3210 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003211 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3213 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003214#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003215 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3216 return mbedtls_psa_ecdsa_sign_hash(
3217 attributes,
3218 key_buffer, key_buffer_size,
3219 alg, hash, hash_length,
3220 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003221#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3222 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003223 } else {
3224 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003225 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003226 }
Ronald Cron4501c982021-03-19 20:09:32 +01003227
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 (void) key_buffer;
3229 (void) key_buffer_size;
3230 (void) hash;
3231 (void) hash_length;
3232 (void) signature;
3233 (void) signature_size;
3234 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003235
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003237}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003238
Gilles Peskine449bd832023-01-11 14:50:10 +01003239psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3240 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003241 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003243 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 size_t signature_size,
3245 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003246{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003247 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3248 LOCAL_INPUT_DECLARE(hash_external, hash);
3249 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3250
3251 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3252 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3253 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3254 signature_size, signature_length);
3255
Thomas Daubney3e65f522024-01-30 12:37:25 +00003256#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003257exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003258#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003259 LOCAL_INPUT_FREE(hash_external, hash);
3260 LOCAL_OUTPUT_FREE(signature_external, signature);
3261
3262 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003263}
3264
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003265psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003266 const psa_key_attributes_t *attributes,
3267 const uint8_t *key_buffer, size_t key_buffer_size,
3268 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003270{
Gilles Peskine449bd832023-01-11 14:50:10 +01003271 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3272 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3273 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003274#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003275 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3276 return mbedtls_psa_rsa_verify_hash(
3277 attributes,
3278 key_buffer, key_buffer_size,
3279 alg, hash, hash_length,
3280 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003281#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3282 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003283 } else {
3284 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003285 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3287 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003288#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003289 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3290 return mbedtls_psa_ecdsa_verify_hash(
3291 attributes,
3292 key_buffer, key_buffer_size,
3293 alg, hash, hash_length,
3294 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003295#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3296 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 } else {
3298 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003299 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003300 }
Ronald Cron4501c982021-03-19 20:09:32 +01003301
Gilles Peskine449bd832023-01-11 14:50:10 +01003302 (void) key_buffer;
3303 (void) key_buffer_size;
3304 (void) hash;
3305 (void) hash_length;
3306 (void) signature;
3307 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003308
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003310}
3311
Gilles Peskine449bd832023-01-11 14:50:10 +01003312psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3313 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003314 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003316 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003318{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003319 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3320 LOCAL_INPUT_DECLARE(hash_external, hash);
3321 LOCAL_INPUT_DECLARE(signature_external, signature);
3322
3323 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3324 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3325 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3326 signature_length);
3327
Thomas Daubney3e65f522024-01-30 12:37:25 +00003328#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003329exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003330#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003331 LOCAL_INPUT_FREE(hash_external, hash);
3332 LOCAL_INPUT_FREE(signature_external, signature);
3333
3334 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003335}
3336
Gilles Peskine449bd832023-01-11 14:50:10 +01003337psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3338 psa_algorithm_t alg,
3339 const uint8_t *input,
3340 size_t input_length,
3341 const uint8_t *salt,
3342 size_t salt_length,
3343 uint8_t *output,
3344 size_t output_size,
3345 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003346{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003347 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003348 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003349 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003350 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003351
Darryl Green5cc689a2018-07-24 15:34:10 +01003352 (void) input;
3353 (void) input_length;
3354 (void) salt;
3355 (void) output;
3356 (void) output_size;
3357
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003358 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003359
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3361 return PSA_ERROR_INVALID_ARGUMENT;
3362 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003363
Valerio Setti5bb454a2024-01-15 10:43:16 +01003364 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3366 if (status != PSA_SUCCESS) {
3367 return status;
3368 }
3369 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3370 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003371 status = PSA_ERROR_INVALID_ARGUMENT;
3372 goto exit;
3373 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003374
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003375 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003376 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003377 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003378
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003379 status = psa_driver_wrapper_asymmetric_encrypt(
3380 &attributes, slot->key.data, slot->key.bytes,
3381 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003383exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003384 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003385
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003387}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003388
Gilles Peskine449bd832023-01-11 14:50:10 +01003389psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3390 psa_algorithm_t alg,
3391 const uint8_t *input,
3392 size_t input_length,
3393 const uint8_t *salt,
3394 size_t salt_length,
3395 uint8_t *output,
3396 size_t output_size,
3397 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003398{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003399 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003400 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003401 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003402 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003403
Darryl Green5cc689a2018-07-24 15:34:10 +01003404 (void) input;
3405 (void) input_length;
3406 (void) salt;
3407 (void) output;
3408 (void) output_size;
3409
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003410 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003411
Gilles Peskine449bd832023-01-11 14:50:10 +01003412 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3413 return PSA_ERROR_INVALID_ARGUMENT;
3414 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003415
Valerio Setti5bb454a2024-01-15 10:43:16 +01003416 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003417 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3418 if (status != PSA_SUCCESS) {
3419 return status;
3420 }
3421 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003422 status = PSA_ERROR_INVALID_ARGUMENT;
3423 goto exit;
3424 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003425
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003426 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003427 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003428 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003429
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003430 status = psa_driver_wrapper_asymmetric_decrypt(
3431 &attributes, slot->key.data, slot->key.bytes,
3432 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003433 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003434
3435exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003436 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003437
Gilles Peskine449bd832023-01-11 14:50:10 +01003438 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003439}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003440
Paul Elliott9fe12f62022-11-30 19:16:02 +00003441/****************************************************************/
3442/* Asymmetric interruptible cryptography */
3443/****************************************************************/
3444
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003445static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3446
Paul Elliott9fe12f62022-11-30 19:16:02 +00003447void psa_interruptible_set_max_ops(uint32_t max_ops)
3448{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003449 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003450}
3451
3452uint32_t psa_interruptible_get_max_ops(void)
3453{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003454 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003455}
3456
Paul Elliott9fe12f62022-11-30 19:16:02 +00003457uint32_t psa_sign_hash_get_num_ops(
3458 const psa_sign_hash_interruptible_operation_t *operation)
3459{
Paul Elliott296ede92022-12-15 17:00:30 +00003460 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003461}
3462
3463uint32_t psa_verify_hash_get_num_ops(
3464 const psa_verify_hash_interruptible_operation_t *operation)
3465{
Paul Elliott296ede92022-12-15 17:00:30 +00003466 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003467}
3468
Paul Elliott59ad9452022-12-18 15:09:02 +00003469static psa_status_t psa_sign_hash_abort_internal(
3470 psa_sign_hash_interruptible_operation_t *operation)
3471{
3472 if (operation->id == 0) {
3473 /* The object has (apparently) been initialized but it is not (yet)
3474 * in use. It's ok to call abort on such an object, and there's
3475 * nothing to do. */
3476 return PSA_SUCCESS;
3477 }
3478
3479 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3480
3481 status = psa_driver_wrapper_sign_hash_abort(operation);
3482
3483 operation->id = 0;
3484
Paul Elliotte6145dc2023-02-07 12:51:21 +00003485 /* Do not clear either the error_occurred or num_ops elements here as they
3486 * only want to be cleared by the application calling abort, not by abort
3487 * being called at completion of an operation. */
3488
Paul Elliott59ad9452022-12-18 15:09:02 +00003489 return status;
3490}
3491
Paul Elliott9fe12f62022-11-30 19:16:02 +00003492psa_status_t psa_sign_hash_start(
3493 psa_sign_hash_interruptible_operation_t *operation,
3494 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3495 const uint8_t *hash, size_t hash_length)
3496{
3497 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3498 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3499 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003500 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003501
Paul Elliottc9774412023-02-06 15:14:07 +00003502 /* Check that start has not been previously called, or operation has not
3503 * previously errored. */
3504 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003505 return PSA_ERROR_BAD_STATE;
3506 }
3507
Paul Elliott9fe12f62022-11-30 19:16:02 +00003508 status = psa_sign_verify_check_alg(0, alg);
3509 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003510 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003511 return status;
3512 }
3513
3514 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3515 PSA_KEY_USAGE_SIGN_HASH,
3516 alg);
3517
3518 if (status != PSA_SUCCESS) {
3519 goto exit;
3520 }
3521
3522 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3523 status = PSA_ERROR_INVALID_ARGUMENT;
3524 goto exit;
3525 }
3526
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003527 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003528 .core = slot->attr
3529 };
3530
Paul Elliott296ede92022-12-15 17:00:30 +00003531 /* Ensure ops count gets reset, in case of operation re-use. */
3532 operation->num_ops = 0;
3533
Paul Elliott9fe12f62022-11-30 19:16:02 +00003534 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3535 slot->key.data,
3536 slot->key.bytes, alg,
3537 hash, hash_length);
3538exit:
3539
3540 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003541 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003542 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003543 }
3544
Ryan Everett1b70a072024-01-04 10:32:49 +00003545 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003546
Paul Elliottc9774412023-02-06 15:14:07 +00003547 if (unlock_status != PSA_SUCCESS) {
3548 operation->error_occurred = 1;
3549 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003550
Paul Elliottc9774412023-02-06 15:14:07 +00003551 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003552}
3553
3554
3555psa_status_t psa_sign_hash_complete(
3556 psa_sign_hash_interruptible_operation_t *operation,
3557 uint8_t *signature, size_t signature_size,
3558 size_t *signature_length)
3559{
3560 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3561
3562 *signature_length = 0;
3563
Paul Elliottc9774412023-02-06 15:14:07 +00003564 /* Check that start has been called first, and that operation has not
3565 * previously errored. */
3566 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003567 status = PSA_ERROR_BAD_STATE;
3568 goto exit;
3569 }
3570
Paul Elliott096abc42023-02-03 18:33:23 +00003571 /* Immediately reject a zero-length signature buffer. This guarantees that
3572 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003573 if (signature_size == 0) {
3574 status = PSA_ERROR_BUFFER_TOO_SMALL;
3575 goto exit;
3576 }
3577
3578 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3579 signature_size,
3580 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003581
Paul Elliott296ede92022-12-15 17:00:30 +00003582 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003583 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003584
Paul Elliottebe225c2023-02-10 14:32:53 +00003585exit:
3586
Paul Elliott59200a22023-02-21 15:07:40 +00003587 psa_wipe_tag_output_buffer(signature, status, signature_size,
3588 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003589
Paul Elliott53bb3122023-02-10 14:22:22 +00003590 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003591 if (status != PSA_SUCCESS) {
3592 operation->error_occurred = 1;
3593 }
3594
Paul Elliott59ad9452022-12-18 15:09:02 +00003595 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003596 }
3597
3598 return status;
3599}
3600
3601psa_status_t psa_sign_hash_abort(
3602 psa_sign_hash_interruptible_operation_t *operation)
3603{
Paul Elliott59ad9452022-12-18 15:09:02 +00003604 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3605
3606 status = psa_sign_hash_abort_internal(operation);
3607
3608 /* We clear the number of ops done here, so that it is not cleared when
3609 * the operation fails or succeeds, only on manual abort. */
3610 operation->num_ops = 0;
3611
Paul Elliottc9774412023-02-06 15:14:07 +00003612 /* Likewise, failure state. */
3613 operation->error_occurred = 0;
3614
Paul Elliott59ad9452022-12-18 15:09:02 +00003615 return status;
3616}
3617
3618static psa_status_t psa_verify_hash_abort_internal(
3619 psa_verify_hash_interruptible_operation_t *operation)
3620{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003621 if (operation->id == 0) {
3622 /* The object has (apparently) been initialized but it is not (yet)
3623 * in use. It's ok to call abort on such an object, and there's
3624 * nothing to do. */
3625 return PSA_SUCCESS;
3626 }
3627
Paul Elliott59ad9452022-12-18 15:09:02 +00003628 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3629
3630 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003631
3632 operation->id = 0;
3633
Paul Elliotte6145dc2023-02-07 12:51:21 +00003634 /* Do not clear either the error_occurred or num_ops elements here as they
3635 * only want to be cleared by the application calling abort, not by abort
3636 * being called at completion of an operation. */
3637
Paul Elliott59ad9452022-12-18 15:09:02 +00003638 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003639}
3640
3641psa_status_t psa_verify_hash_start(
3642 psa_verify_hash_interruptible_operation_t *operation,
3643 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3644 const uint8_t *hash, size_t hash_length,
3645 const uint8_t *signature, size_t signature_length)
3646{
3647 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3648 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3649 psa_key_slot_t *slot;
3650
Paul Elliottc9774412023-02-06 15:14:07 +00003651 /* Check that start has not been previously called, or operation has not
3652 * previously errored. */
3653 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003654 return PSA_ERROR_BAD_STATE;
3655 }
3656
3657 status = psa_sign_verify_check_alg(0, alg);
3658 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003659 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003660 return status;
3661 }
3662
3663 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3664 PSA_KEY_USAGE_VERIFY_HASH,
3665 alg);
3666
3667 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003668 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003669 return status;
3670 }
3671
3672 psa_key_attributes_t attributes = {
3673 .core = slot->attr
3674 };
3675
Paul Elliott296ede92022-12-15 17:00:30 +00003676 /* Ensure ops count gets reset, in case of operation re-use. */
3677 operation->num_ops = 0;
3678
Paul Elliott9fe12f62022-11-30 19:16:02 +00003679 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3680 slot->key.data,
3681 slot->key.bytes,
3682 alg, hash, hash_length,
3683 signature, signature_length);
3684
3685 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003686 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003687 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003688 }
3689
Ryan Everett1b70a072024-01-04 10:32:49 +00003690 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003691
Paul Elliottc9774412023-02-06 15:14:07 +00003692 if (unlock_status != PSA_SUCCESS) {
3693 operation->error_occurred = 1;
3694 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003695
Paul Elliottc9774412023-02-06 15:14:07 +00003696 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003697}
3698
3699psa_status_t psa_verify_hash_complete(
3700 psa_verify_hash_interruptible_operation_t *operation)
3701{
3702 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3703
Paul Elliottc9774412023-02-06 15:14:07 +00003704 /* Check that start has been called first, and that operation has not
3705 * previously errored. */
3706 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003707 status = PSA_ERROR_BAD_STATE;
3708 goto exit;
3709 }
3710
3711 status = psa_driver_wrapper_verify_hash_complete(operation);
3712
Paul Elliott296ede92022-12-15 17:00:30 +00003713 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003714 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003715 operation);
3716
Paul Elliottebe225c2023-02-10 14:32:53 +00003717exit:
3718
Paul Elliott9fe12f62022-11-30 19:16:02 +00003719 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003720 if (status != PSA_SUCCESS) {
3721 operation->error_occurred = 1;
3722 }
3723
Paul Elliott59ad9452022-12-18 15:09:02 +00003724 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003725 }
3726
3727 return status;
3728}
3729
3730psa_status_t psa_verify_hash_abort(
3731 psa_verify_hash_interruptible_operation_t *operation)
3732{
Paul Elliott59ad9452022-12-18 15:09:02 +00003733 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003734
Paul Elliott59ad9452022-12-18 15:09:02 +00003735 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003736
Paul Elliott59ad9452022-12-18 15:09:02 +00003737 /* We clear the number of ops done here, so that it is not cleared when
3738 * the operation fails or succeeds, only on manual abort. */
3739 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003740
Paul Elliottc9774412023-02-06 15:14:07 +00003741 /* Likewise, failure state. */
3742 operation->error_occurred = 0;
3743
Paul Elliott59ad9452022-12-18 15:09:02 +00003744 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003745}
3746
Paul Elliott588f8ed2022-12-02 18:10:26 +00003747/****************************************************************/
3748/* Asymmetric interruptible cryptography internal */
3749/* implementations */
3750/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003751
Paul Elliott588f8ed2022-12-02 18:10:26 +00003752void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3753{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003754
Paul Elliott588f8ed2022-12-02 18:10:26 +00003755#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3756 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3757 defined(MBEDTLS_ECP_RESTARTABLE)
3758
3759 /* Internal implementation uses zero to indicate infinite number max ops,
3760 * therefore avoid this value, and set to minimum possible. */
3761 if (max_ops == 0) {
3762 max_ops = 1;
3763 }
3764
Paul Elliott588f8ed2022-12-02 18:10:26 +00003765 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003766#else
3767 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003768#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3769 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3770 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3771}
3772
Paul Elliott588f8ed2022-12-02 18:10:26 +00003773uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003774 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003775{
3776#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3777 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3778 defined(MBEDTLS_ECP_RESTARTABLE)
3779
Paul Elliott93d9ca82023-02-15 18:14:21 +00003780 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003781#else
3782 (void) operation;
3783 return 0;
3784#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3785 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3786 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3787}
3788
3789uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003790 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003791{
3792 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3793 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3794 defined(MBEDTLS_ECP_RESTARTABLE)
3795
Paul Elliott93d9ca82023-02-15 18:14:21 +00003796 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003797#else
3798 (void) operation;
3799 return 0;
3800#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3801 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3802 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3803}
3804
3805psa_status_t mbedtls_psa_sign_hash_start(
3806 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3807 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3808 size_t key_buffer_size, psa_algorithm_t alg,
3809 const uint8_t *hash, size_t hash_length)
3810{
3811 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003812 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003813
Paul Elliott068fe072023-01-16 13:59:15 +00003814 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3815 return PSA_ERROR_NOT_SUPPORTED;
3816 }
3817
3818 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003819 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003820 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003821
3822#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003823 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3824 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003825
Paul Elliotta1c94092023-02-15 16:38:04 +00003826 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3827
Paul Elliott93d9ca82023-02-15 18:14:21 +00003828 /* Ensure num_ops is zero'ed in case of context re-use. */
3829 operation->num_ops = 0;
3830
Paul Elliott068fe072023-01-16 13:59:15 +00003831 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3832 attributes->core.bits,
3833 key_buffer,
3834 key_buffer_size,
3835 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003836
Paul Elliott068fe072023-01-16 13:59:15 +00003837 if (status != PSA_SUCCESS) {
3838 return status;
3839 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003840
Paul Elliott1bc59df2023-02-05 13:41:57 +00003841 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003842 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003843
Paul Elliott068fe072023-01-16 13:59:15 +00003844 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003845 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003846 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003847
Paul Elliott0290a762023-02-09 14:30:24 +00003848 /* We only need to store the same length of hash as the private key size
3849 * here, it would be truncated by the internal implementation anyway. */
3850 required_hash_length = (hash_length < operation->coordinate_bytes ?
3851 hash_length : operation->coordinate_bytes);
3852
Paul Elliottba70ad42023-02-15 18:23:53 +00003853 if (required_hash_length > sizeof(operation->hash)) {
3854 /* Shouldn't happen, but better safe than sorry. */
3855 return PSA_ERROR_CORRUPTION_DETECTED;
3856 }
3857
Paul Elliott0290a762023-02-09 14:30:24 +00003858 memcpy(operation->hash, hash, required_hash_length);
3859 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003860
3861 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003862
3863#else
Paul Elliott068fe072023-01-16 13:59:15 +00003864 (void) operation;
3865 (void) key_buffer;
3866 (void) key_buffer_size;
3867 (void) alg;
3868 (void) hash;
3869 (void) hash_length;
3870 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003871 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003872
Paul Elliott068fe072023-01-16 13:59:15 +00003873 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003874#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3875 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3876 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003877}
3878
3879psa_status_t mbedtls_psa_sign_hash_complete(
3880 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3881 uint8_t *signature, size_t signature_size,
3882 size_t *signature_length)
3883{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003884#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3885 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3886 defined(MBEDTLS_ECP_RESTARTABLE)
3887
Paul Elliotta1c94092023-02-15 16:38:04 +00003888 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003889 mbedtls_mpi r;
3890 mbedtls_mpi s;
3891
Paul Elliott46845252023-02-03 14:59:11 +00003892 mbedtls_mpi_init(&r);
3893 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003894
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003895 /* Ensure max_ops is set to the current value (or default). */
3896 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3897
Paul Elliotta1c94092023-02-15 16:38:04 +00003898 if (signature_size < 2 * operation->coordinate_bytes) {
3899 status = PSA_ERROR_BUFFER_TOO_SMALL;
3900 goto exit;
3901 }
3902
Paul Elliott588f8ed2022-12-02 18:10:26 +00003903 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003904
Paul Elliott588f8ed2022-12-02 18:10:26 +00003905#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3906 status = mbedtls_to_psa_error(
3907 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003908 &r,
3909 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003910 &operation->ctx->d,
3911 operation->hash,
3912 operation->hash_length,
3913 operation->md_alg,
3914 mbedtls_psa_get_random,
3915 MBEDTLS_PSA_RANDOM_STATE,
3916 &operation->restart_ctx));
3917#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003918 status = PSA_ERROR_NOT_SUPPORTED;
3919 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003920#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3921 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003922 status = mbedtls_to_psa_error(
3923 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003924 &r,
3925 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003926 &operation->ctx->d,
3927 operation->hash,
3928 operation->hash_length,
3929 mbedtls_psa_get_random,
3930 MBEDTLS_PSA_RANDOM_STATE,
3931 mbedtls_psa_get_random,
3932 MBEDTLS_PSA_RANDOM_STATE,
3933 &operation->restart_ctx));
3934 }
3935
Paul Elliottf8e5b562023-02-19 18:43:45 +00003936 /* Hide the fact that the restart context only holds a delta of number of
3937 * ops done during the last operation, not an absolute value. */
3938 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3939
Paul Elliott724bd252023-02-08 12:35:08 +00003940 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003941 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003942 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003943 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003944 operation->coordinate_bytes)
3945 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003946
3947 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003948 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003949 }
3950
3951 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003952 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003953 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003954 operation->coordinate_bytes,
3955 operation->coordinate_bytes)
3956 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003957
3958 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003959 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003960 }
3961
Paul Elliott1bc59df2023-02-05 13:41:57 +00003962 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003963
Paul Elliott724bd252023-02-08 12:35:08 +00003964 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003965 }
Paul Elliott724bd252023-02-08 12:35:08 +00003966
3967exit:
3968
3969 mbedtls_mpi_free(&r);
3970 mbedtls_mpi_free(&s);
3971 return status;
3972
Paul Elliott588f8ed2022-12-02 18:10:26 +00003973 #else
3974
3975 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003976 (void) signature;
3977 (void) signature_size;
3978 (void) signature_length;
3979
3980 return PSA_ERROR_NOT_SUPPORTED;
3981
3982#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3983 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3984 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3985}
3986
3987psa_status_t mbedtls_psa_sign_hash_abort(
3988 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3989{
3990
3991#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3992 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3993 defined(MBEDTLS_ECP_RESTARTABLE)
3994
3995 if (operation->ctx) {
3996 mbedtls_ecdsa_free(operation->ctx);
3997 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003998 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003999 }
4000
4001 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4002
Paul Elliott93d9ca82023-02-15 18:14:21 +00004003 operation->num_ops = 0;
4004
Paul Elliott588f8ed2022-12-02 18:10:26 +00004005 return PSA_SUCCESS;
4006
4007#else
4008
4009 (void) operation;
4010
4011 return PSA_ERROR_NOT_SUPPORTED;
4012
4013#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4014 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4015 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4016}
4017
4018psa_status_t mbedtls_psa_verify_hash_start(
4019 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4020 const psa_key_attributes_t *attributes,
4021 const uint8_t *key_buffer, size_t key_buffer_size,
4022 psa_algorithm_t alg,
4023 const uint8_t *hash, size_t hash_length,
4024 const uint8_t *signature, size_t signature_length)
4025{
4026 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004027 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004028 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004029
Paul Elliott068fe072023-01-16 13:59:15 +00004030 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4031 return PSA_ERROR_NOT_SUPPORTED;
4032 }
4033
4034 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004035 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004036 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004037
4038#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004039 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4040 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004041
Paul Elliotta1c94092023-02-15 16:38:04 +00004042 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4043 mbedtls_mpi_init(&operation->r);
4044 mbedtls_mpi_init(&operation->s);
4045
Paul Elliott93d9ca82023-02-15 18:14:21 +00004046 /* Ensure num_ops is zero'ed in case of context re-use. */
4047 operation->num_ops = 0;
4048
Paul Elliott068fe072023-01-16 13:59:15 +00004049 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4050 attributes->core.bits,
4051 key_buffer,
4052 key_buffer_size,
4053 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004054
Paul Elliott068fe072023-01-16 13:59:15 +00004055 if (status != PSA_SUCCESS) {
4056 return status;
4057 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004058
Paul Elliottc569fc22023-02-10 13:02:54 +00004059 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004060
Paul Elliott1bc59df2023-02-05 13:41:57 +00004061 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004062 return PSA_ERROR_INVALID_SIGNATURE;
4063 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004064
Paul Elliott068fe072023-01-16 13:59:15 +00004065 status = mbedtls_to_psa_error(
4066 mbedtls_mpi_read_binary(&operation->r,
4067 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004068 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004069
Paul Elliott068fe072023-01-16 13:59:15 +00004070 if (status != PSA_SUCCESS) {
4071 return status;
4072 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004073
Paul Elliott068fe072023-01-16 13:59:15 +00004074 status = mbedtls_to_psa_error(
4075 mbedtls_mpi_read_binary(&operation->s,
4076 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004077 coordinate_bytes,
4078 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004079
Paul Elliott068fe072023-01-16 13:59:15 +00004080 if (status != PSA_SUCCESS) {
4081 return status;
4082 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004083
Paul Elliott2c9843f2023-02-15 17:32:42 +00004084 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004085
Paul Elliott2c9843f2023-02-15 17:32:42 +00004086 if (status != PSA_SUCCESS) {
4087 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004088 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004089
Paul Elliott0290a762023-02-09 14:30:24 +00004090 /* We only need to store the same length of hash as the private key size
4091 * here, it would be truncated by the internal implementation anyway. */
4092 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4093 coordinate_bytes);
4094
Paul Elliottba70ad42023-02-15 18:23:53 +00004095 if (required_hash_length > sizeof(operation->hash)) {
4096 /* Shouldn't happen, but better safe than sorry. */
4097 return PSA_ERROR_CORRUPTION_DETECTED;
4098 }
4099
Paul Elliott0290a762023-02-09 14:30:24 +00004100 memcpy(operation->hash, hash, required_hash_length);
4101 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004102
4103 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004104#else
Paul Elliott068fe072023-01-16 13:59:15 +00004105 (void) operation;
4106 (void) key_buffer;
4107 (void) key_buffer_size;
4108 (void) alg;
4109 (void) hash;
4110 (void) hash_length;
4111 (void) signature;
4112 (void) signature_length;
4113 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004114 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004115 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004116
Paul Elliott068fe072023-01-16 13:59:15 +00004117 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004118#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4119 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4120 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004121}
4122
4123psa_status_t mbedtls_psa_verify_hash_complete(
4124 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4125{
4126
4127#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4128 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4129 defined(MBEDTLS_ECP_RESTARTABLE)
4130
Paul Elliottf8e5b562023-02-19 18:43:45 +00004131 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4132
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004133 /* Ensure max_ops is set to the current value (or default). */
4134 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4135
Paul Elliottf8e5b562023-02-19 18:43:45 +00004136 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004137 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4138 operation->hash,
4139 operation->hash_length,
4140 &operation->ctx->Q,
4141 &operation->r,
4142 &operation->s,
4143 &operation->restart_ctx));
4144
Paul Elliottf8e5b562023-02-19 18:43:45 +00004145 /* Hide the fact that the restart context only holds a delta of number of
4146 * ops done during the last operation, not an absolute value. */
4147 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4148
4149 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004150#else
4151 (void) operation;
4152
4153 return PSA_ERROR_NOT_SUPPORTED;
4154
4155#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4156 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4157 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4158}
4159
4160psa_status_t mbedtls_psa_verify_hash_abort(
4161 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4162{
4163
4164#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4165 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4166 defined(MBEDTLS_ECP_RESTARTABLE)
4167
4168 if (operation->ctx) {
4169 mbedtls_ecdsa_free(operation->ctx);
4170 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004171 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004172 }
4173
4174 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4175
Paul Elliott93d9ca82023-02-15 18:14:21 +00004176 operation->num_ops = 0;
4177
Paul Elliott588f8ed2022-12-02 18:10:26 +00004178 mbedtls_mpi_free(&operation->r);
4179 mbedtls_mpi_free(&operation->s);
4180
4181 return PSA_SUCCESS;
4182
4183#else
4184 (void) operation;
4185
4186 return PSA_ERROR_NOT_SUPPORTED;
4187
4188#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4189 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4190 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4191}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004192
mohammad1603503973b2018-03-12 15:59:30 +02004193/****************************************************************/
4194/* Symmetric cryptography */
4195/****************************************************************/
4196
Gilles Peskine449bd832023-01-11 14:50:10 +01004197static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4198 mbedtls_svc_key_id_t key,
4199 psa_algorithm_t alg,
4200 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004201{
4202 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4203 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004204 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4206 PSA_KEY_USAGE_ENCRYPT :
4207 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004208 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004209
4210 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004212 status = PSA_ERROR_BAD_STATE;
4213 goto exit;
4214 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004215
Gilles Peskine449bd832023-01-11 14:50:10 +01004216 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004217 status = PSA_ERROR_INVALID_ARGUMENT;
4218 goto exit;
4219 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004220
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4222 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004223 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004225
Ronald Cron49fafa92021-03-10 08:34:23 +01004226 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004227 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004228 * so we only set it (in the driver wrapper) after resources have been
4229 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004230 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004232 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004234 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004235 }
4236 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004237
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004238 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004240 };
4241
Ronald Cronab99ac22020-10-01 16:38:28 +02004242 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 if (cipher_operation == MBEDTLS_ENCRYPT) {
4244 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4245 &attributes,
4246 slot->key.data,
4247 slot->key.bytes,
4248 alg);
4249 } else {
4250 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4251 &attributes,
4252 slot->key.data,
4253 slot->key.bytes,
4254 alg);
4255 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004256
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004257exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 if (status != PSA_SUCCESS) {
4259 psa_cipher_abort(operation);
4260 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004261
Ryan Everett1b70a072024-01-04 10:32:49 +00004262 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004263
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004265}
4266
Gilles Peskine449bd832023-01-11 14:50:10 +01004267psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4268 mbedtls_svc_key_id_t key,
4269 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004270{
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004272}
4273
Gilles Peskine449bd832023-01-11 14:50:10 +01004274psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4275 mbedtls_svc_key_id_t key,
4276 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004277{
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004279}
4280
Gilles Peskine449bd832023-01-11 14:50:10 +01004281psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4282 uint8_t *iv,
4283 size_t iv_size,
4284 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004285{
Ronald Cron6d051732020-10-01 14:10:20 +02004286 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004287 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004288 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004289
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004291 status = PSA_ERROR_BAD_STATE;
4292 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004293 }
4294
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004296 status = PSA_ERROR_BAD_STATE;
4297 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004298 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004299
Ronald Cron2fb90522021-07-05 12:31:44 +02004300 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004302 status = PSA_ERROR_BUFFER_TOO_SMALL;
4303 goto exit;
4304 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004305
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004307 status = PSA_ERROR_GENERIC_ERROR;
4308 goto exit;
4309 }
4310
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 status = psa_generate_random(local_iv, default_iv_length);
4312 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004313 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 }
Ronald Cron5618a392021-03-26 09:52:26 +01004315
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 status = psa_driver_wrapper_cipher_set_iv(operation,
4317 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004318
4319exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 if (status == PSA_SUCCESS) {
4321 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004322 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004323 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004325 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004327 }
Ronald Cron6d051732020-10-01 14:10:20 +02004328
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004330}
4331
Gilles Peskine449bd832023-01-11 14:50:10 +01004332psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4333 const uint8_t *iv,
4334 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004335{
Ronald Cron6d051732020-10-01 14:10:20 +02004336 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004337
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004339 status = PSA_ERROR_BAD_STATE;
4340 goto exit;
4341 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004342
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004344 status = PSA_ERROR_BAD_STATE;
4345 goto exit;
4346 }
Ronald Crona0d68172021-03-26 10:15:08 +01004347
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004349 status = PSA_ERROR_INVALID_ARGUMENT;
4350 goto exit;
4351 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 status = psa_driver_wrapper_cipher_set_iv(operation,
4354 iv,
4355 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004356
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004357exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004359 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 } else {
4361 psa_cipher_abort(operation);
4362 }
4363 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004364}
4365
Gilles Peskine449bd832023-01-11 14:50:10 +01004366psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4367 const uint8_t *input,
4368 size_t input_length,
4369 uint8_t *output,
4370 size_t output_size,
4371 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004372{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004373 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004374
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004376 status = PSA_ERROR_BAD_STATE;
4377 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004378 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004381 status = PSA_ERROR_BAD_STATE;
4382 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004383 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004384
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 status = psa_driver_wrapper_cipher_update(operation,
4386 input,
4387 input_length,
4388 output,
4389 output_size,
4390 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004391
4392exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (status != PSA_SUCCESS) {
4394 psa_cipher_abort(operation);
4395 }
Ronald Cron6d051732020-10-01 14:10:20 +02004396
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004398}
4399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4401 uint8_t *output,
4402 size_t output_size,
4403 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004404{
David Saadab4ecc272019-02-14 13:48:10 +02004405 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004406
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004408 status = PSA_ERROR_BAD_STATE;
4409 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004410 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004411
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004413 status = PSA_ERROR_BAD_STATE;
4414 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004415 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004416
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 status = psa_driver_wrapper_cipher_finish(operation,
4418 output,
4419 output_size,
4420 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004421
4422exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 if (status == PSA_SUCCESS) {
4424 return psa_cipher_abort(operation);
4425 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004426 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004428
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004430 }
mohammad1603503973b2018-03-12 15:59:30 +02004431}
4432
Gilles Peskine449bd832023-01-11 14:50:10 +01004433psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004434{
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004436 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004437 * in use. It's ok to call abort on such an object, and there's
4438 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004440 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004443
Ronald Cron49fafa92021-03-10 08:34:23 +01004444 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004445 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004446 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004449}
4450
Gilles Peskine449bd832023-01-11 14:50:10 +01004451psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4452 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004453 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004455 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 size_t output_size,
4457 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004458{
4459 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004460 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004461 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004462 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4463 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004464 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004465
David Horstmann62a56d92023-12-14 18:12:47 +00004466 LOCAL_INPUT_DECLARE(input_external, input);
4467 LOCAL_OUTPUT_DECLARE(output_external, output);
4468
David Horstmann36df4b22023-12-13 15:55:25 +00004469 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004470 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004471
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004473 status = PSA_ERROR_INVALID_ARGUMENT;
4474 goto exit;
4475 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004476
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4478 PSA_KEY_USAGE_ENCRYPT,
4479 alg);
4480 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004481 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004483
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004484 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004486 };
4487
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4489 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004490 status = PSA_ERROR_GENERIC_ERROR;
4491 goto exit;
4492 }
4493
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 if (default_iv_length > 0) {
4495 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004496 status = PSA_ERROR_BUFFER_TOO_SMALL;
4497 goto exit;
4498 }
4499
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 status = psa_generate_random(local_iv, default_iv_length);
4501 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004502 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004504 }
4505
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004506 status = psa_driver_wrapper_cipher_encrypt(
4507 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004508 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004509 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004511
4512exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004513 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004515 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004516 }
Ronald Cron23919522021-07-08 19:00:07 +02004517
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 if (status == PSA_SUCCESS) {
4519 if (default_iv_length > 0) {
4520 memcpy(output, local_iv, default_iv_length);
4521 }
4522 *output_length += default_iv_length;
4523 } else {
4524 *output_length = 0;
4525 }
4526
David Horstmann62a56d92023-12-14 18:12:47 +00004527 LOCAL_INPUT_FREE(input_external, input);
4528 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004529
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004531}
4532
Gilles Peskine449bd832023-01-11 14:50:10 +01004533psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4534 psa_algorithm_t alg,
4535 const uint8_t *input,
4536 size_t input_length,
4537 uint8_t *output,
4538 size_t output_size,
4539 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004540{
4541 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004542 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004543 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004544 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004545
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004547 status = PSA_ERROR_INVALID_ARGUMENT;
4548 goto exit;
4549 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4552 PSA_KEY_USAGE_DECRYPT,
4553 alg);
4554 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004555 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004557
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004558 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004560 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4563 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004564 status = PSA_ERROR_INVALID_ARGUMENT;
4565 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004567 status = PSA_ERROR_INVALID_ARGUMENT;
4568 goto exit;
4569 }
4570
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004571 status = psa_driver_wrapper_cipher_decrypt(
4572 &attributes, slot->key.data, slot->key.bytes,
4573 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004575
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004576exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004577 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004579 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004581
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004583 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 }
Ronald Cron23919522021-07-08 19:00:07 +02004585
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004587}
4588
4589
mohammad16035955c982018-04-26 00:53:03 +03004590/****************************************************************/
4591/* AEAD */
4592/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004593
Paul Elliottbaff51c2021-09-28 17:44:45 +01004594/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004595static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004596{
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004598}
4599
4600/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004601static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4602 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004603{
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004605
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004607#if defined(PSA_WANT_ALG_GCM)
4608 case PSA_ALG_GCM:
4609 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 * arbitrarily large nonces. Please note that we do not generally
4611 * recommend the usage of nonces of greater length than
4612 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4613 * size, which can then lead to collisions if you encrypt a very
4614 * large number of messages.*/
4615 if (nonce_length != 0) {
4616 return PSA_SUCCESS;
4617 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004618 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004619#endif /* PSA_WANT_ALG_GCM */
4620#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004621 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 if (nonce_length >= 7 && nonce_length <= 13) {
4623 return PSA_SUCCESS;
4624 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004625 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004626#endif /* PSA_WANT_ALG_CCM */
4627#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004628 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 if (nonce_length == 12) {
4630 return PSA_SUCCESS;
4631 } else if (nonce_length == 8) {
4632 return PSA_ERROR_NOT_SUPPORTED;
4633 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004634 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004635#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004636 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004637 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004639 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004640
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004642}
4643
Gilles Peskine449bd832023-01-11 14:50:10 +01004644static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004645{
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4647 return PSA_ERROR_INVALID_ARGUMENT;
4648 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004649
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004651}
4652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4654 psa_algorithm_t alg,
4655 const uint8_t *nonce,
4656 size_t nonce_length,
4657 const uint8_t *additional_data,
4658 size_t additional_data_length,
4659 const uint8_t *plaintext,
4660 size_t plaintext_length,
4661 uint8_t *ciphertext,
4662 size_t ciphertext_size,
4663 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004664{
Ronald Cron215633c2021-03-16 17:15:37 +01004665 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4666 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004667
mohammad1603f08a5502018-06-03 15:05:47 +03004668 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 status = psa_aead_check_algorithm(alg);
4671 if (status != PSA_SUCCESS) {
4672 return status;
4673 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004674
Ronald Cron9a986162021-03-26 12:40:07 +01004675 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4677 if (status != PSA_SUCCESS) {
4678 return status;
4679 }
mohammad16035955c982018-04-26 00:53:03 +03004680
Ronald Cron215633c2021-03-16 17:15:37 +01004681 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004683 };
mohammad16035955c982018-04-26 00:53:03 +03004684
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 status = psa_aead_check_nonce_length(alg, nonce_length);
4686 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004687 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004689
Ronald Cronde822812021-03-17 16:08:20 +01004690 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004691 &attributes, slot->key.data, slot->key.bytes,
4692 alg,
4693 nonce, nonce_length,
4694 additional_data, additional_data_length,
4695 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004697
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4699 memset(ciphertext, 0, ciphertext_size);
4700 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004701
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004702exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004703 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004704
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004706}
4707
Gilles Peskine449bd832023-01-11 14:50:10 +01004708psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4709 psa_algorithm_t alg,
4710 const uint8_t *nonce,
4711 size_t nonce_length,
4712 const uint8_t *additional_data,
4713 size_t additional_data_length,
4714 const uint8_t *ciphertext,
4715 size_t ciphertext_length,
4716 uint8_t *plaintext,
4717 size_t plaintext_size,
4718 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004719{
Ronald Cron215633c2021-03-16 17:15:37 +01004720 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4721 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004722
Gilles Peskineee652a32018-06-01 19:23:52 +02004723 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004724
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 status = psa_aead_check_algorithm(alg);
4726 if (status != PSA_SUCCESS) {
4727 return status;
4728 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004729
Ronald Cron9a986162021-03-26 12:40:07 +01004730 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4732 if (status != PSA_SUCCESS) {
4733 return status;
4734 }
mohammad16035955c982018-04-26 00:53:03 +03004735
Ronald Cron215633c2021-03-16 17:15:37 +01004736 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004738 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004739
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 status = psa_aead_check_nonce_length(alg, nonce_length);
4741 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004742 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004744
Ronald Cronde822812021-03-17 16:08:20 +01004745 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004746 &attributes, slot->key.data, slot->key.bytes,
4747 alg,
4748 nonce, nonce_length,
4749 additional_data, additional_data_length,
4750 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004752
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 if (status != PSA_SUCCESS && plaintext_size != 0) {
4754 memset(plaintext, 0, plaintext_size);
4755 }
mohammad160360a64d02018-06-03 17:20:42 +03004756
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004757exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004758 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004759
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 return status;
mohammad16035955c982018-04-26 00:53:03 +03004761}
4762
Gilles Peskine449bd832023-01-11 14:50:10 +01004763static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4764{
4765 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004766
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004768#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004770 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4772 return PSA_ERROR_INVALID_ARGUMENT;
4773 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004774 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004775#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004776
Przemek Stekiel86679c72022-10-06 17:06:56 +02004777#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004779 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4781 return PSA_ERROR_INVALID_ARGUMENT;
4782 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004783 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004784#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004785
Przemek Stekiel86679c72022-10-06 17:06:56 +02004786#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004788 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004789 if (tag_len != 16) {
4790 return PSA_ERROR_INVALID_ARGUMENT;
4791 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004792 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004793#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004794
4795 default:
4796 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004798 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004800}
4801
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004802/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004803static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4804 int is_encrypt,
4805 mbedtls_svc_key_id_t key,
4806 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004807{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004808 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4809 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4810 psa_key_slot_t *slot = NULL;
4811 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004812 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 status = psa_aead_check_algorithm(alg);
4815 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004816 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004818
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004820 status = PSA_ERROR_BAD_STATE;
4821 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004822 }
4823
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 if (operation->nonce_set || operation->lengths_set ||
4825 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004826 status = PSA_ERROR_BAD_STATE;
4827 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004828 }
4829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004831 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004833 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004835
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4837 alg);
4838 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004839 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004841
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004842 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004843 .core = slot->attr
4844 };
4845
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004847 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004849
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 if (is_encrypt) {
4851 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4852 &attributes,
4853 slot->key.data,
4854 slot->key.bytes,
4855 alg);
4856 } else {
4857 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4858 &attributes,
4859 slot->key.data,
4860 slot->key.bytes,
4861 alg);
4862 }
4863 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004864 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004866
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004868
4869exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004870 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004871
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004873 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004875 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 } else {
4877 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004878 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004879
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004881}
4882
Paul Elliott302ff6b2021-04-20 18:10:30 +01004883/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004884psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4885 mbedtls_svc_key_id_t key,
4886 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004887{
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004889}
4890
4891/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004892psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4893 mbedtls_svc_key_id_t key,
4894 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004895{
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004897}
4898
4899/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004900psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4901 uint8_t *nonce,
4902 size_t nonce_size,
4903 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004904{
4905 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004906 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004907 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004908
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004909 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004910
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004912 status = PSA_ERROR_BAD_STATE;
4913 goto exit;
4914 }
4915
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004917 status = PSA_ERROR_BAD_STATE;
4918 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004919 }
4920
Paul Elliotte193ea82021-10-01 13:00:16 +01004921 /* For CCM, this size may not be correct according to the PSA
4922 * specification. The PSA Crypto 1.0.1 specification states:
4923 *
4924 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4925 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4926 *
4927 * However this restriction that L has to be the smallest integer is not
4928 * applied in practice, and it is not implementable here since the
4929 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4931 operation->alg);
4932 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004933 status = PSA_ERROR_BUFFER_TOO_SMALL;
4934 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004935 }
4936
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 status = psa_generate_random(local_nonce, required_nonce_size);
4938 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004939 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004941
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004943
Paul Elliott39dc6b82021-05-11 19:16:09 +01004944exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 if (status == PSA_SUCCESS) {
4946 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004947 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 } else {
4949 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004950 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004951
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004953}
4954
4955/* Set the nonce for a multipart authenticated encryption or decryption
4956 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004957psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4958 const uint8_t *nonce,
4959 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004960{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004961 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4962
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004964 status = PSA_ERROR_BAD_STATE;
4965 goto exit;
4966 }
4967
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004969 status = PSA_ERROR_BAD_STATE;
4970 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004971 }
4972
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4974 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004975 status = PSA_ERROR_INVALID_ARGUMENT;
4976 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004977 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004978
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4980 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004981
Paul Elliott39dc6b82021-05-11 19:16:09 +01004982exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004984 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 } else {
4986 psa_aead_abort(operation);
4987 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004988
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004990}
4991
4992/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004993psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4994 size_t ad_length,
4995 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004996{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004997 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4998
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005000 status = PSA_ERROR_BAD_STATE;
5001 goto exit;
5002 }
5003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 if (operation->lengths_set || operation->ad_started ||
5005 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005006 status = PSA_ERROR_BAD_STATE;
5007 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005008 }
5009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005011#if defined(PSA_WANT_ALG_GCM)
5012 case PSA_ALG_GCM:
5013 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 * bits. Without the guard this code will generate warnings on 32bit
5015 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005016#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005017 if (((uint64_t) ad_length) >> 61 != 0 ||
5018 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005019 status = PSA_ERROR_INVALID_ARGUMENT;
5020 goto exit;
5021 }
Paul Elliott325d3742021-09-27 17:56:28 +01005022#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005023 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005024#endif /* PSA_WANT_ALG_GCM */
5025#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005026 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005028 status = PSA_ERROR_INVALID_ARGUMENT;
5029 goto exit;
5030 }
5031 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005032#endif /* PSA_WANT_ALG_CCM */
5033#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005034 case PSA_ALG_CHACHA20_POLY1305:
5035 /* No length restrictions for ChaChaPoly. */
5036 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005037#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005038 default:
5039 break;
5040 }
Paul Elliott325d3742021-09-27 17:56:28 +01005041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5043 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005044
Paul Elliott39dc6b82021-05-11 19:16:09 +01005045exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005047 operation->ad_remaining = ad_length;
5048 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005049 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 } else {
5051 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005052 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005053
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005055}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005056
5057/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005058psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5059 const uint8_t *input,
5060 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005061{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005062 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5063
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005065 status = PSA_ERROR_BAD_STATE;
5066 goto exit;
5067 }
5068
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005070 status = PSA_ERROR_BAD_STATE;
5071 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005072 }
5073
Gilles Peskine449bd832023-01-11 14:50:10 +01005074 if (operation->lengths_set) {
5075 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005076 status = PSA_ERROR_INVALID_ARGUMENT;
5077 goto exit;
5078 }
5079
5080 operation->ad_remaining -= input_length;
5081 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005082#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005084 status = PSA_ERROR_BAD_STATE;
5085 goto exit;
5086 }
5087#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005088
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 status = psa_driver_wrapper_aead_update_ad(operation, input,
5090 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005091
Paul Elliott39dc6b82021-05-11 19:16:09 +01005092exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005094 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 } else {
5096 psa_aead_abort(operation);
5097 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005098
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005100}
5101
5102/* Encrypt or decrypt a message fragment in an active multipart AEAD
5103 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005104psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5105 const uint8_t *input,
5106 size_t input_length,
5107 uint8_t *output,
5108 size_t output_size,
5109 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005110{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005111 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005112
5113 *output_length = 0;
5114
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005116 status = PSA_ERROR_BAD_STATE;
5117 goto exit;
5118 }
5119
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005121 status = PSA_ERROR_BAD_STATE;
5122 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005123 }
5124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005126 /* Additional data length was supplied, but not all the additional
5127 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005129 status = PSA_ERROR_INVALID_ARGUMENT;
5130 goto exit;
5131 }
5132
5133 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005135 status = PSA_ERROR_INVALID_ARGUMENT;
5136 goto exit;
5137 }
5138
5139 operation->body_remaining -= input_length;
5140 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005141#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005143 status = PSA_ERROR_BAD_STATE;
5144 goto exit;
5145 }
5146#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005147
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5149 output, output_size,
5150 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005151
Paul Elliott39dc6b82021-05-11 19:16:09 +01005152exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005154 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 } else {
5156 psa_aead_abort(operation);
5157 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005158
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005160}
5161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005163{
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 if (operation->id == 0 || !operation->nonce_set) {
5165 return PSA_ERROR_BAD_STATE;
5166 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005167
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5169 operation->body_remaining != 0)) {
5170 return PSA_ERROR_INVALID_ARGUMENT;
5171 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005172
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005174}
5175
Paul Elliott302ff6b2021-04-20 18:10:30 +01005176/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005177psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5178 uint8_t *ciphertext,
5179 size_t ciphertext_size,
5180 size_t *ciphertext_length,
5181 uint8_t *tag,
5182 size_t tag_size,
5183 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005184{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005185 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5186
Paul Elliott302ff6b2021-04-20 18:10:30 +01005187 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005188 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005189
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 status = psa_aead_final_checks(operation);
5191 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005192 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005194
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005196 status = PSA_ERROR_BAD_STATE;
5197 goto exit;
5198 }
5199
Gilles Peskine449bd832023-01-11 14:50:10 +01005200 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5201 ciphertext_size,
5202 ciphertext_length,
5203 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005204
Paul Elliott39dc6b82021-05-11 19:16:09 +01005205exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005206
5207
Paul Elliottf47b0952021-05-21 18:02:33 +01005208 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005209 * the zero tag size, make sure the tag is set to something implausible.
5210 * Even if the operation succeeds, make sure we clear the rest of the
5211 * buffer to prevent potential leakage of anything previously placed in
5212 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005213 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005214
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005218}
5219
5220/* Finish authenticating and decrypting a message in a multipart AEAD
5221 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005222psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5223 uint8_t *plaintext,
5224 size_t plaintext_size,
5225 size_t *plaintext_length,
5226 const uint8_t *tag,
5227 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005228{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005229 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5230
Paul Elliott302ff6b2021-04-20 18:10:30 +01005231 *plaintext_length = 0;
5232
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 status = psa_aead_final_checks(operation);
5234 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005235 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005237
Gilles Peskine449bd832023-01-11 14:50:10 +01005238 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005239 status = PSA_ERROR_BAD_STATE;
5240 goto exit;
5241 }
5242
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5244 plaintext_size,
5245 plaintext_length,
5246 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005247
5248exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005250
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005252}
5253
5254/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005255psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005256{
5257 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5258
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005260 /* The object has (apparently) been initialized but it is not (yet)
5261 * in use. It's ok to call abort on such an object, and there's
5262 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005264 }
5265
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005267
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005269
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005271}
5272
Gilles Peskinee59236f2018-01-27 23:32:46 +01005273/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005274/* Generators */
5275/****************************************************************/
5276
Przemek Stekiel69c46792022-06-10 12:59:51 +02005277#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005278 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005279 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305280 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305281 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005282#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005283#endif /* At least one builtin KDF */
5284
Przemek Stekiel69c46792022-06-10 12:59:51 +02005285#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005286 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5287 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5288static psa_status_t psa_key_derivation_start_hmac(
5289 psa_mac_operation_t *operation,
5290 psa_algorithm_t hash_alg,
5291 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005293{
5294 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5295 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005296 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5297 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5298 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005299
Steven Cooreman72f736a2021-05-07 14:14:37 +02005300 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005301 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005302
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 status = psa_driver_wrapper_mac_sign_setup(operation,
5304 &attributes,
5305 hmac_key, hmac_key_length,
5306 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005307
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 psa_reset_key_attributes(&attributes);
5309 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005310}
5311#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005312
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005313#define HKDF_STATE_INIT 0 /* no input yet */
5314#define HKDF_STATE_STARTED 1 /* got salt */
5315#define HKDF_STATE_KEYED 2 /* got key */
5316#define HKDF_STATE_OUTPUT 3 /* output started */
5317
Gilles Peskinecbe66502019-05-16 16:59:18 +02005318static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005320{
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5322 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5323 } else {
5324 return operation->alg;
5325 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005326}
5327
Gilles Peskine449bd832023-01-11 14:50:10 +01005328psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005329{
5330 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5332 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005333 /* The object has (apparently) been initialized but it is not
5334 * in use. It's ok to call abort on such an object, and there's
5335 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005337#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5339 mbedtls_free(operation->ctx.hkdf.info);
5340 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5341 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005342#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005343#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5344 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5346 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5347 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5348 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005349 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005351 }
5352
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005354 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005356 }
5357
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005359 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005361 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005362#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005364 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005366 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005367#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005368 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005369
5370 /* We leave the fields Ai and output_block to be erased safely by the
5371 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005373#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5374 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005375#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5377 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5378 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5379 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005380#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305381#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305382 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305383 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005384 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305385 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305386 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305387
5388 status = PSA_SUCCESS;
5389 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305390#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005391 {
5392 status = PSA_ERROR_BAD_STATE;
5393 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 mbedtls_platform_zeroize(operation, sizeof(*operation));
5395 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005396}
5397
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005398psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005400{
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005402 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005404 }
5405
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005406 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005408}
5409
Gilles Peskine449bd832023-01-11 14:50:10 +01005410psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5411 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005412{
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 if (operation->alg == 0) {
5414 return PSA_ERROR_BAD_STATE;
5415 }
5416 if (capacity > operation->capacity) {
5417 return PSA_ERROR_INVALID_ARGUMENT;
5418 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005419 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005421}
5422
Przemek Stekiel69c46792022-06-10 12:59:51 +02005423#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005424/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005425static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5426 psa_algorithm_t kdf_alg,
5427 uint8_t *output,
5428 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005429{
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5431 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005432 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005433 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005434#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005436#else
5437 const uint8_t last_block = 0xff;
5438#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005439
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 if (hkdf->state < HKDF_STATE_KEYED ||
5441 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005442#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005444#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 )) {
5446 return PSA_ERROR_BAD_STATE;
5447 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005448 hkdf->state = HKDF_STATE_OUTPUT;
5449
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005451 /* Copy what remains of the current block */
5452 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005454 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 }
5456 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005457 output += n;
5458 output_length -= n;
5459 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005461 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005463 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005464 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005465 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005466 * object was corrupted or if this function is called directly
5467 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 if (hkdf->block_number == last_block) {
5469 return PSA_ERROR_BAD_STATE;
5470 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005471
5472 /* We need a new block */
5473 ++hkdf->block_number;
5474 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005475
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5477 hash_alg,
5478 hkdf->prk,
5479 hash_length);
5480 if (status != PSA_SUCCESS) {
5481 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005482 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005483
5484 if (hkdf->block_number != 1) {
5485 status = psa_mac_update(&hkdf->hmac,
5486 hkdf->output_block,
5487 hash_length);
5488 if (status != PSA_SUCCESS) {
5489 return status;
5490 }
5491 }
5492 status = psa_mac_update(&hkdf->hmac,
5493 hkdf->info,
5494 hkdf->info_length);
5495 if (status != PSA_SUCCESS) {
5496 return status;
5497 }
5498 status = psa_mac_update(&hkdf->hmac,
5499 &hkdf->block_number, 1);
5500 if (status != PSA_SUCCESS) {
5501 return status;
5502 }
5503 status = psa_mac_sign_finish(&hkdf->hmac,
5504 hkdf->output_block,
5505 sizeof(hkdf->output_block),
5506 &hmac_output_length);
5507 if (status != PSA_SUCCESS) {
5508 return status;
5509 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005510 }
5511
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005513}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005514#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005515
John Durkop07cc04a2020-11-16 22:08:34 -08005516#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5517 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005518static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5519 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005521{
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5523 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005524 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5525 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005526 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005527
Janos Follath7742fee2019-06-17 12:58:10 +01005528 /* We can't be wanting more output after block 0xff, otherwise
5529 * the capacity check in psa_key_derivation_output_bytes() would have
5530 * prevented this call. It could happen only if the operation
5531 * object was corrupted or if this function is called directly
5532 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 if (tls12_prf->block_number == 0xff) {
5534 return PSA_ERROR_CORRUPTION_DETECTED;
5535 }
Janos Follath7742fee2019-06-17 12:58:10 +01005536
5537 /* We need a new block */
5538 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005539 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005540
5541 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5542 *
5543 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5544 *
5545 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5546 * HMAC_hash(secret, A(2) + seed) +
5547 * HMAC_hash(secret, A(3) + seed) + ...
5548 *
5549 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005550 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005551 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005552 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005553 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005554 * is currently extracted as `output_block` and where i is
5555 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005556 */
5557
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 status = psa_key_derivation_start_hmac(&hmac,
5559 hash_alg,
5560 tls12_prf->secret,
5561 tls12_prf->secret_length);
5562 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005563 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005565
5566 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005568 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5569 * the variable seed and in this instance means it in the context of the
5570 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 status = psa_mac_update(&hmac,
5572 tls12_prf->label,
5573 tls12_prf->label_length);
5574 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005575 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 }
5577 status = psa_mac_update(&hmac,
5578 tls12_prf->seed,
5579 tls12_prf->seed_length);
5580 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005581 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 }
5583 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005584 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5586 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005587 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005589 }
5590
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 status = psa_mac_sign_finish(&hmac,
5592 tls12_prf->Ai, hash_length,
5593 &hmac_output_length);
5594 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005595 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 }
5597 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005598 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005600
5601 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 status = psa_key_derivation_start_hmac(&hmac,
5603 hash_alg,
5604 tls12_prf->secret,
5605 tls12_prf->secret_length);
5606 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005607 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 }
5609 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5610 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005611 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 }
5613 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5614 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005615 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 }
5617 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5618 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005619 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 }
5621 status = psa_mac_sign_finish(&hmac,
5622 tls12_prf->output_block, hash_length,
5623 &hmac_output_length);
5624 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005625 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005627
Janos Follath7742fee2019-06-17 12:58:10 +01005628
5629cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 cleanup_status = psa_mac_abort(&hmac);
5631 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005632 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005634
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005636}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005637
Janos Follath844eb0e2019-06-19 12:10:49 +01005638static psa_status_t psa_key_derivation_tls12_prf_read(
5639 psa_tls12_prf_key_derivation_t *tls12_prf,
5640 psa_algorithm_t alg,
5641 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005643{
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5645 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005646 psa_status_t status;
5647 uint8_t offset, length;
5648
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005650 case PSA_TLS12_PRF_STATE_LABEL_SET:
5651 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5652 break;
5653 case PSA_TLS12_PRF_STATE_OUTPUT:
5654 break;
5655 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005657 }
5658
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005660 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 if (tls12_prf->left_in_block == 0) {
5662 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5663 alg);
5664 if (status != PSA_SUCCESS) {
5665 return status;
5666 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005667
5668 continue;
5669 }
5670
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005672 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005674 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005676
5677 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005679 output += length;
5680 output_length -= length;
5681 tls12_prf->left_in_block -= length;
5682 }
5683
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005685}
John Durkop07cc04a2020-11-16 22:08:34 -08005686#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5687 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005688
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005689#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5690static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5691 psa_tls12_ecjpake_to_pms_t *ecjpake,
5692 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005694{
5695 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005696 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005697
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 if (output_length != 32) {
5699 return PSA_ERROR_INVALID_ARGUMENT;
5700 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005701
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5703 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5704 &output_size);
5705 if (status != PSA_SUCCESS) {
5706 return status;
5707 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005708
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 if (output_size != output_length) {
5710 return PSA_ERROR_GENERIC_ERROR;
5711 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005712
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005714}
5715#endif
5716
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305717#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305718static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5719 psa_pbkdf2_key_derivation_t *pbkdf2,
5720 psa_algorithm_t prf_alg,
5721 uint8_t prf_output_length,
5722 psa_key_attributes_t *attributes)
5723{
5724 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305725 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305726 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305727 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305728 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305729 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305730 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305731
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305732 mac_operation.is_sign = 1;
5733 mac_operation.mac_size = prf_output_length;
5734 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305735
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305736 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5737 attributes,
5738 pbkdf2->password,
5739 pbkdf2->password_length,
5740 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305741 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305742 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305743 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305744 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5745 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305746 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305747 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305748 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305749 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305750 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305751 }
5752 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5753 &mac_output_length);
5754 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305755 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305756 }
5757
5758 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305759 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305760 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305761 }
5762
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305763 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305764
5765 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305766 /* We are passing prf_output_length as mac_size because the driver
5767 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305768 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305769 status = psa_driver_wrapper_mac_compute(attributes,
5770 pbkdf2->password,
5771 pbkdf2->password_length,
5772 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305773 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305774 &mac_output_length);
5775 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305776 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305777 }
5778
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305779 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305780 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305781
5782cleanup:
5783 /* Zeroise buffers to clear sensitive data from memory. */
5784 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5785 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305786}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305787
5788static psa_status_t psa_key_derivation_pbkdf2_read(
5789 psa_pbkdf2_key_derivation_t *pbkdf2,
5790 psa_algorithm_t kdf_alg,
5791 uint8_t *output,
5792 size_t output_length)
5793{
5794 psa_status_t status;
5795 psa_algorithm_t prf_alg;
5796 uint8_t prf_output_length;
5797 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5798 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5799 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5800
5801 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5802 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5803 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5804 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305805 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5806 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305807 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305808 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305809 } else {
5810 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305811 }
5812
5813 switch (pbkdf2->state) {
5814 case PSA_PBKDF2_STATE_PASSWORD_SET:
5815 /* Initially we need a new block so bytes_used is equal to block size*/
5816 pbkdf2->bytes_used = prf_output_length;
5817 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5818 break;
5819 case PSA_PBKDF2_STATE_OUTPUT:
5820 break;
5821 default:
5822 return PSA_ERROR_BAD_STATE;
5823 }
5824
5825 while (output_length != 0) {
5826 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5827 if (n > output_length) {
5828 n = (uint8_t) output_length;
5829 }
5830 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5831 output += n;
5832 output_length -= n;
5833 pbkdf2->bytes_used += n;
5834
5835 if (output_length == 0) {
5836 break;
5837 }
5838
5839 /* We need a new block */
5840 pbkdf2->bytes_used = 0;
5841 pbkdf2->block_number++;
5842
5843 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5844 prf_output_length,
5845 &attributes);
5846 if (status != PSA_SUCCESS) {
5847 return status;
5848 }
5849 }
5850
5851 return PSA_SUCCESS;
5852}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305853#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305854
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005855psa_status_t psa_key_derivation_output_bytes(
5856 psa_key_derivation_operation_t *operation,
Ryan Everettf943e222024-01-19 14:46:39 +00005857 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005859{
5860 psa_status_t status;
Ryan Everettf943e222024-01-19 14:46:39 +00005861 LOCAL_OUTPUT_DECLARE(output_external, output);
5862
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005864
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005866 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005868 }
5869
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005871 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005872 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005873 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5874 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005875 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005876 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005878 }
Ryan Everettf943e222024-01-19 14:46:39 +00005879
5880 LOCAL_OUTPUT_ALLOC(output_external, output_length, output);
Ryan Everettda9227d2024-01-25 11:37:22 +00005881 if (output_length > operation->capacity) {
5882 operation->capacity = 0;
5883 /* Go through the error path to wipe all confidential data now
5884 * that the operation object is useless. */
5885 status = PSA_ERROR_INSUFFICIENT_DATA;
5886 goto exit;
5887 }
5888
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005889 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005890
Przemek Stekiel69c46792022-06-10 12:59:51 +02005891#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5893 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5894 output, output_length);
5895 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005896#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005897#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5898 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5900 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5901 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5902 kdf_alg, output,
5903 output_length);
5904 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005905#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5906 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005907#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005909 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005910 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5911 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005912#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305913#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305914 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305915 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5916 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305917 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305918#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005919
Gilles Peskineeab56e42018-07-12 17:12:33 +02005920 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005921 (void) kdf_alg;
Ryan Everettf943e222024-01-19 14:46:39 +00005922 status = PSA_ERROR_BAD_STATE;
5923 LOCAL_OUTPUT_FREE(output_external, output);
5924
5925 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005926 }
5927
5928exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005930 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005931 * This allows us to differentiate between exhausted operations and
5932 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5933 * operations. */
5934 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005935 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005936 operation->alg = alg;
Ryan Everettee5920a2024-02-09 15:09:28 +00005937 if (output != NULL) {
5938 memset(output, '!', output_length);
5939 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005940 }
Ryan Everettda9227d2024-01-25 11:37:22 +00005941
5942 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005944}
5945
David Brown7807bf72021-02-09 16:28:23 -07005946#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005947static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005948{
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 if (data_size >= 8) {
5950 mbedtls_des_key_set_parity(data);
5951 }
5952 if (data_size >= 16) {
5953 mbedtls_des_key_set_parity(data + 8);
5954 }
5955 if (data_size >= 24) {
5956 mbedtls_des_key_set_parity(data + 16);
5957 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005958}
David Brown7807bf72021-02-09 16:28:23 -07005959#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005960
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005961/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 * ECC keys on a Weierstrass elliptic curve require the generation
5963 * of a private key which is an integer
5964 * in the range [1, N - 1], where N is the boundary of the private key domain:
5965 * N is the prime p for Diffie-Hellman, or the order of the
5966 * curve’s base point for ECC.
5967 *
5968 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5969 * This function generates the private key using the following process:
5970 *
5971 * 1. Draw a byte string of length ceiling(m/8) bytes.
5972 * 2. If m is not a multiple of 8, set the most significant
5973 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5974 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5975 * 4. If k > N - 2, discard the result and return to step 1.
5976 * 5. Output k + 1 as the private key.
5977 *
5978 * This method allows compliance to NIST standards, specifically the methods titled
5979 * Key-Pair Generation by Testing Candidates in the following publications:
5980 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5981 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5982 * Diffie-Hellman keys.
5983 *
5984 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5985 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5986 *
5987 * Note: Function allocates memory for *data buffer, so given *data should be
5988 * always NULL.
5989 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005990#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5991#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005992static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005993 psa_key_slot_t *slot,
5994 size_t bits,
5995 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005996 uint8_t **data
5997 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005998{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005999 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006000 mbedtls_mpi k;
6001 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006002 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006003 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006004 size_t m;
6005 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006006
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 mbedtls_mpi_init(&k);
6008 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006009
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006010 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006012 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01006013 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006014
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006016 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006017 goto cleanup;
6018 }
6019
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006020 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006022
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006024
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006025 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006026 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006027 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006028
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006029 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006030
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006031 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006033
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006034 /* Note: This function is always called with *data == NULL and it
6035 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 *data = mbedtls_calloc(1, m_bytes);
6037 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006038 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006039 goto cleanup;
6040 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006041
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006043 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006045 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006047
6048 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006050 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006051 * (8 * ceiling(m/8) - m) bits of the first byte in
6052 * the string to zero.
6053 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006055 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006056 }
6057
6058 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 * big-endian byte string.
6060 */
6061 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006062
6063 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 * Result of comparison is returned. When it indicates error
6065 * then this function is called again.
6066 */
6067 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006068 }
6069
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006070 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6072 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006073cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 if (ret != 0) {
6075 status = mbedtls_to_psa_error(ret);
6076 }
6077 if (status != PSA_SUCCESS) {
6078 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006079 *data = NULL;
6080 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006081 mbedtls_mpi_free(&k);
6082 mbedtls_mpi_free(&diff_N_2);
6083 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006084}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006085
6086/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6087 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6088 *
6089 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6090 * draw a 32-byte string and process it as specified in
6091 * Elliptic Curves for Security [RFC7748] §5.
6092 *
6093 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6094 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6095 *
6096 * Note: Function allocates memory for *data buffer, so given *data should be
6097 * always NULL.
6098 */
6099
6100static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6101 size_t bits,
6102 psa_key_derivation_operation_t *operation,
6103 uint8_t **data
6104 )
6105{
6106 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006107 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006108
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006110 case 255:
6111 output_length = 32;
6112 break;
6113 case 448:
6114 output_length = 56;
6115 break;
6116 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006118 break;
6119 }
6120
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006122
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 if (*data == NULL) {
6124 return PSA_ERROR_INSUFFICIENT_MEMORY;
6125 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006126
Gilles Peskine449bd832023-01-11 14:50:10 +01006127 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006128
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006130 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006131 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006132
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006134 case 255:
6135 (*data)[0] &= 248;
6136 (*data)[31] &= 127;
6137 (*data)[31] |= 64;
6138 break;
6139 case 448:
6140 (*data)[0] &= 252;
6141 (*data)[55] |= 128;
6142 break;
6143 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006145 break;
6146 }
6147
6148 return status;
6149}
Valerio Setti86587ab2023-06-27 13:09:30 +02006150#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6151static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6152 psa_key_slot_t *slot, size_t bits,
6153 psa_key_derivation_operation_t *operation, uint8_t **data)
6154{
6155 (void) slot;
6156 (void) bits;
6157 (void) operation;
6158 (void) data;
6159 return PSA_ERROR_NOT_SUPPORTED;
6160}
6161
6162static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6163 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6164{
6165 (void) bits;
6166 (void) operation;
6167 (void) data;
6168 return PSA_ERROR_NOT_SUPPORTED;
6169}
6170#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6171#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006172
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006173static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006174 psa_key_slot_t *slot,
6175 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006177{
6178 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306180 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006181 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006182 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6185 return PSA_ERROR_INVALID_ARGUMENT;
6186 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006187
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006188#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006189 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6191 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6192 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006193 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6195 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006196 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 }
6198 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006199 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006200 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6201 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006202 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006204 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006205 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006206#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006207 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 if (key_type_is_raw_bytes(slot->attr.type)) {
6209 if (bits % 8 != 0) {
6210 return PSA_ERROR_INVALID_ARGUMENT;
6211 }
6212 data = mbedtls_calloc(1, bytes);
6213 if (data == NULL) {
6214 return PSA_ERROR_INSUFFICIENT_MEMORY;
6215 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006216
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 status = psa_key_derivation_output_bytes(operation, data, bytes);
6218 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006219 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 }
David Brown12ca5032021-02-11 11:02:00 -07006221#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6223 psa_des_set_key_parity(data, bytes);
6224 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006225#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 } else {
6227 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006228 }
Ronald Crondd04d422020-11-28 15:14:42 +01006229
Ronald Cronbf33c932020-11-28 18:06:53 +01006230 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006231 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006233 };
6234
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6236 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6237 &storage_size);
6238 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306239 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 }
Archanad8a83dc2021-06-14 10:04:16 +05306241 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 status = psa_allocate_buffer_to_slot(slot, storage_size);
6243 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306244 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006245 }
Archanad8a83dc2021-06-14 10:04:16 +05306246
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 status = psa_driver_wrapper_import_key(&attributes,
6248 data, bytes,
6249 slot->key.data,
6250 slot->key.bytes,
6251 &slot->key.bytes, &bits);
6252 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006253 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006255
6256exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 mbedtls_free(data);
6258 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006259}
6260
Gilles Peskine449bd832023-01-11 14:50:10 +01006261psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6262 psa_key_derivation_operation_t *operation,
6263 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006264{
6265 psa_status_t status;
6266 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006267 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006268
Ronald Cron81709fc2020-11-14 12:10:32 +01006269 *key = MBEDTLS_SVC_KEY_ID_INIT;
6270
Gilles Peskine0f84d622019-09-12 19:03:13 +02006271 /* Reject any attempt to create a zero-length key so that we don't
6272 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 if (psa_get_key_bits(attributes) == 0) {
6274 return PSA_ERROR_INVALID_ARGUMENT;
6275 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006276
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 if (operation->alg == PSA_ALG_NONE) {
6278 return PSA_ERROR_BAD_STATE;
6279 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006280
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 if (!operation->can_output_key) {
6282 return PSA_ERROR_NOT_PERMITTED;
6283 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006284
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6286 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006287#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006289 /* Deriving a key in a secure element is not implemented yet. */
6290 status = PSA_ERROR_NOT_SUPPORTED;
6291 }
6292#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 if (status == PSA_SUCCESS) {
6294 status = psa_generate_derived_key_internal(slot,
6295 attributes->core.bits,
6296 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006297 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 if (status == PSA_SUCCESS) {
6299 status = psa_finish_key_creation(slot, driver, key);
6300 }
6301 if (status != PSA_SUCCESS) {
6302 psa_fail_key_creation(slot, driver);
6303 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006304
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006306}
6307
Gilles Peskineeab56e42018-07-12 17:12:33 +02006308
6309
6310/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006311/* Key derivation */
6312/****************************************************************/
6313
Steven Cooreman932ffb72021-02-15 12:14:32 +01006314#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006315static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006316{
6317#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6319 return 1;
6320 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006321#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006322#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6324 return 1;
6325 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006326#endif
6327#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6329 return 1;
6330 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006331#endif
6332#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6334 return 1;
6335 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006336#endif
6337#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6339 return 1;
6340 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006341#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006342#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6344 return 1;
6345 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006346#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306347#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6348 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6349 return 1;
6350 }
6351#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306352#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6353 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6354 return 1;
6355 }
6356#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006358}
6359
Gilles Peskine449bd832023-01-11 14:50:10 +01006360static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006361{
6362 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006363 psa_status_t status = psa_hash_setup(&operation, alg);
6364 psa_hash_abort(&operation);
6365 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006366}
6367
Gilles Peskine969c5d62019-01-16 15:53:06 +01006368static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006369 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006371{
Janos Follath5fe19732019-06-20 15:09:30 +01006372 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6373 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006375
Gilles Peskine969c5d62019-01-16 15:53:06 +01006376 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 if (!is_kdf_alg_supported(kdf_alg)) {
6378 return PSA_ERROR_NOT_SUPPORTED;
6379 }
John Durkop07cc04a2020-11-16 22:08:34 -08006380
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006381 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306382 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6384 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306385 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6386 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6387 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306388 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306389 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006390 if (hash_size == 0) {
6391 return PSA_ERROR_NOT_SUPPORTED;
6392 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006393
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006394 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6395 * we might fail later, which is somewhat unfriendly and potentially
6396 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 psa_status_t status = psa_hash_try_support(hash_alg);
6398 if (status != PSA_SUCCESS) {
6399 return status;
6400 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006401 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006402
Gilles Peskine449bd832023-01-11 14:50:10 +01006403 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6404 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6405 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6406 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006407 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006408#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006409 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6411 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006412 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006414#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6415 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006416 operation->capacity = 255 * hash_size;
6417 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006418}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006419
Gilles Peskine449bd832023-01-11 14:50:10 +01006420static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006421{
6422#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 if (alg == PSA_ALG_ECDH) {
6424 return PSA_SUCCESS;
6425 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006426#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006427#if defined(PSA_WANT_ALG_FFDH)
6428 if (alg == PSA_ALG_FFDH) {
6429 return PSA_SUCCESS;
6430 }
6431#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006432 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006434}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006435
6436static int psa_key_derivation_allows_free_form_secret_input(
6437 psa_algorithm_t kdf_alg)
6438{
6439#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6440 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6441 return 0;
6442 }
6443#endif
6444 (void) kdf_alg;
6445 return 1;
6446}
John Durkop07cc04a2020-11-16 22:08:34 -08006447#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006448
Gilles Peskine449bd832023-01-11 14:50:10 +01006449psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6450 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006451{
6452 psa_status_t status;
6453
Gilles Peskine449bd832023-01-11 14:50:10 +01006454 if (operation->alg != 0) {
6455 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006456 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006457
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6459 return PSA_ERROR_INVALID_ARGUMENT;
6460 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6461#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6462 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6463 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6464 status = psa_key_agreement_try_support(ka_alg);
6465 if (status != PSA_SUCCESS) {
6466 return status;
6467 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006468 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6469 return PSA_ERROR_INVALID_ARGUMENT;
6470 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6472#else
6473 return PSA_ERROR_NOT_SUPPORTED;
6474#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6475 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6476#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6477 status = psa_key_derivation_setup_kdf(operation, alg);
6478#else
6479 return PSA_ERROR_NOT_SUPPORTED;
6480#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6481 } else {
6482 return PSA_ERROR_INVALID_ARGUMENT;
6483 }
6484
6485 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006486 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 }
6488 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006489}
6490
Przemek Stekiel69c46792022-06-10 12:59:51 +02006491#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006492static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6493 psa_algorithm_t kdf_alg,
6494 psa_key_derivation_step_t step,
6495 const uint8_t *data,
6496 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006497{
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006499 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006501 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006502#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6504 return PSA_ERROR_INVALID_ARGUMENT;
6505 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006506#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 if (hkdf->state != HKDF_STATE_INIT) {
6508 return PSA_ERROR_BAD_STATE;
6509 } else {
6510 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6511 hash_alg,
6512 data, data_length);
6513 if (status != PSA_SUCCESS) {
6514 return status;
6515 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006516 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006518 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006519 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006520#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006522 /* We shouldn't be in different state as HKDF_EXPAND only allows
6523 * two inputs: SECRET (this case) and INFO which does not modify
6524 * the state. It could happen only if the hkdf
6525 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 if (hkdf->state != HKDF_STATE_INIT) {
6527 return PSA_ERROR_BAD_STATE;
6528 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006529
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006530 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6532 return PSA_ERROR_INVALID_ARGUMENT;
6533 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006534
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 memcpy(hkdf->prk, data, data_length);
6536 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006537#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006538 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006539 /* HKDF: If no salt was provided, use an empty salt.
6540 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006542#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6544 return PSA_ERROR_BAD_STATE;
6545 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006546#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6548 hash_alg,
6549 NULL, 0);
6550 if (status != PSA_SUCCESS) {
6551 return status;
6552 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006553 hkdf->state = HKDF_STATE_STARTED;
6554 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 if (hkdf->state != HKDF_STATE_STARTED) {
6556 return PSA_ERROR_BAD_STATE;
6557 }
6558 status = psa_mac_update(&hkdf->hmac,
6559 data, data_length);
6560 if (status != PSA_SUCCESS) {
6561 return status;
6562 }
6563 status = psa_mac_sign_finish(&hkdf->hmac,
6564 hkdf->prk,
6565 sizeof(hkdf->prk),
6566 &data_length);
6567 if (status != PSA_SUCCESS) {
6568 return status;
6569 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006570 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006571
Gilles Peskine2b522db2019-04-12 15:11:49 +02006572 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006573 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006574#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006576 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006578 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006580#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006581 {
6582 /* Block 0 is empty, and the next block will be
6583 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006585 }
6586
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006588 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006589#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6591 return PSA_ERROR_INVALID_ARGUMENT;
6592 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006593#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006594#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6596 hkdf->state == HKDF_STATE_INIT) {
6597 return PSA_ERROR_BAD_STATE;
6598 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006599#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 if (hkdf->state == HKDF_STATE_OUTPUT) {
6601 return PSA_ERROR_BAD_STATE;
6602 }
6603 if (hkdf->info_set) {
6604 return PSA_ERROR_BAD_STATE;
6605 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006606 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006607 if (data_length != 0) {
6608 hkdf->info = mbedtls_calloc(1, data_length);
6609 if (hkdf->info == NULL) {
6610 return PSA_ERROR_INSUFFICIENT_MEMORY;
6611 }
6612 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006613 }
6614 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006615 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006616 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006618 }
6619}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006620#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006621
John Durkop07cc04a2020-11-16 22:08:34 -08006622#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6623 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006624static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6625 const uint8_t *data,
6626 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006627{
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6629 return PSA_ERROR_BAD_STATE;
6630 }
Janos Follathf08e2652019-06-13 09:05:41 +01006631
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 if (data_length != 0) {
6633 prf->seed = mbedtls_calloc(1, data_length);
6634 if (prf->seed == NULL) {
6635 return PSA_ERROR_INSUFFICIENT_MEMORY;
6636 }
Janos Follathf08e2652019-06-13 09:05:41 +01006637
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006639 prf->seed_length = data_length;
6640 }
Janos Follathf08e2652019-06-13 09:05:41 +01006641
Gilles Peskine43f958b2020-12-13 14:55:14 +01006642 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006643
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006645}
6646
Gilles Peskine449bd832023-01-11 14:50:10 +01006647static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6648 const uint8_t *data,
6649 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006650{
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6652 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6653 return PSA_ERROR_BAD_STATE;
6654 }
Janos Follath81550542019-06-13 14:26:34 +01006655
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 if (data_length != 0) {
6657 prf->secret = mbedtls_calloc(1, data_length);
6658 if (prf->secret == NULL) {
6659 return PSA_ERROR_INSUFFICIENT_MEMORY;
6660 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006661
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006663 prf->secret_length = data_length;
6664 }
Janos Follath81550542019-06-13 14:26:34 +01006665
Gilles Peskine43f958b2020-12-13 14:55:14 +01006666 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006667
Gilles Peskine449bd832023-01-11 14:50:10 +01006668 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006669}
6670
Gilles Peskine449bd832023-01-11 14:50:10 +01006671static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6672 const uint8_t *data,
6673 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006674{
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6676 return PSA_ERROR_BAD_STATE;
6677 }
Janos Follath63028dd2019-06-13 09:15:47 +01006678
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 if (data_length != 0) {
6680 prf->label = mbedtls_calloc(1, data_length);
6681 if (prf->label == NULL) {
6682 return PSA_ERROR_INSUFFICIENT_MEMORY;
6683 }
Janos Follath63028dd2019-06-13 09:15:47 +01006684
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006686 prf->label_length = data_length;
6687 }
Janos Follath63028dd2019-06-13 09:15:47 +01006688
Gilles Peskine43f958b2020-12-13 14:55:14 +01006689 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006690
Gilles Peskine449bd832023-01-11 14:50:10 +01006691 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006692}
6693
Gilles Peskine449bd832023-01-11 14:50:10 +01006694static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6695 psa_key_derivation_step_t step,
6696 const uint8_t *data,
6697 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006698{
Gilles Peskine449bd832023-01-11 14:50:10 +01006699 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006700 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006701 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006702 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006704 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006706 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006708 }
6709}
John Durkop07cc04a2020-11-16 22:08:34 -08006710#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6711 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6712
6713#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6714static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6715 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006716 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006717 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006718{
6719 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006720 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6721 4 + data_length + prf->other_secret_length :
6722 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006723
Gilles Peskine449bd832023-01-11 14:50:10 +01006724 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6725 return PSA_ERROR_INVALID_ARGUMENT;
6726 }
John Durkop07cc04a2020-11-16 22:08:34 -08006727
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 uint8_t *pms = mbedtls_calloc(1, pms_len);
6729 if (pms == NULL) {
6730 return PSA_ERROR_INSUFFICIENT_MEMORY;
6731 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006732 uint8_t *cur = pms;
6733
6734 /* pure-PSK:
6735 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006736 *
6737 * The premaster secret is formed as follows: if the PSK is N octets
6738 * long, concatenate a uint16 with the value N, N zero octets, a second
6739 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006740 *
6741 * mixed-PSK:
6742 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6743 * follows: concatenate a uint16 with the length of the other secret,
6744 * the other secret itself, uint16 with the length of PSK, and the
6745 * PSK itself.
6746 * For details please check:
6747 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6748 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6749 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006750 */
6751
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6753 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6754 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6755 if (prf->other_secret_length != 0) {
6756 memcpy(cur, prf->other_secret, prf->other_secret_length);
6757 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006758 cur += prf->other_secret_length;
6759 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 } else {
6761 *cur++ = MBEDTLS_BYTE_1(data_length);
6762 *cur++ = MBEDTLS_BYTE_0(data_length);
6763 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006764 cur += data_length;
6765 }
6766
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 *cur++ = MBEDTLS_BYTE_1(data_length);
6768 *cur++ = MBEDTLS_BYTE_0(data_length);
6769 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006770 cur += data_length;
6771
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006772 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006773
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006774 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006776}
Janos Follath6660f0e2019-06-17 08:44:03 +01006777
Przemek Stekiele47201b2022-04-19 13:53:28 +02006778static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6779 psa_tls12_prf_key_derivation_t *prf,
6780 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006782{
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6784 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006785 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006786
6787 if (data_length != 0) {
6788 prf->other_secret = mbedtls_calloc(1, data_length);
6789 if (prf->other_secret == NULL) {
6790 return PSA_ERROR_INSUFFICIENT_MEMORY;
6791 }
6792
6793 memcpy(prf->other_secret, data, data_length);
6794 prf->other_secret_length = data_length;
6795 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006796 prf->other_secret_length = 0;
6797 }
6798
6799 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6800
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006802}
6803
Janos Follath6660f0e2019-06-17 08:44:03 +01006804static psa_status_t psa_tls12_prf_psk_to_ms_input(
6805 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006806 psa_key_derivation_step_t step,
6807 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006809{
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006811 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 return psa_tls12_prf_psk_to_ms_set_key(prf,
6813 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006814 break;
6815 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6817 data,
6818 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006819 break;
6820 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006822 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006823
Przemek Stekiele47201b2022-04-19 13:53:28 +02006824 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006825}
John Durkop07cc04a2020-11-16 22:08:34 -08006826#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006827
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006828#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6829static psa_status_t psa_tls12_ecjpake_to_pms_input(
6830 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006831 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006832 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006834{
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6836 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6837 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006838 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006839
6840 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 if (data[0] != 0x04) {
6842 return PSA_ERROR_INVALID_ARGUMENT;
6843 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006844
6845 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006846 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006847
Gilles Peskine449bd832023-01-11 14:50:10 +01006848 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006849}
6850#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306851
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306852#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306853static psa_status_t psa_pbkdf2_set_input_cost(
6854 psa_pbkdf2_key_derivation_t *pbkdf2,
6855 psa_key_derivation_step_t step,
6856 uint64_t data)
6857{
6858 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6859 return PSA_ERROR_INVALID_ARGUMENT;
6860 }
6861
6862 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6863 return PSA_ERROR_BAD_STATE;
6864 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306865
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306866 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306867 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306868 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306869
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306870 if (data == 0) {
6871 return PSA_ERROR_INVALID_ARGUMENT;
6872 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306873
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306874 pbkdf2->input_cost = data;
6875 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6876
6877 return PSA_SUCCESS;
6878}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306879
6880static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6881 const uint8_t *data,
6882 size_t data_length)
6883{
Gilles Peskineead17662023-08-20 22:02:51 +02006884 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6885 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6886 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6887 /* Appending to existing salt. No state change. */
6888 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306889 return PSA_ERROR_BAD_STATE;
6890 }
6891
Gilles Peskineca57d782023-07-20 19:08:06 +02006892 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006893 /* Appending an empty string, nothing to do. */
6894 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306895 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306896
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306897 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6898 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306899 return PSA_ERROR_INSUFFICIENT_MEMORY;
6900 }
6901
Gilles Peskineead17662023-08-20 22:02:51 +02006902 if (pbkdf2->salt_length != 0) {
6903 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6904 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306905 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306906 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306907 mbedtls_free(pbkdf2->salt);
6908 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306909 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306910 return PSA_SUCCESS;
6911}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306912
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306913#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306914static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306915 const uint8_t *input,
6916 size_t input_len,
6917 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306918 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306919{
6920 psa_status_t status = PSA_SUCCESS;
6921 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
Ryan Everett5d2e82f2024-02-07 17:24:59 +00006922 return psa_hash_compute(hash_alg, input, input_len, output,
6923 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
6924 } else if (input_len > 0) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306925 memcpy(output, input, input_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306926 }
Ryan Everett5d2e82f2024-02-07 17:24:59 +00006927 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306928 return status;
6929}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306930#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306931
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306932#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306933static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6934 size_t input_len,
6935 uint8_t *output,
6936 size_t *output_len)
6937{
6938 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306939 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306940 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306941 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306942 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6943 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6944 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306945 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306946 * mac_size as the driver function sets mac_output_length = mac_size
6947 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306948 status = psa_driver_wrapper_mac_compute(&attributes,
6949 zeros, sizeof(zeros),
6950 PSA_ALG_CMAC, input, input_len,
6951 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306952 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6953 128U,
6954 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306955 output_len);
6956 } else {
6957 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306958 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306959 }
6960 return status;
6961}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306962#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306963
6964static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306965 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306966 const uint8_t *data,
6967 size_t data_length)
6968{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306969 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306970 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6971 return PSA_ERROR_BAD_STATE;
6972 }
6973
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306974#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306975 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6976 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6977 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6978 pbkdf2->password,
6979 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306980 } else
6981#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6982#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6983 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306984 status = psa_pbkdf2_cmac_set_password(data, data_length,
6985 pbkdf2->password,
6986 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306987 } else
6988#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6989 {
6990 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306991 }
6992
6993 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6994
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306995 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306996}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306997
6998static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306999 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307000 psa_key_derivation_step_t step,
7001 const uint8_t *data,
7002 size_t data_length)
7003{
7004 switch (step) {
7005 case PSA_KEY_DERIVATION_INPUT_SALT:
7006 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7007 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307008 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307009 default:
7010 return PSA_ERROR_INVALID_ARGUMENT;
7011 }
7012}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307013#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307014
Gilles Peskineb8965192019-09-24 16:21:10 +02007015/** Check whether the given key type is acceptable for the given
7016 * input step of a key derivation.
7017 *
7018 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7019 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7020 * Both secret and non-secret inputs can alternatively have the type
7021 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7022 * that the input was passed as a buffer rather than via a key object.
7023 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007024static int psa_key_derivation_check_input_type(
7025 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007027{
Gilles Peskine449bd832023-01-11 14:50:10 +01007028 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007029 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 if (key_type == PSA_KEY_TYPE_DERIVE) {
7031 return PSA_SUCCESS;
7032 }
7033 if (key_type == PSA_KEY_TYPE_NONE) {
7034 return PSA_SUCCESS;
7035 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007036 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007037 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 if (key_type == PSA_KEY_TYPE_DERIVE) {
7039 return PSA_SUCCESS;
7040 }
7041 if (key_type == PSA_KEY_TYPE_NONE) {
7042 return PSA_SUCCESS;
7043 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007044 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007045 case PSA_KEY_DERIVATION_INPUT_LABEL:
7046 case PSA_KEY_DERIVATION_INPUT_SALT:
7047 case PSA_KEY_DERIVATION_INPUT_INFO:
7048 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7050 return PSA_SUCCESS;
7051 }
7052 if (key_type == PSA_KEY_TYPE_NONE) {
7053 return PSA_SUCCESS;
7054 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007055 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307056 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7057 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7058 return PSA_SUCCESS;
7059 }
7060 if (key_type == PSA_KEY_TYPE_DERIVE) {
7061 return PSA_SUCCESS;
7062 }
7063 if (key_type == PSA_KEY_TYPE_NONE) {
7064 return PSA_SUCCESS;
7065 }
7066 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007067 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007068 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007069}
7070
Janos Follathb80a94e2019-06-12 15:54:46 +01007071static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007072 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007073 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007074 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007075 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007077{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007078 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007080
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 status = psa_key_derivation_check_input_type(step, key_type);
7082 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007083 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007085
Przemek Stekiel69c46792022-06-10 12:59:51 +02007086#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7088 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7089 step, data, data_length);
7090 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007091#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007092#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7094 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7095 step, data, data_length);
7096 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007097#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7098#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007099 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7100 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7101 step, data, data_length);
7102 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007103#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007104#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007106 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7108 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007109#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307110#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307111 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307112 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7113 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307114 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307115#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007116 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007117 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007118 (void) data;
7119 (void) data_length;
7120 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007121 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007122 }
7123
Gilles Peskine224b0d62019-09-23 18:13:17 +02007124exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007125 if (status != PSA_SUCCESS) {
7126 psa_key_derivation_abort(operation);
7127 }
7128 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007129}
7130
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307131static psa_status_t psa_key_derivation_input_integer_internal(
7132 psa_key_derivation_operation_t *operation,
7133 psa_key_derivation_step_t step,
7134 uint64_t value)
7135{
7136 psa_status_t status;
7137 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7138
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307139#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307140 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307141 status = psa_pbkdf2_set_input_cost(
7142 &operation->ctx.pbkdf2, step, value);
7143 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307144#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307145 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307146 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307147 (void) value;
7148 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307149 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307150 }
7151
7152 if (status != PSA_SUCCESS) {
7153 psa_key_derivation_abort(operation);
7154 }
7155 return status;
7156}
7157
Janos Follath51f4a0f2019-06-14 11:35:55 +01007158psa_status_t psa_key_derivation_input_bytes(
7159 psa_key_derivation_operation_t *operation,
7160 psa_key_derivation_step_t step,
Ryan Everettd1e398c2024-01-19 14:46:00 +00007161 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007163{
Ryan Everettd1e398c2024-01-19 14:46:00 +00007164 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7165 LOCAL_INPUT_DECLARE(data_external, data);
7166
7167 LOCAL_INPUT_ALLOC(data_external, data_length, data);
7168
7169 status = psa_key_derivation_input_internal(operation, step,
7170 PSA_KEY_TYPE_NONE,
7171 data, data_length);
Ryan Everettb41c3c92024-01-25 11:56:35 +00007172#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everettd1e398c2024-01-19 14:46:00 +00007173exit:
Ryan Everettb41c3c92024-01-25 11:56:35 +00007174#endif
Ryan Everettd1e398c2024-01-19 14:46:00 +00007175 LOCAL_INPUT_FREE(data_external, data);
7176 return status;
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007177}
7178
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307179psa_status_t psa_key_derivation_input_integer(
7180 psa_key_derivation_operation_t *operation,
7181 psa_key_derivation_step_t step,
7182 uint64_t value)
7183{
7184 return psa_key_derivation_input_integer_internal(operation, step, value);
7185}
7186
Janos Follath51f4a0f2019-06-14 11:35:55 +01007187psa_status_t psa_key_derivation_input_key(
7188 psa_key_derivation_operation_t *operation,
7189 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007190 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007191{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007192 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007193 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007194 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007195
Ronald Cron5c522922020-11-14 16:35:34 +01007196 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7198 if (status != PSA_SUCCESS) {
7199 psa_key_derivation_abort(operation);
7200 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007201 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007202
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307203 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7204 * permission to output to a key object. */
7205 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7206 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007207 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007209
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 status = psa_key_derivation_input_internal(operation,
7211 step, slot->attr.type,
7212 slot->key.data,
7213 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007214
Ryan Everett1b70a072024-01-04 10:32:49 +00007215 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007216
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007218}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007219
7220
7221
7222/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007223/* Key agreement */
7224/****************************************************************/
7225
Gilles Peskine449bd832023-01-11 14:50:10 +01007226psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7227 const uint8_t *key_buffer,
7228 size_t key_buffer_size,
7229 psa_algorithm_t alg,
7230 const uint8_t *peer_key,
7231 size_t peer_key_length,
7232 uint8_t *shared_secret,
7233 size_t shared_secret_size,
7234 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007235{
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007237#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007238 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7240 key_buffer_size, alg,
7241 peer_key, peer_key_length,
7242 shared_secret,
7243 shared_secret_size,
7244 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007245#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007246
7247#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7248 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007249 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007250 peer_key,
7251 peer_key_length,
7252 key_buffer,
7253 key_buffer_size,
7254 shared_secret,
7255 shared_secret_size,
7256 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007257#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7258
Gilles Peskine01d718c2018-09-18 12:01:02 +02007259 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007260 (void) attributes;
7261 (void) key_buffer;
7262 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007263 (void) peer_key;
7264 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007265 (void) shared_secret;
7266 (void) shared_secret_size;
7267 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007269 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007270}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007271
Aditya Deshpande17845b82022-10-13 17:21:01 +01007272/** Internal function for raw key agreement
7273 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007274 * to the driver's implementation if a driver is present.
7275 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007276 * (psa_key_agreement_raw_builtin).
7277 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007278static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7279 psa_key_slot_t *private_key,
7280 const uint8_t *peer_key,
7281 size_t peer_key_length,
7282 uint8_t *shared_secret,
7283 size_t shared_secret_size,
7284 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007285{
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7287 return PSA_ERROR_NOT_SUPPORTED;
7288 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007289
7290 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007292 };
7293
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 return psa_driver_wrapper_key_agreement(&attributes,
7295 private_key->key.data,
7296 private_key->key.bytes, alg,
7297 peer_key, peer_key_length,
7298 shared_secret,
7299 shared_secret_size,
7300 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007301}
7302
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007303/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007304 * to potentially free embedded data structures and wipe confidential data.
7305 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007306static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7307 psa_key_derivation_step_t step,
7308 psa_key_slot_t *private_key,
7309 const uint8_t *peer_key,
7310 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007311{
7312 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007313 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007314 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007316
7317 /* Step 1: run the secret agreement algorithm to generate the shared
7318 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 status = psa_key_agreement_raw_internal(ka_alg,
7320 private_key,
7321 peer_key, peer_key_length,
7322 shared_secret,
7323 sizeof(shared_secret),
7324 &shared_secret_length);
7325 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007326 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007328
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007329 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007330 * the shared secret. A shared secret is permitted wherever a key
7331 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007332 status = psa_key_derivation_input_internal(operation, step,
7333 PSA_KEY_TYPE_DERIVE,
7334 shared_secret,
7335 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007336exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7338 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007339}
7340
Gilles Peskine449bd832023-01-11 14:50:10 +01007341psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7342 psa_key_derivation_step_t step,
7343 mbedtls_svc_key_id_t private_key,
Thomas Daubney9739ac02024-02-15 13:15:47 +00007344 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007345 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007346{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007347 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007348 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007349 psa_key_slot_t *slot;
Thomas Daubney9739ac02024-02-15 13:15:47 +00007350 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007351
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7353 return PSA_ERROR_INVALID_ARGUMENT;
7354 }
Ronald Cron5c522922020-11-14 16:35:34 +01007355 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7357 if (status != PSA_SUCCESS) {
7358 return status;
7359 }
Thomas Daubney9739ac02024-02-15 13:15:47 +00007360
7361 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key)
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 status = psa_key_agreement_internal(operation, step,
7363 slot,
7364 peer_key, peer_key_length);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007365
Thomas Daubney50f58fc2024-02-15 14:24:03 +00007366#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney9739ac02024-02-15 13:15:47 +00007367exit:
Thomas Daubney50f58fc2024-02-15 14:24:03 +00007368#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 if (status != PSA_SUCCESS) {
7370 psa_key_derivation_abort(operation);
7371 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007372 /* If a private key has been added as SECRET, we allow the derived
7373 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007375 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007377 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007378
Ryan Everett1b70a072024-01-04 10:32:49 +00007379 unlock_status = psa_unregister_read(slot);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007380 LOCAL_INPUT_FREE(peer_key_external, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007382}
7383
Gilles Peskine449bd832023-01-11 14:50:10 +01007384psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7385 mbedtls_svc_key_id_t private_key,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007386 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 size_t peer_key_length,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007388 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 size_t output_size,
7390 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007391{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007392 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007393 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007394 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007395 size_t expected_length;
Thomas Daubney81899ab2024-02-15 12:57:26 +00007396 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
7397 LOCAL_OUTPUT_DECLARE(output_external, output);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007398
Gilles Peskine449bd832023-01-11 14:50:10 +01007399 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007400 status = PSA_ERROR_INVALID_ARGUMENT;
7401 goto exit;
7402 }
Ronald Cron5c522922020-11-14 16:35:34 +01007403 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7405 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007406 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007408
Gilles Peskine3e561302022-04-14 00:17:15 +02007409 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7410 * for the output size. The PSA specification only guarantees that this
7411 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7412 * but it might be nice to allow smaller buffers if the output fits.
7413 * At the time of writing this comment, with only ECDH implemented,
7414 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7415 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7416 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007417 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7419 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007420 status = PSA_ERROR_BUFFER_TOO_SMALL;
7421 goto exit;
7422 }
7423
Thomas Daubney81899ab2024-02-15 12:57:26 +00007424 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
7425 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 status = psa_key_agreement_raw_internal(alg, slot,
7427 peer_key, peer_key_length,
7428 output, output_size,
7429 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007430
7431exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007433 /* If an error happens and is not handled properly, the output
7434 * may be used as a key to protect sensitive data. Arrange for such
7435 * a key to be random, which is likely to result in decryption or
7436 * verification errors. This is better than filling the buffer with
7437 * some constant data such as zeros, which would result in the data
7438 * being protected with a reproducible, easily knowable key.
7439 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007441 *output_length = output_size;
7442 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007443
Ryan Everett1b70a072024-01-04 10:32:49 +00007444 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007445
Thomas Daubney81899ab2024-02-15 12:57:26 +00007446 LOCAL_INPUT_FREE(peer_key_external, peer_key);
7447 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007449}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007450
7451
Gilles Peskine30524eb2020-11-13 17:02:26 +01007452
Gilles Peskine86a440b2018-11-12 18:39:40 +01007453/****************************************************************/
7454/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007455/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007456
Gilles Peskine672a7712023-04-28 21:00:28 +02007457#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7458#include "entropy_poll.h"
7459#endif
7460
Gilles Peskine30524eb2020-11-13 17:02:26 +01007461/** Initialize the PSA random generator.
7462 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007463static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007464{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007465#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007467#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7468
Gilles Peskine30524eb2020-11-13 17:02:26 +01007469 /* Set default configuration if
7470 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007472 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 }
7474 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007475 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007477
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007479#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7480 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7481 /* The PSA entropy injection feature depends on using NV seed as an entropy
7482 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 mbedtls_entropy_add_source(&rng->entropy,
7484 mbedtls_nv_seed_poll, NULL,
7485 MBEDTLS_ENTROPY_BLOCK_SIZE,
7486 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007487#endif
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007490#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007491}
7492
7493/** Deinitialize the PSA random generator.
7494 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007495static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007496{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007497#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007498 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007499#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007500 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7501 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007502#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007503}
7504
7505/** Seed the PSA random generator.
7506 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007507static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007508{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007509#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7510 /* Do nothing: the external RNG seeds itself. */
7511 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007513#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007514 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7516 drbg_seed, sizeof(drbg_seed) - 1);
7517 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007518#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007519}
7520
Gilles Peskine449bd832023-01-11 14:50:10 +01007521psa_status_t psa_generate_random(uint8_t *output,
7522 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007523{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007524 GUARD_MODULE_INITIALIZED;
7525
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007526#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7527
7528 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7530 output, output_size,
7531 &output_length);
7532 if (status != PSA_SUCCESS) {
7533 return status;
7534 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007535 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007536 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 if (output_length != output_size) {
7538 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7539 }
7540 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007541
7542#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7543
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007545 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7547 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7548 output_size);
7549 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7550 output, request_size);
7551 if (ret != 0) {
7552 return mbedtls_to_psa_error(ret);
7553 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007554 output_size -= request_size;
7555 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007556 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007558#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007559}
7560
Gilles Peskine8814fc42020-12-14 15:33:44 +01007561/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007562 *
7563 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7564 * `psa_generate_random(...)`. The state parameter is ignored since the
7565 * PSA API doesn't support passing an explicit state.
7566 *
7567 * In the non-external case, psa_generate_random() calls an
7568 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7569 * and semantics as mbedtls_psa_get_random(). As an optimization,
7570 * instead of doing this back-and-forth between the PSA API and the
7571 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7572 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007573 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007574#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7575int mbedtls_psa_get_random(void *p_rng,
7576 unsigned char *output,
7577 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007578{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007579 /* This function takes a pointer to the RNG state because that's what
7580 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7581 * its own state internally and doesn't let the caller access that state.
7582 * So we just ignore the state parameter, and in practice we'll pass
7583 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007584 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 psa_status_t status = psa_generate_random(output, output_size);
7586 if (status == PSA_SUCCESS) {
7587 return 0;
7588 } else {
7589 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7590 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007591}
7592#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7593
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007594#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007595psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7596 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007597{
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 if (global_data.initialized) {
7599 return PSA_ERROR_NOT_PERMITTED;
7600 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007601
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7603 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7604 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7605 return PSA_ERROR_INVALID_ARGUMENT;
7606 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007607
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007609}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007610#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007611
Ronald Cron3772afe2021-02-08 16:10:05 +01007612/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007613 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007614 * \param type The key type
7615 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007616 *
7617 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007618 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007619 * \retval #PSA_ERROR_INVALID_ARGUMENT
7620 * The size in bits of the key is not valid.
7621 * \retval #PSA_ERROR_NOT_SUPPORTED
7622 * The type and/or the size in bits of the key or the combination of
7623 * the two is not supported.
7624 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007625static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007627{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007628 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 if (key_type_is_raw_bytes(type)) {
7631 status = psa_validate_unstructured_key_bit_size(type, bits);
7632 if (status != PSA_SUCCESS) {
7633 return status;
7634 }
7635 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007636#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7638 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7639 return PSA_ERROR_NOT_SUPPORTED;
7640 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007641 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007642 return PSA_ERROR_NOT_SUPPORTED;
7643 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007644
Ronald Cron01b2aba2020-10-05 09:42:02 +02007645 /* Accept only byte-aligned keys, for the same reasons as
7646 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 if (bits % 8 != 0) {
7648 return PSA_ERROR_NOT_SUPPORTED;
7649 }
7650 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007651#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007652
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007653#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007655 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 return PSA_SUCCESS;
7657 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007658#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007659
Valerio Settia55f0422023-07-10 15:34:41 +02007660#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007661 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007662 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007663 return PSA_ERROR_NOT_SUPPORTED;
7664 }
7665 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007666#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007667 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007669 }
7670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007672}
7673
Ronald Cron55ed0592020-10-05 10:30:40 +02007674psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007675 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007677{
7678 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007679 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007680
Gilles Peskine449bd832023-01-11 14:50:10 +01007681 if ((attributes->domain_parameters == NULL) &&
7682 (attributes->domain_parameters_size != 0)) {
7683 return PSA_ERROR_INVALID_ARGUMENT;
7684 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007685
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 if (key_type_is_raw_bytes(type)) {
7687 status = psa_generate_random(key_buffer, key_buffer_size);
7688 if (status != PSA_SUCCESS) {
7689 return status;
7690 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007691
David Brown12ca5032021-02-11 11:02:00 -07007692#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007693 if (type == PSA_KEY_TYPE_DES) {
7694 psa_des_set_key_parity(key_buffer, key_buffer_size);
7695 }
David Brown8107e312021-02-12 08:08:46 -07007696#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007698
Valerio Setti76df8c12023-07-11 14:11:28 +02007699#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007700 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7701 return mbedtls_psa_rsa_generate_key(attributes,
7702 key_buffer,
7703 key_buffer_size,
7704 key_buffer_length);
7705 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007706#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007707
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007708#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7710 return mbedtls_psa_ecp_generate_key(attributes,
7711 key_buffer,
7712 key_buffer_size,
7713 key_buffer_length);
7714 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007715#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007716
Valerio Settia55f0422023-07-10 15:34:41 +02007717#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007718 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7719 return mbedtls_psa_ffdh_generate_key(attributes,
7720 key_buffer,
7721 key_buffer_size,
7722 key_buffer_length);
7723 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007724#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007725 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007726 (void) key_buffer_length;
7727 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007728 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007729
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007731}
Darryl Green0c6575a2018-11-07 16:05:30 +00007732
Gilles Peskine449bd832023-01-11 14:50:10 +01007733psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7734 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007735{
7736 psa_status_t status;
7737 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007738 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007739 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007740
Ronald Cron81709fc2020-11-14 12:10:32 +01007741 *key = MBEDTLS_SVC_KEY_ID_INIT;
7742
Gilles Peskine0f84d622019-09-12 19:03:13 +02007743 /* Reject any attempt to create a zero-length key so that we don't
7744 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 if (psa_get_key_bits(attributes) == 0) {
7746 return PSA_ERROR_INVALID_ARGUMENT;
7747 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007748
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007749 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7751 return PSA_ERROR_INVALID_ARGUMENT;
7752 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007753
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7755 &slot, &driver);
7756 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007757 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 }
Gilles Peskine11792082019-08-06 18:36:36 +02007759
Ronald Cron977c2472020-10-13 08:32:21 +02007760 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307761 * storage ( thus not in the case of generating a key in a secure element
7762 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7763 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 if (slot->key.data == NULL) {
7765 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7766 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007767 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 attributes->core.type, attributes->core.bits);
7769 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007770 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007772
7773 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007774 attributes->core.type,
7775 attributes->core.bits);
7776 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007777 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 attributes, &key_buffer_size);
7779 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007780 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 }
Ronald Cron977c2472020-10-13 08:32:21 +02007782 }
Ronald Cron977c2472020-10-13 08:32:21 +02007783
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7785 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007786 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 }
Ronald Cron977c2472020-10-13 08:32:21 +02007788 }
7789
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 status = psa_driver_wrapper_generate_key(attributes,
7791 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007792
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 if (status != PSA_SUCCESS) {
7794 psa_remove_key_data_from_memory(slot);
7795 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007796
Gilles Peskine11792082019-08-06 18:36:36 +02007797exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 if (status == PSA_SUCCESS) {
7799 status = psa_finish_key_creation(slot, driver, key);
7800 }
7801 if (status != PSA_SUCCESS) {
7802 psa_fail_key_creation(slot, driver);
7803 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007804
Gilles Peskine449bd832023-01-11 14:50:10 +01007805 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007806}
7807
Gilles Peskinee59236f2018-01-27 23:32:46 +01007808/****************************************************************/
7809/* Module setup */
7810/****************************************************************/
7811
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007812#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007813psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 void (* entropy_init)(mbedtls_entropy_context *ctx),
7815 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007816{
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7818 return PSA_ERROR_BAD_STATE;
7819 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007820 global_data.rng.entropy_init = entropy_init;
7821 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007822 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007823}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007824#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007825
Gilles Peskine449bd832023-01-11 14:50:10 +01007826void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007827{
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007829 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7830 mbedtls_psa_random_free(&global_data.rng);
7831 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007832 /* Wipe all remaining data, including configuration.
7833 * In particular, this sets all state indicator to the value
7834 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007835 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007836
7837 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007839}
7840
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007841#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7842/** Recover a transaction that was interrupted by a power failure.
7843 *
7844 * This function is called during initialization, before psa_crypto_init()
7845 * returns. If this function returns a failure status, the initialization
7846 * fails.
7847 */
7848static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007850{
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007852 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7853 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007854 /* TODO - fall through to the failure case until this
7855 * is implemented.
7856 * https://github.com/ARMmbed/mbed-crypto/issues/218
7857 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007858 default:
7859 /* We found an unsupported transaction in the storage.
7860 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007861 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007862 }
7863}
7864#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7865
Gilles Peskine449bd832023-01-11 14:50:10 +01007866psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007867{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007868 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007869
Gilles Peskinec6b69072018-11-20 21:42:52 +01007870 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 if (global_data.initialized != 0) {
7872 return PSA_SUCCESS;
7873 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007874
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007875 /* Init drivers */
7876 status = psa_driver_wrapper_init();
7877 if (status != PSA_SUCCESS) {
7878 goto exit;
7879 }
7880 global_data.drivers_initialized = 1;
7881
Valerio Setti402cfba2023-11-13 10:24:32 +01007882 status = psa_initialize_key_slots();
7883 if (status != PSA_SUCCESS) {
7884 goto exit;
7885 }
7886
Gilles Peskine30524eb2020-11-13 17:02:26 +01007887 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007889 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 status = mbedtls_psa_random_seed(&global_data.rng);
7891 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007892 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007894 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007895
Gilles Peskine4b734222019-07-24 15:56:31 +02007896#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 status = psa_crypto_load_transaction();
7898 if (status == PSA_SUCCESS) {
7899 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7900 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007901 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007902 }
7903 status = psa_crypto_stop_transaction();
7904 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007905 /* There's no transaction to complete. It's all good. */
7906 status = PSA_SUCCESS;
7907 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007908#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007909
Gilles Peskinec6b69072018-11-20 21:42:52 +01007910 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007911 global_data.initialized = 1;
7912
7913exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 if (status != PSA_SUCCESS) {
7915 mbedtls_psa_crypto_free();
7916 }
7917 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007918}
7919
Yanray Wangffc3c482023-07-11 12:01:04 +08007920#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007921psa_status_t psa_crypto_driver_pake_get_password_len(
7922 const psa_crypto_driver_pake_inputs_t *inputs,
7923 size_t *password_len)
7924{
7925 if (inputs->password_len == 0) {
7926 return PSA_ERROR_BAD_STATE;
7927 }
7928
7929 *password_len = inputs->password_len;
7930
7931 return PSA_SUCCESS;
7932}
7933
7934psa_status_t psa_crypto_driver_pake_get_password(
7935 const psa_crypto_driver_pake_inputs_t *inputs,
7936 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7937{
7938 if (inputs->password_len == 0) {
7939 return PSA_ERROR_BAD_STATE;
7940 }
7941
7942 if (buffer_size < inputs->password_len) {
7943 return PSA_ERROR_BUFFER_TOO_SMALL;
7944 }
7945
7946 memcpy(buffer, inputs->password, inputs->password_len);
7947 *buffer_length = inputs->password_len;
7948
7949 return PSA_SUCCESS;
7950}
7951
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007952psa_status_t psa_crypto_driver_pake_get_user_len(
7953 const psa_crypto_driver_pake_inputs_t *inputs,
7954 size_t *user_len)
7955{
7956 if (inputs->user_len == 0) {
7957 return PSA_ERROR_BAD_STATE;
7958 }
7959
7960 *user_len = inputs->user_len;
7961
7962 return PSA_SUCCESS;
7963}
7964
7965psa_status_t psa_crypto_driver_pake_get_user(
7966 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007967 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007968{
7969 if (inputs->user_len == 0) {
7970 return PSA_ERROR_BAD_STATE;
7971 }
7972
Przemek Stekielc0e62502023-03-14 11:49:36 +01007973 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007974 return PSA_ERROR_BUFFER_TOO_SMALL;
7975 }
7976
Przemek Stekielc0e62502023-03-14 11:49:36 +01007977 memcpy(user_id, inputs->user, inputs->user_len);
7978 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007979
7980 return PSA_SUCCESS;
7981}
7982
7983psa_status_t psa_crypto_driver_pake_get_peer_len(
7984 const psa_crypto_driver_pake_inputs_t *inputs,
7985 size_t *peer_len)
7986{
7987 if (inputs->peer_len == 0) {
7988 return PSA_ERROR_BAD_STATE;
7989 }
7990
7991 *peer_len = inputs->peer_len;
7992
7993 return PSA_SUCCESS;
7994}
7995
7996psa_status_t psa_crypto_driver_pake_get_peer(
7997 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007998 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007999{
8000 if (inputs->peer_len == 0) {
8001 return PSA_ERROR_BAD_STATE;
8002 }
8003
Przemek Stekielc0e62502023-03-14 11:49:36 +01008004 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008005 return PSA_ERROR_BUFFER_TOO_SMALL;
8006 }
8007
Przemek Stekielc0e62502023-03-14 11:49:36 +01008008 memcpy(peer_id, inputs->peer, inputs->peer_len);
8009 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008010
8011 return PSA_SUCCESS;
8012}
8013
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008014psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8015 const psa_crypto_driver_pake_inputs_t *inputs,
8016 psa_pake_cipher_suite_t *cipher_suite)
8017{
8018 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8019 return PSA_ERROR_BAD_STATE;
8020 }
8021
8022 *cipher_suite = inputs->cipher_suite;
8023
8024 return PSA_SUCCESS;
8025}
8026
Neil Armstronga7d08c32022-06-01 18:21:20 +02008027psa_status_t psa_pake_setup(
8028 psa_pake_operation_t *operation,
8029 const psa_pake_cipher_suite_t *cipher_suite)
8030{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008031 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008032
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008033 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008034 status = PSA_ERROR_BAD_STATE;
8035 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008036 }
8037
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008038 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008039 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008040 status = PSA_ERROR_INVALID_ARGUMENT;
8041 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008042 }
8043
Przemek Stekiel51eac532022-12-07 11:04:51 +01008044 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8045
Przemek Stekiele12ed362022-12-21 12:54:46 +01008046 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008047 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8048 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008049 operation->data.inputs.cipher_suite = *cipher_suite;
8050
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008051#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008052 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008053 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008054 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008055
David Horstmann16f01512023-06-14 17:21:07 +01008056 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008057 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008058 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008059#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008060 {
8061 status = PSA_ERROR_NOT_SUPPORTED;
8062 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008063 }
8064
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008065 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8066
Przemek Stekiel51eac532022-12-07 11:04:51 +01008067 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008068exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008069 psa_pake_abort(operation);
8070 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008071}
8072
8073psa_status_t psa_pake_set_password_key(
8074 psa_pake_operation_t *operation,
8075 mbedtls_svc_key_id_t password)
8076{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008077 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008078 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8079 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008080 psa_key_attributes_t attributes;
8081 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008082
Przemek Stekiel51eac532022-12-07 11:04:51 +01008083 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008084 status = PSA_ERROR_BAD_STATE;
8085 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008086 }
8087
Przemek Stekiel6c764412022-11-22 14:05:12 +01008088 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8089 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008090 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008091 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008092 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008093 }
8094
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008095 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008096 .core = slot->attr
8097 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008098
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008099 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008100
Przemek Stekiel51eac532022-12-07 11:04:51 +01008101 if (type != PSA_KEY_TYPE_PASSWORD &&
8102 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8103 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008104 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008105 }
8106
Przemek Stekiel51eac532022-12-07 11:04:51 +01008107 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8108 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008109 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008110 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008111 }
8112
8113 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8114 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008115 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008116exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008117 if (status != PSA_SUCCESS) {
8118 psa_pake_abort(operation);
8119 }
Ryan Everett1b70a072024-01-04 10:32:49 +00008120 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008121 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008122}
8123
8124psa_status_t psa_pake_set_user(
8125 psa_pake_operation_t *operation,
8126 const uint8_t *user_id,
8127 size_t user_id_len)
8128{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008130
8131 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008132 status = PSA_ERROR_BAD_STATE;
8133 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008134 }
8135
Przemek Stekiel51eac532022-12-07 11:04:51 +01008136 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008137 status = PSA_ERROR_INVALID_ARGUMENT;
8138 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008139 }
8140
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008141 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008142 status = PSA_ERROR_BAD_STATE;
8143 goto exit;
8144 }
8145
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008146 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8147 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008148 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8149 goto exit;
8150 }
8151
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008152 memcpy(operation->data.inputs.user, user_id, user_id_len);
8153 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008154
8155 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008156exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008157 psa_pake_abort(operation);
8158 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008159}
8160
8161psa_status_t psa_pake_set_peer(
8162 psa_pake_operation_t *operation,
8163 const uint8_t *peer_id,
8164 size_t peer_id_len)
8165{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008166 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008167
8168 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008169 status = PSA_ERROR_BAD_STATE;
8170 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008171 }
8172
Przemek Stekiel51eac532022-12-07 11:04:51 +01008173 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008174 status = PSA_ERROR_INVALID_ARGUMENT;
8175 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008176 }
8177
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008178 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008179 status = PSA_ERROR_BAD_STATE;
8180 goto exit;
8181 }
8182
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008183 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8184 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008185 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8186 goto exit;
8187 }
8188
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008189 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8190 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008191
8192 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008193exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008194 psa_pake_abort(operation);
8195 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008196}
8197
8198psa_status_t psa_pake_set_role(
8199 psa_pake_operation_t *operation,
8200 psa_pake_role_t role)
8201{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008202 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008203
Przemek Stekiel51eac532022-12-07 11:04:51 +01008204 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008205 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008206 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008207 }
8208
Przemek Stekiel09104b82023-03-06 14:11:51 +01008209 switch (operation->alg) {
8210#if defined(PSA_WANT_ALG_JPAKE)
8211 case PSA_ALG_JPAKE:
8212 if (role == PSA_PAKE_ROLE_NONE) {
8213 return PSA_SUCCESS;
8214 }
8215 status = PSA_ERROR_INVALID_ARGUMENT;
8216 break;
8217#endif
8218 default:
8219 (void) role;
8220 status = PSA_ERROR_NOT_SUPPORTED;
8221 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008222 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008223exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008224 psa_pake_abort(operation);
8225 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008226}
8227
David Horstmanne7f21e62023-05-12 18:17:21 +01008228/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008229#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008230static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008231 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008232{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008233 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008234 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008235 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008236
David Horstmann024e5c52023-06-14 15:48:21 +01008237 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008238 is_x1 = (stage->outputs < 1);
8239 } else {
8240 is_x1 = (stage->inputs < 1);
8241 }
8242
David Horstmann74a3d8c2023-06-14 18:28:19 +01008243 key_share_step = is_x1 ?
8244 PSA_JPAKE_X1_STEP_KEY_SHARE :
8245 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008246 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008247 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8248 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8249 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8250 } else {
8251 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008252 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008253 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008254}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008255#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008256
Przemek Stekiel2797d372022-12-22 11:19:22 +01008257static psa_status_t psa_pake_complete_inputs(
8258 psa_pake_operation_t *operation)
8259{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008260 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008261 /* Create copy of the inputs on stack as inputs share memory
8262 with the driver context which will be setup by the driver. */
8263 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008264
Przemek Stekielfde11282023-03-13 16:06:09 +01008265 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008266 return PSA_ERROR_BAD_STATE;
8267 }
8268
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008269 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008270 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8271 return PSA_ERROR_BAD_STATE;
8272 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008273 }
8274
Przemek Stekiel18620a32023-01-17 16:34:52 +01008275 /* Clear driver context */
8276 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8277
8278 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008279
8280 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008281 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008282
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008283 /* User and peer are translated to role. */
8284 mbedtls_free(inputs.user);
8285 mbedtls_free(inputs.peer);
8286
Przemek Stekiel2797d372022-12-22 11:19:22 +01008287 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008288#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008289 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008290 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008291 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008292#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008293 {
8294 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008295 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008296 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008297 return status;
8298}
8299
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008300#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008301static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008302 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008303 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008304 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008305{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008306 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8307 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8308 step != PSA_PAKE_STEP_ZK_PROOF) {
8309 return PSA_ERROR_INVALID_ARGUMENT;
8310 }
8311
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008312 psa_jpake_computation_stage_t *computation_stage =
8313 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008314
David Horstmann5da95602023-06-08 15:37:12 +01008315 if (computation_stage->round != PSA_JPAKE_FIRST &&
8316 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008317 return PSA_ERROR_BAD_STATE;
8318 }
8319
David Horstmanne7f21e62023-05-12 18:17:21 +01008320 /* Check that the step we are given is the one we were expecting */
8321 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008322 return PSA_ERROR_BAD_STATE;
8323 }
8324
David Horstmanne7f21e62023-05-12 18:17:21 +01008325 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8326 computation_stage->inputs == 0 &&
8327 computation_stage->outputs == 0) {
8328 /* Start of the round, so function decides whether we are inputting
8329 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008330 computation_stage->io_mode = io_mode;
8331 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008332 /* Middle of the round so the mode we are in must match the function
8333 * called by the user */
8334 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008335 }
8336
8337 return PSA_SUCCESS;
8338}
8339
David Horstmanne7f21e62023-05-12 18:17:21 +01008340static psa_status_t psa_jpake_epilogue(
8341 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008342 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008343{
David Horstmanne7f21e62023-05-12 18:17:21 +01008344 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008345 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008346
David Horstmanne7f21e62023-05-12 18:17:21 +01008347 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8348 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008349 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008350 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008351 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008352 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008353 }
8354 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008355 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008356 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008357 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008358 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008359 }
8360 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008361 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8362 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008363 /* End of a round, move to the next round */
8364 stage->inputs = 0;
8365 stage->outputs = 0;
8366 stage->round++;
8367 }
8368 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008369 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008370 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008371 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008372 return PSA_SUCCESS;
8373}
David Horstmanne7f21e62023-05-12 18:17:21 +01008374
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008375#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008376
Neil Armstronga7d08c32022-06-01 18:21:20 +02008377psa_status_t psa_pake_output(
8378 psa_pake_operation_t *operation,
8379 psa_pake_step_t step,
8380 uint8_t *output,
8381 size_t output_size,
8382 size_t *output_length)
8383{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008384 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008385 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008386 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008387
8388 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008389 status = psa_pake_complete_inputs(operation);
8390 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008391 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008392 }
8393 }
8394
8395 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008396 status = PSA_ERROR_BAD_STATE;
8397 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008398 }
8399
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008400 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008401 status = PSA_ERROR_INVALID_ARGUMENT;
8402 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008403 }
8404
Przemek Stekiele12ed362022-12-21 12:54:46 +01008405 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008406#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008407 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008408 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008409 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008410 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008411 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008412 driver_step = convert_jpake_computation_stage_to_driver_step(
8413 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008414 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008415#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008416 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008417 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008418 status = PSA_ERROR_NOT_SUPPORTED;
8419 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008420 }
8421
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008422 status = psa_driver_wrapper_pake_output(operation, driver_step,
8423 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008424
8425 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008426 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008427 }
8428
8429 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008430#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008431 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008432 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008433 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008434 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008435 }
8436 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008437#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008438 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008439 status = PSA_ERROR_NOT_SUPPORTED;
8440 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008441 }
8442
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008443 return PSA_SUCCESS;
8444exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008445 psa_pake_abort(operation);
8446 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008447}
8448
8449psa_status_t psa_pake_input(
8450 psa_pake_operation_t *operation,
8451 psa_pake_step_t step,
8452 const uint8_t *input,
8453 size_t input_length)
8454{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008455 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008456 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008457 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8458 operation->primitive,
8459 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008460
8461 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008462 status = psa_pake_complete_inputs(operation);
8463 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008464 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008465 }
8466 }
8467
8468 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008469 status = PSA_ERROR_BAD_STATE;
8470 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008471 }
8472
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008473 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008474 status = PSA_ERROR_INVALID_ARGUMENT;
8475 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008476 }
8477
Przemek Stekiele12ed362022-12-21 12:54:46 +01008478 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008479#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008480 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008481 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008482 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008483 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008484 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008485 driver_step = convert_jpake_computation_stage_to_driver_step(
8486 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008487 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008488#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008489 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008490 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008491 status = PSA_ERROR_NOT_SUPPORTED;
8492 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008493 }
8494
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008495 status = psa_driver_wrapper_pake_input(operation, driver_step,
8496 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008497
8498 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008499 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008500 }
8501
8502 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008503#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008504 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008505 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008506 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008507 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008508 }
8509 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008510#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008511 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008512 status = PSA_ERROR_NOT_SUPPORTED;
8513 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008514 }
8515
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008516 return PSA_SUCCESS;
8517exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008518 psa_pake_abort(operation);
8519 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008520}
8521
8522psa_status_t psa_pake_get_implicit_key(
8523 psa_pake_operation_t *operation,
8524 psa_key_derivation_operation_t *output)
8525{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008526 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008527 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008528 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008529 size_t shared_key_len = 0;
8530
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008531 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008532 status = PSA_ERROR_BAD_STATE;
8533 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008534 }
8535
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008536#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008537 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008538 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008539 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008540 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008541 status = PSA_ERROR_BAD_STATE;
8542 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008543 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008544 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008545#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008546 {
8547 status = PSA_ERROR_NOT_SUPPORTED;
8548 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008549 }
8550
Przemek Stekiel0c781802022-11-29 14:53:13 +01008551 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8552 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008553 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008554 &shared_key_len);
8555
8556 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008557 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008558 }
8559
8560 status = psa_key_derivation_input_bytes(output,
8561 PSA_KEY_DERIVATION_INPUT_SECRET,
8562 shared_key,
8563 shared_key_len);
8564
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008565 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008566exit:
8567 abort_status = psa_pake_abort(operation);
8568 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008569}
8570
8571psa_status_t psa_pake_abort(
8572 psa_pake_operation_t *operation)
8573{
Przemek Stekield69dca92023-01-31 19:59:20 +01008574 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008575
Przemek Stekield69dca92023-01-31 19:59:20 +01008576 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008577 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008578 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008579
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008580 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8581 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008582 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008583 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008584 }
8585 if (operation->data.inputs.user != NULL) {
8586 mbedtls_free(operation->data.inputs.user);
8587 }
8588 if (operation->data.inputs.peer != NULL) {
8589 mbedtls_free(operation->data.inputs.peer);
8590 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008591 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008592 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008593
Przemek Stekield69dca92023-01-31 19:59:20 +01008594 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008595}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008596#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008597
David Horstmann00d7a042023-12-07 18:39:17 +00008598/* Memory copying test hooks. These are called before input copy, after input
8599 * copy, before output copy and after output copy, respectively.
8600 * They are used by memory-poisoning tests to temporarily unpoison buffers
8601 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008602#if defined(MBEDTLS_TEST_HOOKS)
8603void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8604void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8605void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8606void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8607#endif
David Horstmannfde97392023-10-30 20:29:43 +00008608
David Horstmann1b7279a2023-11-15 15:18:30 +00008609/** Copy from an input buffer to a local copy.
8610 *
8611 * \param[in] input Pointer to input buffer.
8612 * \param[in] input_len Length of the input buffer.
8613 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8614 * \param[out] input_copy_len Length of the local copy buffer.
8615 * \return #PSA_SUCCESS, if the buffer was successfully
8616 * copied.
8617 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8618 * copy is too small to hold contents of the
8619 * input buffer.
8620 */
8621MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008622psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8623 uint8_t *input_copy, size_t input_copy_len)
8624{
8625 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008626 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008627 }
8628
David Horstmann372b8bb2023-11-24 16:21:04 +00008629#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008630 if (psa_input_pre_copy_hook != NULL) {
8631 psa_input_pre_copy_hook(input, input_len);
8632 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008633#endif
8634
David Horstmann777e7412023-11-15 17:33:47 +00008635 if (input_len > 0) {
8636 memcpy(input_copy, input, input_len);
8637 }
David Horstmannfde97392023-10-30 20:29:43 +00008638
David Horstmann372b8bb2023-11-24 16:21:04 +00008639#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008640 if (psa_input_post_copy_hook != NULL) {
8641 psa_input_post_copy_hook(input, input_len);
8642 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008643#endif
8644
David Horstmannfde97392023-10-30 20:29:43 +00008645 return PSA_SUCCESS;
8646}
8647
David Horstmann1b7279a2023-11-15 15:18:30 +00008648/** Copy from a local output buffer into a user-supplied one.
8649 *
8650 * \param[in] output_copy Pointer to a local buffer containing the output.
8651 * \param[in] output_copy_len Length of the local buffer.
8652 * \param[out] output Pointer to user-supplied output buffer.
8653 * \param[out] output_len Length of the user-supplied output buffer.
8654 * \return #PSA_SUCCESS, if the buffer was successfully
8655 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008656 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008657 * user-supplied output buffer is too small to
8658 * hold the contents of the local buffer.
8659 */
8660MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008661psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8662 uint8_t *output, size_t output_len)
8663{
8664 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008665 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008666 }
David Horstmann777e7412023-11-15 17:33:47 +00008667
David Horstmann372b8bb2023-11-24 16:21:04 +00008668#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008669 if (psa_output_pre_copy_hook != NULL) {
8670 psa_output_pre_copy_hook(output, output_len);
8671 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008672#endif
8673
David Horstmann777e7412023-11-15 17:33:47 +00008674 if (output_copy_len > 0) {
8675 memcpy(output, output_copy, output_copy_len);
8676 }
8677
David Horstmann372b8bb2023-11-24 16:21:04 +00008678#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008679 if (psa_output_post_copy_hook != NULL) {
8680 psa_output_post_copy_hook(output, output_len);
8681 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008682#endif
8683
David Horstmann8978f5c2023-10-30 20:37:12 +00008684 return PSA_SUCCESS;
8685}
8686
David Horstmannf1734052023-11-20 17:15:32 +00008687psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8688 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008689{
8690 psa_status_t status;
8691
David Horstmann9db14482023-11-23 15:50:37 +00008692 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008693
David Horstmannc5cc1c32023-11-15 18:11:26 +00008694 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008695 return PSA_SUCCESS;
8696 }
8697
David Horstmannf1734052023-11-20 17:15:32 +00008698 local_input->buffer = mbedtls_calloc(input_len, 1);
8699 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008700 /* Since we dealt with the zero-length case above, we know that
8701 * a NULL return value means a failure of allocation. */
8702 return PSA_ERROR_INSUFFICIENT_MEMORY;
8703 }
David Horstmannf1734052023-11-20 17:15:32 +00008704 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008705
David Horstmannf1734052023-11-20 17:15:32 +00008706 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008707
8708 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008709 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008710 if (status != PSA_SUCCESS) {
8711 goto error;
8712 }
8713
8714 return PSA_SUCCESS;
8715
8716error:
David Horstmannf1734052023-11-20 17:15:32 +00008717 mbedtls_free(local_input->buffer);
8718 local_input->buffer = NULL;
8719 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008720 return status;
8721}
8722
David Horstmannf1734052023-11-20 17:15:32 +00008723void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008724{
David Horstmannf1734052023-11-20 17:15:32 +00008725 mbedtls_free(local_input->buffer);
8726 local_input->buffer = NULL;
8727 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008728}
8729
David Horstmann89875a42023-11-20 12:54:09 +00008730psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8731 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008732{
David Horstmann9db14482023-11-23 15:50:37 +00008733 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008734
David Horstmannc5cc1c32023-11-15 18:11:26 +00008735 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008736 return PSA_SUCCESS;
8737 }
David Horstmann89875a42023-11-20 12:54:09 +00008738 local_output->buffer = mbedtls_calloc(output_len, 1);
8739 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008740 /* Since we dealt with the zero-length case above, we know that
8741 * a NULL return value means a failure of allocation. */
8742 return PSA_ERROR_INSUFFICIENT_MEMORY;
8743 }
David Horstmann89875a42023-11-20 12:54:09 +00008744 local_output->length = output_len;
8745 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008746
8747 return PSA_SUCCESS;
8748}
8749
Gabor Mezei1882c512024-01-24 13:07:17 +01008750psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8751 psa_crypto_local_output_t *local_output)
8752{
8753 psa_status_t status;
8754 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8755
8756 if (output_len == 0) {
8757 return PSA_SUCCESS;
8758 }
8759 local_output->buffer = mbedtls_calloc(output_len, 1);
8760 if (local_output->buffer == NULL) {
8761 /* Since we dealt with the zero-length case above, we know that
8762 * a NULL return value means a failure of allocation. */
8763 return PSA_ERROR_INSUFFICIENT_MEMORY;
8764 }
8765 local_output->length = output_len;
8766 local_output->original = output;
8767
8768 status = psa_crypto_copy_input(output, output_len,
8769 local_output->buffer, local_output->length);
8770 if (status != PSA_SUCCESS) {
8771 goto error;
8772 }
8773
8774 return PSA_SUCCESS;
8775
8776error:
8777 mbedtls_free(local_output->buffer);
8778 local_output->buffer = NULL;
8779 local_output->length = 0;
8780 return status;
8781}
8782
David Horstmann89875a42023-11-20 12:54:09 +00008783psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008784{
David Horstmannc335a4e2023-11-15 15:57:32 +00008785 psa_status_t status;
8786
David Horstmann89875a42023-11-20 12:54:09 +00008787 if (local_output->buffer == NULL) {
8788 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008789 return PSA_SUCCESS;
8790 }
David Horstmann89875a42023-11-20 12:54:09 +00008791 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008792 /* We have an internal copy but nothing to copy back to. */
8793 return PSA_ERROR_CORRUPTION_DETECTED;
8794 }
8795
David Horstmann89875a42023-11-20 12:54:09 +00008796 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8797 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008798 if (status != PSA_SUCCESS) {
8799 return status;
8800 }
David Horstmann9467ea32023-11-08 17:44:18 +00008801
David Horstmann89875a42023-11-20 12:54:09 +00008802 mbedtls_free(local_output->buffer);
8803 local_output->buffer = NULL;
8804 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008805
8806 return PSA_SUCCESS;
8807}
8808
Gilles Peskinee59236f2018-01-27 23:32:46 +01008809#endif /* MBEDTLS_PSA_CRYPTO_C */