blob: 23cd1c4a17157eb8113b854dcd2e27ee73bdcde4 [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,
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 uint8_t *hash,
2400 size_t hash_size,
2401 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002402{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2404
Steven Cooremanfbe09282021-03-08 18:41:12 +01002405 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 if (operation->id == 0) {
2407 return PSA_ERROR_BAD_STATE;
2408 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002409
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002410 status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 operation, hash, hash_size, hash_length);
2412 psa_hash_abort(operation);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002413
2414 return status;
2415}
2416
2417psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2418 uint8_t *hash_external,
2419 size_t hash_size,
2420 size_t *hash_length)
2421{
2422 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2423 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2424
2425 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2426 status = psa_hash_finish_internal(operation, hash, hash_size, hash_length);
2427
2428exit:
2429 LOCAL_OUTPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002431}
2432
Gilles Peskine449bd832023-01-11 14:50:10 +01002433psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002434 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002436{
Ronald Cron69a63422021-10-18 09:47:58 +02002437 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002438 size_t actual_hash_length;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002439 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2440 LOCAL_INPUT_DECLARE(hash_external, hash);
2441
2442 status = psa_hash_finish_internal(
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 operation,
2444 actual_hash, sizeof(actual_hash),
2445 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002448 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002452 status = PSA_ERROR_INVALID_SIGNATURE;
2453 goto exit;
2454 }
2455
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002456 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002457 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002458 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002460
2461exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2463 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002464 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 }
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002466 LOCAL_INPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002468}
2469
Gilles Peskine449bd832023-01-11 14:50:10 +01002470psa_status_t psa_hash_compute(psa_algorithm_t alg,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002471 const uint8_t *input_external, size_t input_length,
2472 uint8_t *hash_external, size_t hash_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002474{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002475 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2476 LOCAL_INPUT_DECLARE(input_external, input);
2477 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2478
Steven Cooremanfbe09282021-03-08 18:41:12 +01002479 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 if (!PSA_ALG_IS_HASH(alg)) {
2481 return PSA_ERROR_INVALID_ARGUMENT;
2482 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002483
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002484 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2485 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2486 status = psa_driver_wrapper_hash_compute(alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 hash, hash_size, hash_length);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002488
2489exit:
2490 LOCAL_INPUT_FREE(input_external, input);
2491 LOCAL_OUTPUT_FREE(hash_external, hash);
2492 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002493}
2494
Gilles Peskine449bd832023-01-11 14:50:10 +01002495psa_status_t psa_hash_compare(psa_algorithm_t alg,
Thomas Daubney51ffac92024-01-18 15:46:26 +00002496 const uint8_t *input_external, size_t input_length,
2497 const uint8_t *hash_external, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002498{
Ronald Cron69a63422021-10-18 09:47:58 +02002499 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002500 size_t actual_hash_length;
Thomas Daubney51ffac92024-01-18 15:46:26 +00002501 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2502
2503 LOCAL_INPUT_DECLARE(input_external, input);
2504 LOCAL_INPUT_DECLARE(hash_external, hash);
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002505
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 if (!PSA_ALG_IS_HASH(alg)) {
Thomas Daubney51ffac92024-01-18 15:46:26 +00002507 status = PSA_ERROR_INVALID_ARGUMENT;
2508 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002510
Thomas Daubney51ffac92024-01-18 15:46:26 +00002511 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2512 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 alg, input, input_length,
2514 actual_hash, sizeof(actual_hash),
2515 &actual_hash_length);
2516 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002517 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 }
2519 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002520 status = PSA_ERROR_INVALID_SIGNATURE;
2521 goto exit;
2522 }
Thomas Daubney51ffac92024-01-18 15:46:26 +00002523
2524 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002525 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002526 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002528
2529exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
Thomas Daubney51ffac92024-01-18 15:46:26 +00002531
2532 LOCAL_INPUT_FREE(input_external, input);
2533 LOCAL_INPUT_FREE(hash_external, hash);
2534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002536}
2537
Gilles Peskine449bd832023-01-11 14:50:10 +01002538psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2539 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002540{
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 if (source_operation->id == 0 ||
2542 target_operation->id != 0) {
2543 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002544 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002545
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2547 target_operation);
2548 if (status != PSA_SUCCESS) {
2549 psa_hash_abort(target_operation);
2550 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002553}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002554
2555
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002556/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002557/* MAC */
2558/****************************************************************/
2559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002561{
Steven Cooremane6804192021-03-19 18:28:56 +01002562 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 if (operation->id == 0) {
2564 return PSA_SUCCESS;
2565 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002568 operation->mac_size = 0;
2569 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002570 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002573}
2574
Ronald Cron2dff3b22021-06-17 16:33:22 +02002575static psa_status_t psa_mac_finalize_alg_and_key_validation(
2576 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002577 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002579{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002580 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 psa_key_type_t key_type = psa_get_key_type(attributes);
2582 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (!PSA_ALG_IS_MAC(alg)) {
2585 return PSA_ERROR_INVALID_ARGUMENT;
2586 }
Steven Cooremane6804192021-03-19 18:28:56 +01002587
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002588 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 status = psa_mac_key_can_do(alg, key_type);
2590 if (status != PSA_SUCCESS) {
2591 return status;
2592 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002593
Steven Cooremand1a68f12021-05-10 11:13:41 +02002594 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002596
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002598 /* A very short MAC is too short for security since it can be
2599 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2600 * so we make this our minimum, even though 32 bits is still
2601 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002603 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2606 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002607 /* It's impossible to "truncate" to a larger length than the full length
2608 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002610 }
2611
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002613 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2614 * that is disabled in the compile-time configuration. The result can
2615 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2616 * configuration into account. In this case, force a return of
2617 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2618 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2619 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2620 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2621 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002623 }
2624
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002626}
2627
Gilles Peskine449bd832023-01-11 14:50:10 +01002628static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2629 mbedtls_svc_key_id_t key,
2630 psa_algorithm_t alg,
2631 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002632{
2633 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2634 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002635 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002636 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002637
2638 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002640 status = PSA_ERROR_BAD_STATE;
2641 goto exit;
2642 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002643
2644 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 key,
2646 &slot,
2647 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2648 alg);
2649 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002650 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002652
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002653 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002654 .core = slot->attr
2655 };
2656
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2658 &operation->mac_size);
2659 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002660 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002662
2663 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002664 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 if (is_sign) {
2666 status = psa_driver_wrapper_mac_sign_setup(operation,
2667 &attributes,
2668 slot->key.data,
2669 slot->key.bytes,
2670 alg);
2671 } else {
2672 status = psa_driver_wrapper_mac_verify_setup(operation,
2673 &attributes,
2674 slot->key.data,
2675 slot->key.bytes,
2676 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002677 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002678
Gilles Peskinefbfac682018-07-08 20:51:54 +02002679exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 if (status != PSA_SUCCESS) {
2681 psa_mac_abort(operation);
2682 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002683
Ryan Everett1b70a072024-01-04 10:32:49 +00002684 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002685
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002687}
2688
Gilles Peskine449bd832023-01-11 14:50:10 +01002689psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2690 mbedtls_svc_key_id_t key,
2691 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002692{
Gilles Peskine449bd832023-01-11 14:50:10 +01002693 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002694}
2695
Gilles Peskine449bd832023-01-11 14:50:10 +01002696psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2697 mbedtls_svc_key_id_t key,
2698 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002699{
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002701}
2702
Gilles Peskine449bd832023-01-11 14:50:10 +01002703psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2704 const uint8_t *input,
2705 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002706{
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 if (operation->id == 0) {
2708 return PSA_ERROR_BAD_STATE;
2709 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002710
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002711 /* Don't require hash implementations to behave correctly on a
2712 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 if (input_length == 0) {
2714 return PSA_SUCCESS;
2715 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002716
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2718 input, input_length);
2719 if (status != PSA_SUCCESS) {
2720 psa_mac_abort(operation);
2721 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002724}
2725
Gilles Peskine449bd832023-01-11 14:50:10 +01002726psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2727 uint8_t *mac,
2728 size_t mac_size,
2729 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002730{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002731 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2732 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002733
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002735 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002736 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002737 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002738
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002740 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002741 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002742 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002743
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002744 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2745 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002747 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002748 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002749 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002750
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002752 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002753 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002754 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002755
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 status = psa_driver_wrapper_mac_sign_finish(operation,
2757 mac, operation->mac_size,
2758 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002759
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002760exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002761 /* In case of success, set the potential excess room in the output buffer
2762 * to an invalid value, to avoid potentially leaking a longer MAC.
2763 * In case of error, set the output length and content to a safe default,
2764 * such that in case the caller misses an error check, the output would be
2765 * an unachievable MAC.
2766 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002768 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002769 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002770 }
mohammad16036df908f2018-04-02 08:34:15 -07002771
Paul Elliottdc42ca82023-02-24 18:11:59 +00002772 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002773
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002775
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002777}
2778
Gilles Peskine449bd832023-01-11 14:50:10 +01002779psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2780 const uint8_t *mac,
2781 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002782{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002783 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2784 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002785
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002787 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002788 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002789 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002792 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002793 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002794 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002795
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002797 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002798 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002799 }
2800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 status = psa_driver_wrapper_mac_verify_finish(operation,
2802 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002803
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002804exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002808}
2809
Gilles Peskine449bd832023-01-11 14:50:10 +01002810static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2811 psa_algorithm_t alg,
2812 const uint8_t *input,
2813 size_t input_length,
2814 uint8_t *mac,
2815 size_t mac_size,
2816 size_t *mac_length,
2817 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002818{
2819 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002820 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2821 psa_key_slot_t *slot;
2822 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002823 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002824
Ronald Cron51131b52021-06-17 17:17:20 +02002825 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 key,
2827 &slot,
2828 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2829 alg);
2830 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002831 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002833
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002834 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002835 .core = slot->attr
2836 };
2837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2839 &operation_mac_size);
2840 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002841 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002843
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002845 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002846 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002847 }
2848
2849 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 &attributes,
2851 slot->key.data, slot->key.bytes,
2852 alg,
2853 input, input_length,
2854 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002855
2856exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002857 /* In case of success, set the potential excess room in the output buffer
2858 * to an invalid value, to avoid potentially leaking a longer MAC.
2859 * In case of error, set the output length and content to a safe default,
2860 * such that in case the caller misses an error check, the output would be
2861 * an unachievable MAC.
2862 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002864 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002865 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002866 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002867
2868 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002869
Ryan Everett1b70a072024-01-04 10:32:49 +00002870 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002873}
2874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002876 psa_algorithm_t alg,
2877 const uint8_t *input,
2878 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 uint8_t *mac,
2880 size_t mac_size,
2881 size_t *mac_length)
2882{
2883 return psa_mac_compute_internal(key, alg,
2884 input, input_length,
2885 mac, mac_size, mac_length, 1);
2886}
2887
2888psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2889 psa_algorithm_t alg,
2890 const uint8_t *input,
2891 size_t input_length,
2892 const uint8_t *mac,
2893 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002894{
2895 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002896 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2897 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 status = psa_mac_compute_internal(key, alg,
2900 input, input_length,
2901 actual_mac, sizeof(actual_mac),
2902 &actual_mac_length, 0);
2903 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002904 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002906
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002908 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002909 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002910 }
Dave Rodgman78701152023-08-29 14:20:18 +01002911 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
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 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002915
2916exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002918
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002920}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002921
Gilles Peskinee59236f2018-01-27 23:32:46 +01002922/****************************************************************/
2923/* Asymmetric cryptography */
2924/****************************************************************/
2925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2927 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002928{
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 if (input_is_message) {
2930 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2931 return PSA_ERROR_INVALID_ARGUMENT;
2932 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002933
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2935 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2936 return PSA_ERROR_INVALID_ARGUMENT;
2937 }
2938 }
2939 } else {
2940 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2941 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002942 }
2943 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002946}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002947
Gilles Peskine449bd832023-01-11 14:50:10 +01002948static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2949 int input_is_message,
2950 psa_algorithm_t alg,
2951 const uint8_t *input,
2952 size_t input_length,
2953 uint8_t *signature,
2954 size_t signature_size,
2955 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002956{
2957 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2958 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2959 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002960 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002961
2962 *signature_length = 0;
2963
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 status = psa_sign_verify_check_alg(input_is_message, alg);
2965 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002966 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002968
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002969 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002970 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002971 * buffer can in principle be empty since it doesn't actually have
2972 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 if (signature_size == 0) {
2974 return PSA_ERROR_BUFFER_TOO_SMALL;
2975 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002976
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002977 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 key, &slot,
2979 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2980 PSA_KEY_USAGE_SIGN_HASH,
2981 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002984 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002986
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002988 status = PSA_ERROR_INVALID_ARGUMENT;
2989 goto exit;
2990 }
2991
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002992 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002994 };
2995
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002997 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002998 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002999 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 signature, signature_size, signature_length);
3001 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003002
3003 status = psa_driver_wrapper_sign_hash(
3004 &attributes, slot->key.data, slot->key.bytes,
3005 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003007 }
3008
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003009
3010exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003011 psa_wipe_tag_output_buffer(signature, status, signature_size,
3012 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003013
Ryan Everett1b70a072024-01-04 10:32:49 +00003014 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003015
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003017}
3018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3020 int input_is_message,
3021 psa_algorithm_t alg,
3022 const uint8_t *input,
3023 size_t input_length,
3024 const uint8_t *signature,
3025 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003026{
3027 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3028 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3029 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 status = psa_sign_verify_check_alg(input_is_message, alg);
3032 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003033 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003035
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003036 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 key, &slot,
3038 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3039 PSA_KEY_USAGE_VERIFY_HASH,
3040 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003041
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 if (status != PSA_SUCCESS) {
3043 return status;
3044 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003045
3046 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003048 };
3049
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003051 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003052 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003053 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 signature, signature_length);
3055 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003056 status = psa_driver_wrapper_verify_hash(
3057 &attributes, slot->key.data, slot->key.bytes,
3058 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003060 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003061
Ryan Everett1b70a072024-01-04 10:32:49 +00003062 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003065
3066}
3067
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003068psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003069 const psa_key_attributes_t *attributes,
3070 const uint8_t *key_buffer,
3071 size_t key_buffer_size,
3072 psa_algorithm_t alg,
3073 const uint8_t *input,
3074 size_t input_length,
3075 uint8_t *signature,
3076 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003078{
3079 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003080
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003082 size_t hash_length;
3083 uint8_t hash[PSA_HASH_MAX_SIZE];
3084
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003085 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 PSA_ALG_SIGN_GET_HASH(alg),
3087 input, input_length,
3088 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003089
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003091 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003093
3094 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 attributes, key_buffer, key_buffer_size,
3096 alg, hash, hash_length,
3097 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003098 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003099
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003101}
3102
Gilles Peskine449bd832023-01-11 14:50:10 +01003103psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3104 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003105 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003107 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 size_t signature_size,
3109 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003110{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003111 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3112 LOCAL_INPUT_DECLARE(input_external, input);
3113 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3114
3115 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3116 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3117 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3118 signature_size, signature_length);
3119
Thomas Daubney3e65f522024-01-30 12:37:25 +00003120#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003121exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003122#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003123 LOCAL_INPUT_FREE(input_external, input);
3124 LOCAL_OUTPUT_FREE(signature_external, signature);
3125 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003126}
3127
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003128psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003129 const psa_key_attributes_t *attributes,
3130 const uint8_t *key_buffer,
3131 size_t key_buffer_size,
3132 psa_algorithm_t alg,
3133 const uint8_t *input,
3134 size_t input_length,
3135 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003137{
3138 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003139
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003141 size_t hash_length;
3142 uint8_t hash[PSA_HASH_MAX_SIZE];
3143
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003144 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 PSA_ALG_SIGN_GET_HASH(alg),
3146 input, input_length,
3147 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003148
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003150 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003152
3153 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 attributes, key_buffer, key_buffer_size,
3155 alg, hash, hash_length,
3156 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003157 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003160}
3161
Gilles Peskine449bd832023-01-11 14:50:10 +01003162psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3163 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003164 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003166 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003168{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003169 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3170 LOCAL_INPUT_DECLARE(input_external, input);
3171 LOCAL_INPUT_DECLARE(signature_external, signature);
3172
3173 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3174 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3175 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3176 signature_length);
3177
Thomas Daubney3e65f522024-01-30 12:37:25 +00003178#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003179exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003180#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003181 LOCAL_INPUT_FREE(input_external, input);
3182 LOCAL_INPUT_FREE(signature_external, signature);
3183
3184 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003185}
3186
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003187psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003188 const psa_key_attributes_t *attributes,
3189 const uint8_t *key_buffer, size_t key_buffer_size,
3190 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003191 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003192{
Gilles Peskine449bd832023-01-11 14:50:10 +01003193 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3194 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3195 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003196#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3198 return mbedtls_psa_rsa_sign_hash(
3199 attributes,
3200 key_buffer, key_buffer_size,
3201 alg, hash, hash_length,
3202 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003203#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3204 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 } else {
3206 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003207 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003208 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3209 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003210#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003211 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3212 return mbedtls_psa_ecdsa_sign_hash(
3213 attributes,
3214 key_buffer, key_buffer_size,
3215 alg, hash, hash_length,
3216 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003217#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3218 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003219 } else {
3220 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003221 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003222 }
Ronald Cron4501c982021-03-19 20:09:32 +01003223
Gilles Peskine449bd832023-01-11 14:50:10 +01003224 (void) key_buffer;
3225 (void) key_buffer_size;
3226 (void) hash;
3227 (void) hash_length;
3228 (void) signature;
3229 (void) signature_size;
3230 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003231
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003233}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003234
Gilles Peskine449bd832023-01-11 14:50:10 +01003235psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3236 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003237 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003239 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 size_t signature_size,
3241 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003242{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003243 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3244 LOCAL_INPUT_DECLARE(hash_external, hash);
3245 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3246
3247 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3248 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3249 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3250 signature_size, signature_length);
3251
Thomas Daubney3e65f522024-01-30 12:37:25 +00003252#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003253exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003254#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003255 LOCAL_INPUT_FREE(hash_external, hash);
3256 LOCAL_OUTPUT_FREE(signature_external, signature);
3257
3258 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003259}
3260
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003261psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003262 const psa_key_attributes_t *attributes,
3263 const uint8_t *key_buffer, size_t key_buffer_size,
3264 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003265 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003266{
Gilles Peskine449bd832023-01-11 14:50:10 +01003267 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3268 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3269 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003270#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003271 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3272 return mbedtls_psa_rsa_verify_hash(
3273 attributes,
3274 key_buffer, key_buffer_size,
3275 alg, hash, hash_length,
3276 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003277#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3278 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003279 } else {
3280 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003281 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3283 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003284#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3286 return mbedtls_psa_ecdsa_verify_hash(
3287 attributes,
3288 key_buffer, key_buffer_size,
3289 alg, hash, hash_length,
3290 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003291#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3292 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 } else {
3294 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003295 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003296 }
Ronald Cron4501c982021-03-19 20:09:32 +01003297
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 (void) key_buffer;
3299 (void) key_buffer_size;
3300 (void) hash;
3301 (void) hash_length;
3302 (void) signature;
3303 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003304
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003306}
3307
Gilles Peskine449bd832023-01-11 14:50:10 +01003308psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3309 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003310 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003311 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003312 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003314{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003315 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3316 LOCAL_INPUT_DECLARE(hash_external, hash);
3317 LOCAL_INPUT_DECLARE(signature_external, signature);
3318
3319 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3320 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3321 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3322 signature_length);
3323
Thomas Daubney3e65f522024-01-30 12:37:25 +00003324#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003325exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003326#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003327 LOCAL_INPUT_FREE(hash_external, hash);
3328 LOCAL_INPUT_FREE(signature_external, signature);
3329
3330 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003331}
3332
Gilles Peskine449bd832023-01-11 14:50:10 +01003333psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3334 psa_algorithm_t alg,
3335 const uint8_t *input,
3336 size_t input_length,
3337 const uint8_t *salt,
3338 size_t salt_length,
3339 uint8_t *output,
3340 size_t output_size,
3341 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003342{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003343 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003344 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003345 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003346 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003347
Darryl Green5cc689a2018-07-24 15:34:10 +01003348 (void) input;
3349 (void) input_length;
3350 (void) salt;
3351 (void) output;
3352 (void) output_size;
3353
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003354 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003355
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3357 return PSA_ERROR_INVALID_ARGUMENT;
3358 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003359
Valerio Setti5bb454a2024-01-15 10:43:16 +01003360 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3362 if (status != PSA_SUCCESS) {
3363 return status;
3364 }
3365 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3366 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003367 status = PSA_ERROR_INVALID_ARGUMENT;
3368 goto exit;
3369 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003370
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003371 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003373 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003374
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003375 status = psa_driver_wrapper_asymmetric_encrypt(
3376 &attributes, slot->key.data, slot->key.bytes,
3377 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003379exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003380 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003381
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003383}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003384
Gilles Peskine449bd832023-01-11 14:50:10 +01003385psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3386 psa_algorithm_t alg,
3387 const uint8_t *input,
3388 size_t input_length,
3389 const uint8_t *salt,
3390 size_t salt_length,
3391 uint8_t *output,
3392 size_t output_size,
3393 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003394{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003395 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003396 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003397 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003398 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003399
Darryl Green5cc689a2018-07-24 15:34:10 +01003400 (void) input;
3401 (void) input_length;
3402 (void) salt;
3403 (void) output;
3404 (void) output_size;
3405
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003406 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003407
Gilles Peskine449bd832023-01-11 14:50:10 +01003408 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3409 return PSA_ERROR_INVALID_ARGUMENT;
3410 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003411
Valerio Setti5bb454a2024-01-15 10:43:16 +01003412 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3414 if (status != PSA_SUCCESS) {
3415 return status;
3416 }
3417 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003418 status = PSA_ERROR_INVALID_ARGUMENT;
3419 goto exit;
3420 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003421
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003422 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003423 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003424 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003425
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003426 status = psa_driver_wrapper_asymmetric_decrypt(
3427 &attributes, slot->key.data, slot->key.bytes,
3428 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003430
3431exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003432 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003433
Gilles Peskine449bd832023-01-11 14:50:10 +01003434 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003435}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003436
Paul Elliott9fe12f62022-11-30 19:16:02 +00003437/****************************************************************/
3438/* Asymmetric interruptible cryptography */
3439/****************************************************************/
3440
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003441static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3442
Paul Elliott9fe12f62022-11-30 19:16:02 +00003443void psa_interruptible_set_max_ops(uint32_t max_ops)
3444{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003445 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003446}
3447
3448uint32_t psa_interruptible_get_max_ops(void)
3449{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003450 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003451}
3452
Paul Elliott9fe12f62022-11-30 19:16:02 +00003453uint32_t psa_sign_hash_get_num_ops(
3454 const psa_sign_hash_interruptible_operation_t *operation)
3455{
Paul Elliott296ede92022-12-15 17:00:30 +00003456 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003457}
3458
3459uint32_t psa_verify_hash_get_num_ops(
3460 const psa_verify_hash_interruptible_operation_t *operation)
3461{
Paul Elliott296ede92022-12-15 17:00:30 +00003462 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003463}
3464
Paul Elliott59ad9452022-12-18 15:09:02 +00003465static psa_status_t psa_sign_hash_abort_internal(
3466 psa_sign_hash_interruptible_operation_t *operation)
3467{
3468 if (operation->id == 0) {
3469 /* The object has (apparently) been initialized but it is not (yet)
3470 * in use. It's ok to call abort on such an object, and there's
3471 * nothing to do. */
3472 return PSA_SUCCESS;
3473 }
3474
3475 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3476
3477 status = psa_driver_wrapper_sign_hash_abort(operation);
3478
3479 operation->id = 0;
3480
Paul Elliotte6145dc2023-02-07 12:51:21 +00003481 /* Do not clear either the error_occurred or num_ops elements here as they
3482 * only want to be cleared by the application calling abort, not by abort
3483 * being called at completion of an operation. */
3484
Paul Elliott59ad9452022-12-18 15:09:02 +00003485 return status;
3486}
3487
Paul Elliott9fe12f62022-11-30 19:16:02 +00003488psa_status_t psa_sign_hash_start(
3489 psa_sign_hash_interruptible_operation_t *operation,
3490 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3491 const uint8_t *hash, size_t hash_length)
3492{
3493 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3494 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3495 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003496 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003497
Paul Elliottc9774412023-02-06 15:14:07 +00003498 /* Check that start has not been previously called, or operation has not
3499 * previously errored. */
3500 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003501 return PSA_ERROR_BAD_STATE;
3502 }
3503
Paul Elliott9fe12f62022-11-30 19:16:02 +00003504 status = psa_sign_verify_check_alg(0, alg);
3505 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003506 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003507 return status;
3508 }
3509
3510 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3511 PSA_KEY_USAGE_SIGN_HASH,
3512 alg);
3513
3514 if (status != PSA_SUCCESS) {
3515 goto exit;
3516 }
3517
3518 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3519 status = PSA_ERROR_INVALID_ARGUMENT;
3520 goto exit;
3521 }
3522
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003523 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003524 .core = slot->attr
3525 };
3526
Paul Elliott296ede92022-12-15 17:00:30 +00003527 /* Ensure ops count gets reset, in case of operation re-use. */
3528 operation->num_ops = 0;
3529
Paul Elliott9fe12f62022-11-30 19:16:02 +00003530 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3531 slot->key.data,
3532 slot->key.bytes, alg,
3533 hash, hash_length);
3534exit:
3535
3536 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003537 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003538 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003539 }
3540
Ryan Everett1b70a072024-01-04 10:32:49 +00003541 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003542
Paul Elliottc9774412023-02-06 15:14:07 +00003543 if (unlock_status != PSA_SUCCESS) {
3544 operation->error_occurred = 1;
3545 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003546
Paul Elliottc9774412023-02-06 15:14:07 +00003547 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003548}
3549
3550
3551psa_status_t psa_sign_hash_complete(
3552 psa_sign_hash_interruptible_operation_t *operation,
3553 uint8_t *signature, size_t signature_size,
3554 size_t *signature_length)
3555{
3556 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3557
3558 *signature_length = 0;
3559
Paul Elliottc9774412023-02-06 15:14:07 +00003560 /* Check that start has been called first, and that operation has not
3561 * previously errored. */
3562 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003563 status = PSA_ERROR_BAD_STATE;
3564 goto exit;
3565 }
3566
Paul Elliott096abc42023-02-03 18:33:23 +00003567 /* Immediately reject a zero-length signature buffer. This guarantees that
3568 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003569 if (signature_size == 0) {
3570 status = PSA_ERROR_BUFFER_TOO_SMALL;
3571 goto exit;
3572 }
3573
3574 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3575 signature_size,
3576 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003577
Paul Elliott296ede92022-12-15 17:00:30 +00003578 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003579 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003580
Paul Elliottebe225c2023-02-10 14:32:53 +00003581exit:
3582
Paul Elliott59200a22023-02-21 15:07:40 +00003583 psa_wipe_tag_output_buffer(signature, status, signature_size,
3584 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003585
Paul Elliott53bb3122023-02-10 14:22:22 +00003586 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003587 if (status != PSA_SUCCESS) {
3588 operation->error_occurred = 1;
3589 }
3590
Paul Elliott59ad9452022-12-18 15:09:02 +00003591 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003592 }
3593
3594 return status;
3595}
3596
3597psa_status_t psa_sign_hash_abort(
3598 psa_sign_hash_interruptible_operation_t *operation)
3599{
Paul Elliott59ad9452022-12-18 15:09:02 +00003600 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3601
3602 status = psa_sign_hash_abort_internal(operation);
3603
3604 /* We clear the number of ops done here, so that it is not cleared when
3605 * the operation fails or succeeds, only on manual abort. */
3606 operation->num_ops = 0;
3607
Paul Elliottc9774412023-02-06 15:14:07 +00003608 /* Likewise, failure state. */
3609 operation->error_occurred = 0;
3610
Paul Elliott59ad9452022-12-18 15:09:02 +00003611 return status;
3612}
3613
3614static psa_status_t psa_verify_hash_abort_internal(
3615 psa_verify_hash_interruptible_operation_t *operation)
3616{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003617 if (operation->id == 0) {
3618 /* The object has (apparently) been initialized but it is not (yet)
3619 * in use. It's ok to call abort on such an object, and there's
3620 * nothing to do. */
3621 return PSA_SUCCESS;
3622 }
3623
Paul Elliott59ad9452022-12-18 15:09:02 +00003624 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3625
3626 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003627
3628 operation->id = 0;
3629
Paul Elliotte6145dc2023-02-07 12:51:21 +00003630 /* Do not clear either the error_occurred or num_ops elements here as they
3631 * only want to be cleared by the application calling abort, not by abort
3632 * being called at completion of an operation. */
3633
Paul Elliott59ad9452022-12-18 15:09:02 +00003634 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003635}
3636
3637psa_status_t psa_verify_hash_start(
3638 psa_verify_hash_interruptible_operation_t *operation,
3639 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3640 const uint8_t *hash, size_t hash_length,
3641 const uint8_t *signature, size_t signature_length)
3642{
3643 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3644 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3645 psa_key_slot_t *slot;
3646
Paul Elliottc9774412023-02-06 15:14:07 +00003647 /* Check that start has not been previously called, or operation has not
3648 * previously errored. */
3649 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003650 return PSA_ERROR_BAD_STATE;
3651 }
3652
3653 status = psa_sign_verify_check_alg(0, alg);
3654 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003655 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003656 return status;
3657 }
3658
3659 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3660 PSA_KEY_USAGE_VERIFY_HASH,
3661 alg);
3662
3663 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003664 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003665 return status;
3666 }
3667
3668 psa_key_attributes_t attributes = {
3669 .core = slot->attr
3670 };
3671
Paul Elliott296ede92022-12-15 17:00:30 +00003672 /* Ensure ops count gets reset, in case of operation re-use. */
3673 operation->num_ops = 0;
3674
Paul Elliott9fe12f62022-11-30 19:16:02 +00003675 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3676 slot->key.data,
3677 slot->key.bytes,
3678 alg, hash, hash_length,
3679 signature, signature_length);
3680
3681 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003682 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003683 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003684 }
3685
Ryan Everett1b70a072024-01-04 10:32:49 +00003686 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003687
Paul Elliottc9774412023-02-06 15:14:07 +00003688 if (unlock_status != PSA_SUCCESS) {
3689 operation->error_occurred = 1;
3690 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003691
Paul Elliottc9774412023-02-06 15:14:07 +00003692 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003693}
3694
3695psa_status_t psa_verify_hash_complete(
3696 psa_verify_hash_interruptible_operation_t *operation)
3697{
3698 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3699
Paul Elliottc9774412023-02-06 15:14:07 +00003700 /* Check that start has been called first, and that operation has not
3701 * previously errored. */
3702 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003703 status = PSA_ERROR_BAD_STATE;
3704 goto exit;
3705 }
3706
3707 status = psa_driver_wrapper_verify_hash_complete(operation);
3708
Paul Elliott296ede92022-12-15 17:00:30 +00003709 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003710 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003711 operation);
3712
Paul Elliottebe225c2023-02-10 14:32:53 +00003713exit:
3714
Paul Elliott9fe12f62022-11-30 19:16:02 +00003715 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003716 if (status != PSA_SUCCESS) {
3717 operation->error_occurred = 1;
3718 }
3719
Paul Elliott59ad9452022-12-18 15:09:02 +00003720 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003721 }
3722
3723 return status;
3724}
3725
3726psa_status_t psa_verify_hash_abort(
3727 psa_verify_hash_interruptible_operation_t *operation)
3728{
Paul Elliott59ad9452022-12-18 15:09:02 +00003729 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003730
Paul Elliott59ad9452022-12-18 15:09:02 +00003731 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003732
Paul Elliott59ad9452022-12-18 15:09:02 +00003733 /* We clear the number of ops done here, so that it is not cleared when
3734 * the operation fails or succeeds, only on manual abort. */
3735 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003736
Paul Elliottc9774412023-02-06 15:14:07 +00003737 /* Likewise, failure state. */
3738 operation->error_occurred = 0;
3739
Paul Elliott59ad9452022-12-18 15:09:02 +00003740 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003741}
3742
Paul Elliott588f8ed2022-12-02 18:10:26 +00003743/****************************************************************/
3744/* Asymmetric interruptible cryptography internal */
3745/* implementations */
3746/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003747
Paul Elliott588f8ed2022-12-02 18:10:26 +00003748void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3749{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003750
Paul Elliott588f8ed2022-12-02 18:10:26 +00003751#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3752 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3753 defined(MBEDTLS_ECP_RESTARTABLE)
3754
3755 /* Internal implementation uses zero to indicate infinite number max ops,
3756 * therefore avoid this value, and set to minimum possible. */
3757 if (max_ops == 0) {
3758 max_ops = 1;
3759 }
3760
Paul Elliott588f8ed2022-12-02 18:10:26 +00003761 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003762#else
3763 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003764#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3765 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3766 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3767}
3768
Paul Elliott588f8ed2022-12-02 18:10:26 +00003769uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003770 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003771{
3772#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3773 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3774 defined(MBEDTLS_ECP_RESTARTABLE)
3775
Paul Elliott93d9ca82023-02-15 18:14:21 +00003776 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003777#else
3778 (void) operation;
3779 return 0;
3780#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3781 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3782 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3783}
3784
3785uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003786 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003787{
3788 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3789 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3790 defined(MBEDTLS_ECP_RESTARTABLE)
3791
Paul Elliott93d9ca82023-02-15 18:14:21 +00003792 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003793#else
3794 (void) operation;
3795 return 0;
3796#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3797 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3798 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3799}
3800
3801psa_status_t mbedtls_psa_sign_hash_start(
3802 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3803 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3804 size_t key_buffer_size, psa_algorithm_t alg,
3805 const uint8_t *hash, size_t hash_length)
3806{
3807 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003808 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003809
Paul Elliott068fe072023-01-16 13:59:15 +00003810 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3811 return PSA_ERROR_NOT_SUPPORTED;
3812 }
3813
3814 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003815 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003816 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003817
3818#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003819 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3820 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003821
Paul Elliotta1c94092023-02-15 16:38:04 +00003822 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3823
Paul Elliott93d9ca82023-02-15 18:14:21 +00003824 /* Ensure num_ops is zero'ed in case of context re-use. */
3825 operation->num_ops = 0;
3826
Paul Elliott068fe072023-01-16 13:59:15 +00003827 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3828 attributes->core.bits,
3829 key_buffer,
3830 key_buffer_size,
3831 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003832
Paul Elliott068fe072023-01-16 13:59:15 +00003833 if (status != PSA_SUCCESS) {
3834 return status;
3835 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003836
Paul Elliott1bc59df2023-02-05 13:41:57 +00003837 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003838 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003839
Paul Elliott068fe072023-01-16 13:59:15 +00003840 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003841 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003842 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003843
Paul Elliott0290a762023-02-09 14:30:24 +00003844 /* We only need to store the same length of hash as the private key size
3845 * here, it would be truncated by the internal implementation anyway. */
3846 required_hash_length = (hash_length < operation->coordinate_bytes ?
3847 hash_length : operation->coordinate_bytes);
3848
Paul Elliottba70ad42023-02-15 18:23:53 +00003849 if (required_hash_length > sizeof(operation->hash)) {
3850 /* Shouldn't happen, but better safe than sorry. */
3851 return PSA_ERROR_CORRUPTION_DETECTED;
3852 }
3853
Paul Elliott0290a762023-02-09 14:30:24 +00003854 memcpy(operation->hash, hash, required_hash_length);
3855 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003856
3857 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003858
3859#else
Paul Elliott068fe072023-01-16 13:59:15 +00003860 (void) operation;
3861 (void) key_buffer;
3862 (void) key_buffer_size;
3863 (void) alg;
3864 (void) hash;
3865 (void) hash_length;
3866 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003867 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003868
Paul Elliott068fe072023-01-16 13:59:15 +00003869 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003870#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3871 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3872 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003873}
3874
3875psa_status_t mbedtls_psa_sign_hash_complete(
3876 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3877 uint8_t *signature, size_t signature_size,
3878 size_t *signature_length)
3879{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003880#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3881 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3882 defined(MBEDTLS_ECP_RESTARTABLE)
3883
Paul Elliotta1c94092023-02-15 16:38:04 +00003884 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003885 mbedtls_mpi r;
3886 mbedtls_mpi s;
3887
Paul Elliott46845252023-02-03 14:59:11 +00003888 mbedtls_mpi_init(&r);
3889 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003890
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003891 /* Ensure max_ops is set to the current value (or default). */
3892 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3893
Paul Elliotta1c94092023-02-15 16:38:04 +00003894 if (signature_size < 2 * operation->coordinate_bytes) {
3895 status = PSA_ERROR_BUFFER_TOO_SMALL;
3896 goto exit;
3897 }
3898
Paul Elliott588f8ed2022-12-02 18:10:26 +00003899 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003900
Paul Elliott588f8ed2022-12-02 18:10:26 +00003901#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3902 status = mbedtls_to_psa_error(
3903 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003904 &r,
3905 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003906 &operation->ctx->d,
3907 operation->hash,
3908 operation->hash_length,
3909 operation->md_alg,
3910 mbedtls_psa_get_random,
3911 MBEDTLS_PSA_RANDOM_STATE,
3912 &operation->restart_ctx));
3913#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003914 status = PSA_ERROR_NOT_SUPPORTED;
3915 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003916#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3917 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003918 status = mbedtls_to_psa_error(
3919 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003920 &r,
3921 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003922 &operation->ctx->d,
3923 operation->hash,
3924 operation->hash_length,
3925 mbedtls_psa_get_random,
3926 MBEDTLS_PSA_RANDOM_STATE,
3927 mbedtls_psa_get_random,
3928 MBEDTLS_PSA_RANDOM_STATE,
3929 &operation->restart_ctx));
3930 }
3931
Paul Elliottf8e5b562023-02-19 18:43:45 +00003932 /* Hide the fact that the restart context only holds a delta of number of
3933 * ops done during the last operation, not an absolute value. */
3934 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3935
Paul Elliott724bd252023-02-08 12:35:08 +00003936 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003937 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003938 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003939 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003940 operation->coordinate_bytes)
3941 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003942
3943 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003944 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003945 }
3946
3947 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003948 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003949 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003950 operation->coordinate_bytes,
3951 operation->coordinate_bytes)
3952 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003953
3954 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003955 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003956 }
3957
Paul Elliott1bc59df2023-02-05 13:41:57 +00003958 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003959
Paul Elliott724bd252023-02-08 12:35:08 +00003960 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003961 }
Paul Elliott724bd252023-02-08 12:35:08 +00003962
3963exit:
3964
3965 mbedtls_mpi_free(&r);
3966 mbedtls_mpi_free(&s);
3967 return status;
3968
Paul Elliott588f8ed2022-12-02 18:10:26 +00003969 #else
3970
3971 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003972 (void) signature;
3973 (void) signature_size;
3974 (void) signature_length;
3975
3976 return PSA_ERROR_NOT_SUPPORTED;
3977
3978#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3979 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3980 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3981}
3982
3983psa_status_t mbedtls_psa_sign_hash_abort(
3984 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3985{
3986
3987#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3988 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3989 defined(MBEDTLS_ECP_RESTARTABLE)
3990
3991 if (operation->ctx) {
3992 mbedtls_ecdsa_free(operation->ctx);
3993 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003994 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003995 }
3996
3997 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3998
Paul Elliott93d9ca82023-02-15 18:14:21 +00003999 operation->num_ops = 0;
4000
Paul Elliott588f8ed2022-12-02 18:10:26 +00004001 return PSA_SUCCESS;
4002
4003#else
4004
4005 (void) operation;
4006
4007 return PSA_ERROR_NOT_SUPPORTED;
4008
4009#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4010 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4011 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4012}
4013
4014psa_status_t mbedtls_psa_verify_hash_start(
4015 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4016 const psa_key_attributes_t *attributes,
4017 const uint8_t *key_buffer, size_t key_buffer_size,
4018 psa_algorithm_t alg,
4019 const uint8_t *hash, size_t hash_length,
4020 const uint8_t *signature, size_t signature_length)
4021{
4022 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004023 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004024 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004025
Paul Elliott068fe072023-01-16 13:59:15 +00004026 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4027 return PSA_ERROR_NOT_SUPPORTED;
4028 }
4029
4030 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004031 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004032 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004033
4034#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004035 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4036 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004037
Paul Elliotta1c94092023-02-15 16:38:04 +00004038 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4039 mbedtls_mpi_init(&operation->r);
4040 mbedtls_mpi_init(&operation->s);
4041
Paul Elliott93d9ca82023-02-15 18:14:21 +00004042 /* Ensure num_ops is zero'ed in case of context re-use. */
4043 operation->num_ops = 0;
4044
Paul Elliott068fe072023-01-16 13:59:15 +00004045 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4046 attributes->core.bits,
4047 key_buffer,
4048 key_buffer_size,
4049 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004050
Paul Elliott068fe072023-01-16 13:59:15 +00004051 if (status != PSA_SUCCESS) {
4052 return status;
4053 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004054
Paul Elliottc569fc22023-02-10 13:02:54 +00004055 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004056
Paul Elliott1bc59df2023-02-05 13:41:57 +00004057 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004058 return PSA_ERROR_INVALID_SIGNATURE;
4059 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004060
Paul Elliott068fe072023-01-16 13:59:15 +00004061 status = mbedtls_to_psa_error(
4062 mbedtls_mpi_read_binary(&operation->r,
4063 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004064 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004065
Paul Elliott068fe072023-01-16 13:59:15 +00004066 if (status != PSA_SUCCESS) {
4067 return status;
4068 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004069
Paul Elliott068fe072023-01-16 13:59:15 +00004070 status = mbedtls_to_psa_error(
4071 mbedtls_mpi_read_binary(&operation->s,
4072 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004073 coordinate_bytes,
4074 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004075
Paul Elliott068fe072023-01-16 13:59:15 +00004076 if (status != PSA_SUCCESS) {
4077 return status;
4078 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004079
Paul Elliott2c9843f2023-02-15 17:32:42 +00004080 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004081
Paul Elliott2c9843f2023-02-15 17:32:42 +00004082 if (status != PSA_SUCCESS) {
4083 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004084 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004085
Paul Elliott0290a762023-02-09 14:30:24 +00004086 /* We only need to store the same length of hash as the private key size
4087 * here, it would be truncated by the internal implementation anyway. */
4088 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4089 coordinate_bytes);
4090
Paul Elliottba70ad42023-02-15 18:23:53 +00004091 if (required_hash_length > sizeof(operation->hash)) {
4092 /* Shouldn't happen, but better safe than sorry. */
4093 return PSA_ERROR_CORRUPTION_DETECTED;
4094 }
4095
Paul Elliott0290a762023-02-09 14:30:24 +00004096 memcpy(operation->hash, hash, required_hash_length);
4097 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004098
4099 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004100#else
Paul Elliott068fe072023-01-16 13:59:15 +00004101 (void) operation;
4102 (void) key_buffer;
4103 (void) key_buffer_size;
4104 (void) alg;
4105 (void) hash;
4106 (void) hash_length;
4107 (void) signature;
4108 (void) signature_length;
4109 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004110 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004111 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004112
Paul Elliott068fe072023-01-16 13:59:15 +00004113 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004114#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4115 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4116 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004117}
4118
4119psa_status_t mbedtls_psa_verify_hash_complete(
4120 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4121{
4122
4123#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4124 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4125 defined(MBEDTLS_ECP_RESTARTABLE)
4126
Paul Elliottf8e5b562023-02-19 18:43:45 +00004127 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4128
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004129 /* Ensure max_ops is set to the current value (or default). */
4130 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4131
Paul Elliottf8e5b562023-02-19 18:43:45 +00004132 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004133 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4134 operation->hash,
4135 operation->hash_length,
4136 &operation->ctx->Q,
4137 &operation->r,
4138 &operation->s,
4139 &operation->restart_ctx));
4140
Paul Elliottf8e5b562023-02-19 18:43:45 +00004141 /* Hide the fact that the restart context only holds a delta of number of
4142 * ops done during the last operation, not an absolute value. */
4143 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4144
4145 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004146#else
4147 (void) operation;
4148
4149 return PSA_ERROR_NOT_SUPPORTED;
4150
4151#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4152 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4153 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4154}
4155
4156psa_status_t mbedtls_psa_verify_hash_abort(
4157 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4158{
4159
4160#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4161 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4162 defined(MBEDTLS_ECP_RESTARTABLE)
4163
4164 if (operation->ctx) {
4165 mbedtls_ecdsa_free(operation->ctx);
4166 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004167 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004168 }
4169
4170 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4171
Paul Elliott93d9ca82023-02-15 18:14:21 +00004172 operation->num_ops = 0;
4173
Paul Elliott588f8ed2022-12-02 18:10:26 +00004174 mbedtls_mpi_free(&operation->r);
4175 mbedtls_mpi_free(&operation->s);
4176
4177 return PSA_SUCCESS;
4178
4179#else
4180 (void) operation;
4181
4182 return PSA_ERROR_NOT_SUPPORTED;
4183
4184#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4185 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4186 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4187}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004188
mohammad1603503973b2018-03-12 15:59:30 +02004189/****************************************************************/
4190/* Symmetric cryptography */
4191/****************************************************************/
4192
Gilles Peskine449bd832023-01-11 14:50:10 +01004193static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4194 mbedtls_svc_key_id_t key,
4195 psa_algorithm_t alg,
4196 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004197{
4198 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4199 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004200 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4202 PSA_KEY_USAGE_ENCRYPT :
4203 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004204 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004205
4206 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004208 status = PSA_ERROR_BAD_STATE;
4209 goto exit;
4210 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004211
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004213 status = PSA_ERROR_INVALID_ARGUMENT;
4214 goto exit;
4215 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004216
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4218 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004219 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004221
Ronald Cron49fafa92021-03-10 08:34:23 +01004222 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004223 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004224 * so we only set it (in the driver wrapper) after resources have been
4225 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004226 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004228 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004230 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 }
4232 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004233
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004234 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004235 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004236 };
4237
Ronald Cronab99ac22020-10-01 16:38:28 +02004238 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 if (cipher_operation == MBEDTLS_ENCRYPT) {
4240 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4241 &attributes,
4242 slot->key.data,
4243 slot->key.bytes,
4244 alg);
4245 } else {
4246 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4247 &attributes,
4248 slot->key.data,
4249 slot->key.bytes,
4250 alg);
4251 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004252
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004253exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 if (status != PSA_SUCCESS) {
4255 psa_cipher_abort(operation);
4256 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004257
Ryan Everett1b70a072024-01-04 10:32:49 +00004258 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004259
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004261}
4262
Gilles Peskine449bd832023-01-11 14:50:10 +01004263psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4264 mbedtls_svc_key_id_t key,
4265 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004266{
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004268}
4269
Gilles Peskine449bd832023-01-11 14:50:10 +01004270psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4271 mbedtls_svc_key_id_t key,
4272 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004273{
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004275}
4276
Gilles Peskine449bd832023-01-11 14:50:10 +01004277psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4278 uint8_t *iv,
4279 size_t iv_size,
4280 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004281{
Ronald Cron6d051732020-10-01 14:10:20 +02004282 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004283 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004284 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004285
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004287 status = PSA_ERROR_BAD_STATE;
4288 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004289 }
4290
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004292 status = PSA_ERROR_BAD_STATE;
4293 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004294 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004295
Ronald Cron2fb90522021-07-05 12:31:44 +02004296 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004298 status = PSA_ERROR_BUFFER_TOO_SMALL;
4299 goto exit;
4300 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004301
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004303 status = PSA_ERROR_GENERIC_ERROR;
4304 goto exit;
4305 }
4306
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 status = psa_generate_random(local_iv, default_iv_length);
4308 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004309 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 }
Ronald Cron5618a392021-03-26 09:52:26 +01004311
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 status = psa_driver_wrapper_cipher_set_iv(operation,
4313 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004314
4315exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 if (status == PSA_SUCCESS) {
4317 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004318 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004319 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004321 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004323 }
Ronald Cron6d051732020-10-01 14:10:20 +02004324
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004326}
4327
Gilles Peskine449bd832023-01-11 14:50:10 +01004328psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4329 const uint8_t *iv,
4330 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004331{
Ronald Cron6d051732020-10-01 14:10:20 +02004332 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004333
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004335 status = PSA_ERROR_BAD_STATE;
4336 goto exit;
4337 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004338
Gilles Peskine449bd832023-01-11 14:50:10 +01004339 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004340 status = PSA_ERROR_BAD_STATE;
4341 goto exit;
4342 }
Ronald Crona0d68172021-03-26 10:15:08 +01004343
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004345 status = PSA_ERROR_INVALID_ARGUMENT;
4346 goto exit;
4347 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004348
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 status = psa_driver_wrapper_cipher_set_iv(operation,
4350 iv,
4351 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004352
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004353exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004355 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 } else {
4357 psa_cipher_abort(operation);
4358 }
4359 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004360}
4361
Gilles Peskine449bd832023-01-11 14:50:10 +01004362psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4363 const uint8_t *input,
4364 size_t input_length,
4365 uint8_t *output,
4366 size_t output_size,
4367 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004368{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004369 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004370
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004372 status = PSA_ERROR_BAD_STATE;
4373 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004374 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004375
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004377 status = PSA_ERROR_BAD_STATE;
4378 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004379 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004380
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 status = psa_driver_wrapper_cipher_update(operation,
4382 input,
4383 input_length,
4384 output,
4385 output_size,
4386 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004387
4388exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if (status != PSA_SUCCESS) {
4390 psa_cipher_abort(operation);
4391 }
Ronald Cron6d051732020-10-01 14:10:20 +02004392
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004394}
4395
Gilles Peskine449bd832023-01-11 14:50:10 +01004396psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4397 uint8_t *output,
4398 size_t output_size,
4399 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004400{
David Saadab4ecc272019-02-14 13:48:10 +02004401 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004402
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004404 status = PSA_ERROR_BAD_STATE;
4405 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004406 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004407
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004409 status = PSA_ERROR_BAD_STATE;
4410 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004411 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 status = psa_driver_wrapper_cipher_finish(operation,
4414 output,
4415 output_size,
4416 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004417
4418exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 if (status == PSA_SUCCESS) {
4420 return psa_cipher_abort(operation);
4421 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004422 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004424
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004426 }
mohammad1603503973b2018-03-12 15:59:30 +02004427}
4428
Gilles Peskine449bd832023-01-11 14:50:10 +01004429psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004430{
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004432 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004433 * in use. It's ok to call abort on such an object, and there's
4434 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004436 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004437
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004439
Ronald Cron49fafa92021-03-10 08:34:23 +01004440 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004441 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004442 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004443
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004445}
4446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4448 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004449 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004451 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 size_t output_size,
4453 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004454{
4455 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004456 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004457 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004458 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4459 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004460 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004461
David Horstmann62a56d92023-12-14 18:12:47 +00004462 LOCAL_INPUT_DECLARE(input_external, input);
4463 LOCAL_OUTPUT_DECLARE(output_external, output);
4464
David Horstmann36df4b22023-12-13 15:55:25 +00004465 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004466 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004467
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004469 status = PSA_ERROR_INVALID_ARGUMENT;
4470 goto exit;
4471 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004472
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4474 PSA_KEY_USAGE_ENCRYPT,
4475 alg);
4476 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004477 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004479
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004480 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004482 };
4483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4485 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004486 status = PSA_ERROR_GENERIC_ERROR;
4487 goto exit;
4488 }
4489
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 if (default_iv_length > 0) {
4491 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004492 status = PSA_ERROR_BUFFER_TOO_SMALL;
4493 goto exit;
4494 }
4495
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 status = psa_generate_random(local_iv, default_iv_length);
4497 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004498 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004500 }
4501
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004502 status = psa_driver_wrapper_cipher_encrypt(
4503 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004504 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004505 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004507
4508exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004509 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004511 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004512 }
Ronald Cron23919522021-07-08 19:00:07 +02004513
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 if (status == PSA_SUCCESS) {
4515 if (default_iv_length > 0) {
4516 memcpy(output, local_iv, default_iv_length);
4517 }
4518 *output_length += default_iv_length;
4519 } else {
4520 *output_length = 0;
4521 }
4522
David Horstmann62a56d92023-12-14 18:12:47 +00004523 LOCAL_INPUT_FREE(input_external, input);
4524 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004525
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004527}
4528
Gilles Peskine449bd832023-01-11 14:50:10 +01004529psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4530 psa_algorithm_t alg,
4531 const uint8_t *input,
4532 size_t input_length,
4533 uint8_t *output,
4534 size_t output_size,
4535 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004536{
4537 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004538 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004539 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004540 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004541
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004543 status = PSA_ERROR_INVALID_ARGUMENT;
4544 goto exit;
4545 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4548 PSA_KEY_USAGE_DECRYPT,
4549 alg);
4550 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004551 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004553
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004554 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004556 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004557
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4559 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004560 status = PSA_ERROR_INVALID_ARGUMENT;
4561 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004563 status = PSA_ERROR_INVALID_ARGUMENT;
4564 goto exit;
4565 }
4566
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004567 status = psa_driver_wrapper_cipher_decrypt(
4568 &attributes, slot->key.data, slot->key.bytes,
4569 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004571
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004572exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004573 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004575 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004577
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004579 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 }
Ronald Cron23919522021-07-08 19:00:07 +02004581
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004583}
4584
4585
mohammad16035955c982018-04-26 00:53:03 +03004586/****************************************************************/
4587/* AEAD */
4588/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004589
Paul Elliottbaff51c2021-09-28 17:44:45 +01004590/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004591static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004592{
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004594}
4595
4596/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004597static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4598 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004599{
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004601
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004603#if defined(PSA_WANT_ALG_GCM)
4604 case PSA_ALG_GCM:
4605 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 * arbitrarily large nonces. Please note that we do not generally
4607 * recommend the usage of nonces of greater length than
4608 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4609 * size, which can then lead to collisions if you encrypt a very
4610 * large number of messages.*/
4611 if (nonce_length != 0) {
4612 return PSA_SUCCESS;
4613 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004614 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004615#endif /* PSA_WANT_ALG_GCM */
4616#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004617 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 if (nonce_length >= 7 && nonce_length <= 13) {
4619 return PSA_SUCCESS;
4620 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004621 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004622#endif /* PSA_WANT_ALG_CCM */
4623#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004624 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 if (nonce_length == 12) {
4626 return PSA_SUCCESS;
4627 } else if (nonce_length == 8) {
4628 return PSA_ERROR_NOT_SUPPORTED;
4629 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004630 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004631#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004632 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004633 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004635 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004638}
4639
Gilles Peskine449bd832023-01-11 14:50:10 +01004640static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004641{
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4643 return PSA_ERROR_INVALID_ARGUMENT;
4644 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004645
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004647}
4648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4650 psa_algorithm_t alg,
4651 const uint8_t *nonce,
4652 size_t nonce_length,
4653 const uint8_t *additional_data,
4654 size_t additional_data_length,
4655 const uint8_t *plaintext,
4656 size_t plaintext_length,
4657 uint8_t *ciphertext,
4658 size_t ciphertext_size,
4659 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004660{
Ronald Cron215633c2021-03-16 17:15:37 +01004661 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4662 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004663
mohammad1603f08a5502018-06-03 15:05:47 +03004664 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004665
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 status = psa_aead_check_algorithm(alg);
4667 if (status != PSA_SUCCESS) {
4668 return status;
4669 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004670
Ronald Cron9a986162021-03-26 12:40:07 +01004671 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4673 if (status != PSA_SUCCESS) {
4674 return status;
4675 }
mohammad16035955c982018-04-26 00:53:03 +03004676
Ronald Cron215633c2021-03-16 17:15:37 +01004677 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004679 };
mohammad16035955c982018-04-26 00:53:03 +03004680
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 status = psa_aead_check_nonce_length(alg, nonce_length);
4682 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004683 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004685
Ronald Cronde822812021-03-17 16:08:20 +01004686 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004687 &attributes, slot->key.data, slot->key.bytes,
4688 alg,
4689 nonce, nonce_length,
4690 additional_data, additional_data_length,
4691 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004693
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4695 memset(ciphertext, 0, ciphertext_size);
4696 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004697
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004698exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004699 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004700
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004702}
4703
Gilles Peskine449bd832023-01-11 14:50:10 +01004704psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4705 psa_algorithm_t alg,
4706 const uint8_t *nonce,
4707 size_t nonce_length,
4708 const uint8_t *additional_data,
4709 size_t additional_data_length,
4710 const uint8_t *ciphertext,
4711 size_t ciphertext_length,
4712 uint8_t *plaintext,
4713 size_t plaintext_size,
4714 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004715{
Ronald Cron215633c2021-03-16 17:15:37 +01004716 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4717 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004718
Gilles Peskineee652a32018-06-01 19:23:52 +02004719 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004720
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 status = psa_aead_check_algorithm(alg);
4722 if (status != PSA_SUCCESS) {
4723 return status;
4724 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004725
Ronald Cron9a986162021-03-26 12:40:07 +01004726 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4728 if (status != PSA_SUCCESS) {
4729 return status;
4730 }
mohammad16035955c982018-04-26 00:53:03 +03004731
Ronald Cron215633c2021-03-16 17:15:37 +01004732 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004734 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004735
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 status = psa_aead_check_nonce_length(alg, nonce_length);
4737 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004738 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004740
Ronald Cronde822812021-03-17 16:08:20 +01004741 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004742 &attributes, slot->key.data, slot->key.bytes,
4743 alg,
4744 nonce, nonce_length,
4745 additional_data, additional_data_length,
4746 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004748
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 if (status != PSA_SUCCESS && plaintext_size != 0) {
4750 memset(plaintext, 0, plaintext_size);
4751 }
mohammad160360a64d02018-06-03 17:20:42 +03004752
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004753exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004754 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004755
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 return status;
mohammad16035955c982018-04-26 00:53:03 +03004757}
4758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4760{
4761 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004762
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004764#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004766 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4768 return PSA_ERROR_INVALID_ARGUMENT;
4769 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004770 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004771#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004772
Przemek Stekiel86679c72022-10-06 17:06:56 +02004773#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004775 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4777 return PSA_ERROR_INVALID_ARGUMENT;
4778 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004779 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004780#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004781
Przemek Stekiel86679c72022-10-06 17:06:56 +02004782#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004784 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 if (tag_len != 16) {
4786 return PSA_ERROR_INVALID_ARGUMENT;
4787 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004788 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004789#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004790
4791 default:
4792 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004794 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004796}
4797
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004798/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004799static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4800 int is_encrypt,
4801 mbedtls_svc_key_id_t key,
4802 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004803{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004804 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4805 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4806 psa_key_slot_t *slot = NULL;
4807 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004808 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004809
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 status = psa_aead_check_algorithm(alg);
4811 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004812 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004814
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004816 status = PSA_ERROR_BAD_STATE;
4817 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004818 }
4819
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 if (operation->nonce_set || operation->lengths_set ||
4821 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004822 status = PSA_ERROR_BAD_STATE;
4823 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004824 }
4825
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004827 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004829 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004831
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4833 alg);
4834 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004835 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004837
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004838 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004839 .core = slot->attr
4840 };
4841
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004843 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004845
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 if (is_encrypt) {
4847 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4848 &attributes,
4849 slot->key.data,
4850 slot->key.bytes,
4851 alg);
4852 } else {
4853 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4854 &attributes,
4855 slot->key.data,
4856 slot->key.bytes,
4857 alg);
4858 }
4859 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004860 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004862
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004864
4865exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004866 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004867
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004869 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004871 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 } else {
4873 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004874 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004877}
4878
Paul Elliott302ff6b2021-04-20 18:10:30 +01004879/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004880psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4881 mbedtls_svc_key_id_t key,
4882 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004883{
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004885}
4886
4887/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004888psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4889 mbedtls_svc_key_id_t key,
4890 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004891{
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004893}
4894
4895/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004896psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4897 uint8_t *nonce,
4898 size_t nonce_size,
4899 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004900{
4901 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004902 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004903 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004904
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004905 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004908 status = PSA_ERROR_BAD_STATE;
4909 goto exit;
4910 }
4911
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004913 status = PSA_ERROR_BAD_STATE;
4914 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004915 }
4916
Paul Elliotte193ea82021-10-01 13:00:16 +01004917 /* For CCM, this size may not be correct according to the PSA
4918 * specification. The PSA Crypto 1.0.1 specification states:
4919 *
4920 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4921 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4922 *
4923 * However this restriction that L has to be the smallest integer is not
4924 * applied in practice, and it is not implementable here since the
4925 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4927 operation->alg);
4928 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004929 status = PSA_ERROR_BUFFER_TOO_SMALL;
4930 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004931 }
4932
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 status = psa_generate_random(local_nonce, required_nonce_size);
4934 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004935 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004937
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004939
Paul Elliott39dc6b82021-05-11 19:16:09 +01004940exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 if (status == PSA_SUCCESS) {
4942 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004943 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 } else {
4945 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004946 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004947
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004949}
4950
4951/* Set the nonce for a multipart authenticated encryption or decryption
4952 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004953psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4954 const uint8_t *nonce,
4955 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004956{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004957 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4958
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004960 status = PSA_ERROR_BAD_STATE;
4961 goto exit;
4962 }
4963
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004965 status = PSA_ERROR_BAD_STATE;
4966 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004967 }
4968
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4970 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004971 status = PSA_ERROR_INVALID_ARGUMENT;
4972 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004973 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004974
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4976 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004977
Paul Elliott39dc6b82021-05-11 19:16:09 +01004978exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004980 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 } else {
4982 psa_aead_abort(operation);
4983 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004984
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004986}
4987
4988/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004989psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4990 size_t ad_length,
4991 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004992{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004993 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4994
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004996 status = PSA_ERROR_BAD_STATE;
4997 goto exit;
4998 }
4999
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 if (operation->lengths_set || operation->ad_started ||
5001 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005002 status = PSA_ERROR_BAD_STATE;
5003 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005004 }
5005
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005007#if defined(PSA_WANT_ALG_GCM)
5008 case PSA_ALG_GCM:
5009 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 * bits. Without the guard this code will generate warnings on 32bit
5011 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005012#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 if (((uint64_t) ad_length) >> 61 != 0 ||
5014 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005015 status = PSA_ERROR_INVALID_ARGUMENT;
5016 goto exit;
5017 }
Paul Elliott325d3742021-09-27 17:56:28 +01005018#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005019 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005020#endif /* PSA_WANT_ALG_GCM */
5021#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005022 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005024 status = PSA_ERROR_INVALID_ARGUMENT;
5025 goto exit;
5026 }
5027 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005028#endif /* PSA_WANT_ALG_CCM */
5029#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005030 case PSA_ALG_CHACHA20_POLY1305:
5031 /* No length restrictions for ChaChaPoly. */
5032 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005033#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005034 default:
5035 break;
5036 }
Paul Elliott325d3742021-09-27 17:56:28 +01005037
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5039 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005040
Paul Elliott39dc6b82021-05-11 19:16:09 +01005041exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005043 operation->ad_remaining = ad_length;
5044 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005045 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 } else {
5047 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005048 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005049
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005051}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005052
5053/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005054psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5055 const uint8_t *input,
5056 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005057{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005058 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5059
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005061 status = PSA_ERROR_BAD_STATE;
5062 goto exit;
5063 }
5064
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005066 status = PSA_ERROR_BAD_STATE;
5067 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005068 }
5069
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if (operation->lengths_set) {
5071 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005072 status = PSA_ERROR_INVALID_ARGUMENT;
5073 goto exit;
5074 }
5075
5076 operation->ad_remaining -= input_length;
5077 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005078#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005080 status = PSA_ERROR_BAD_STATE;
5081 goto exit;
5082 }
5083#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005084
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 status = psa_driver_wrapper_aead_update_ad(operation, input,
5086 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005087
Paul Elliott39dc6b82021-05-11 19:16:09 +01005088exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005090 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 } else {
5092 psa_aead_abort(operation);
5093 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005094
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005096}
5097
5098/* Encrypt or decrypt a message fragment in an active multipart AEAD
5099 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005100psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5101 const uint8_t *input,
5102 size_t input_length,
5103 uint8_t *output,
5104 size_t output_size,
5105 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005106{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005107 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005108
5109 *output_length = 0;
5110
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005112 status = PSA_ERROR_BAD_STATE;
5113 goto exit;
5114 }
5115
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005117 status = PSA_ERROR_BAD_STATE;
5118 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005119 }
5120
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005122 /* Additional data length was supplied, but not all the additional
5123 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005125 status = PSA_ERROR_INVALID_ARGUMENT;
5126 goto exit;
5127 }
5128
5129 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005131 status = PSA_ERROR_INVALID_ARGUMENT;
5132 goto exit;
5133 }
5134
5135 operation->body_remaining -= input_length;
5136 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005137#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005139 status = PSA_ERROR_BAD_STATE;
5140 goto exit;
5141 }
5142#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005143
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5145 output, output_size,
5146 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005147
Paul Elliott39dc6b82021-05-11 19:16:09 +01005148exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005150 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 } else {
5152 psa_aead_abort(operation);
5153 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005154
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005156}
5157
Gilles Peskine449bd832023-01-11 14:50:10 +01005158static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005159{
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 if (operation->id == 0 || !operation->nonce_set) {
5161 return PSA_ERROR_BAD_STATE;
5162 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005163
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5165 operation->body_remaining != 0)) {
5166 return PSA_ERROR_INVALID_ARGUMENT;
5167 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005168
Gilles Peskine449bd832023-01-11 14:50:10 +01005169 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005170}
5171
Paul Elliott302ff6b2021-04-20 18:10:30 +01005172/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005173psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5174 uint8_t *ciphertext,
5175 size_t ciphertext_size,
5176 size_t *ciphertext_length,
5177 uint8_t *tag,
5178 size_t tag_size,
5179 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005180{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005181 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5182
Paul Elliott302ff6b2021-04-20 18:10:30 +01005183 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005184 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005185
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 status = psa_aead_final_checks(operation);
5187 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005188 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005190
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005192 status = PSA_ERROR_BAD_STATE;
5193 goto exit;
5194 }
5195
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5197 ciphertext_size,
5198 ciphertext_length,
5199 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005200
Paul Elliott39dc6b82021-05-11 19:16:09 +01005201exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005202
5203
Paul Elliottf47b0952021-05-21 18:02:33 +01005204 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005205 * the zero tag size, make sure the tag is set to something implausible.
5206 * Even if the operation succeeds, make sure we clear the rest of the
5207 * buffer to prevent potential leakage of anything previously placed in
5208 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005209 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005210
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005214}
5215
5216/* Finish authenticating and decrypting a message in a multipart AEAD
5217 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005218psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5219 uint8_t *plaintext,
5220 size_t plaintext_size,
5221 size_t *plaintext_length,
5222 const uint8_t *tag,
5223 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005224{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005225 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5226
Paul Elliott302ff6b2021-04-20 18:10:30 +01005227 *plaintext_length = 0;
5228
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 status = psa_aead_final_checks(operation);
5230 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005231 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005233
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005235 status = PSA_ERROR_BAD_STATE;
5236 goto exit;
5237 }
5238
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5240 plaintext_size,
5241 plaintext_length,
5242 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005243
5244exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005246
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005248}
5249
5250/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005251psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005252{
5253 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5254
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005256 /* The object has (apparently) been initialized but it is not (yet)
5257 * in use. It's ok to call abort on such an object, and there's
5258 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005260 }
5261
Gilles Peskine449bd832023-01-11 14:50:10 +01005262 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005263
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005265
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005267}
5268
Gilles Peskinee59236f2018-01-27 23:32:46 +01005269/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005270/* Generators */
5271/****************************************************************/
5272
Przemek Stekiel69c46792022-06-10 12:59:51 +02005273#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005274 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005275 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305276 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305277 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005278#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005279#endif /* At least one builtin KDF */
5280
Przemek Stekiel69c46792022-06-10 12:59:51 +02005281#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005282 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5283 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5284static psa_status_t psa_key_derivation_start_hmac(
5285 psa_mac_operation_t *operation,
5286 psa_algorithm_t hash_alg,
5287 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005289{
5290 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5291 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5293 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5294 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005295
Steven Cooreman72f736a2021-05-07 14:14:37 +02005296 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005298
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 status = psa_driver_wrapper_mac_sign_setup(operation,
5300 &attributes,
5301 hmac_key, hmac_key_length,
5302 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005303
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 psa_reset_key_attributes(&attributes);
5305 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005306}
5307#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005308
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005309#define HKDF_STATE_INIT 0 /* no input yet */
5310#define HKDF_STATE_STARTED 1 /* got salt */
5311#define HKDF_STATE_KEYED 2 /* got key */
5312#define HKDF_STATE_OUTPUT 3 /* output started */
5313
Gilles Peskinecbe66502019-05-16 16:59:18 +02005314static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005316{
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5318 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5319 } else {
5320 return operation->alg;
5321 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005322}
5323
Gilles Peskine449bd832023-01-11 14:50:10 +01005324psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005325{
5326 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5328 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005329 /* The object has (apparently) been initialized but it is not
5330 * in use. It's ok to call abort on such an object, and there's
5331 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005333#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5335 mbedtls_free(operation->ctx.hkdf.info);
5336 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5337 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005338#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005339#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5340 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5342 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5343 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5344 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005345 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005347 }
5348
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005350 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005352 }
5353
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005355 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005357 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005358#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005360 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005362 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005363#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005364 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005365
5366 /* We leave the fields Ai and output_block to be erased safely by the
5367 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005369#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5370 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005371#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5373 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5374 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5375 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005376#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305377#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305378 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305379 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005380 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305381 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305382 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305383
5384 status = PSA_SUCCESS;
5385 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305386#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005387 {
5388 status = PSA_ERROR_BAD_STATE;
5389 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 mbedtls_platform_zeroize(operation, sizeof(*operation));
5391 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005392}
5393
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005394psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005396{
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005398 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005400 }
5401
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005402 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005404}
5405
Gilles Peskine449bd832023-01-11 14:50:10 +01005406psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5407 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005408{
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 if (operation->alg == 0) {
5410 return PSA_ERROR_BAD_STATE;
5411 }
5412 if (capacity > operation->capacity) {
5413 return PSA_ERROR_INVALID_ARGUMENT;
5414 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005415 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005417}
5418
Przemek Stekiel69c46792022-06-10 12:59:51 +02005419#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005420/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005421static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5422 psa_algorithm_t kdf_alg,
5423 uint8_t *output,
5424 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005425{
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5427 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005428 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005429 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005430#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005432#else
5433 const uint8_t last_block = 0xff;
5434#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005435
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 if (hkdf->state < HKDF_STATE_KEYED ||
5437 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005438#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005440#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 )) {
5442 return PSA_ERROR_BAD_STATE;
5443 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005444 hkdf->state = HKDF_STATE_OUTPUT;
5445
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005447 /* Copy what remains of the current block */
5448 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005450 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 }
5452 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005453 output += n;
5454 output_length -= n;
5455 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005457 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005459 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005460 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005461 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005462 * object was corrupted or if this function is called directly
5463 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 if (hkdf->block_number == last_block) {
5465 return PSA_ERROR_BAD_STATE;
5466 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005467
5468 /* We need a new block */
5469 ++hkdf->block_number;
5470 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005471
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5473 hash_alg,
5474 hkdf->prk,
5475 hash_length);
5476 if (status != PSA_SUCCESS) {
5477 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005478 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005479
5480 if (hkdf->block_number != 1) {
5481 status = psa_mac_update(&hkdf->hmac,
5482 hkdf->output_block,
5483 hash_length);
5484 if (status != PSA_SUCCESS) {
5485 return status;
5486 }
5487 }
5488 status = psa_mac_update(&hkdf->hmac,
5489 hkdf->info,
5490 hkdf->info_length);
5491 if (status != PSA_SUCCESS) {
5492 return status;
5493 }
5494 status = psa_mac_update(&hkdf->hmac,
5495 &hkdf->block_number, 1);
5496 if (status != PSA_SUCCESS) {
5497 return status;
5498 }
5499 status = psa_mac_sign_finish(&hkdf->hmac,
5500 hkdf->output_block,
5501 sizeof(hkdf->output_block),
5502 &hmac_output_length);
5503 if (status != PSA_SUCCESS) {
5504 return status;
5505 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005506 }
5507
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005509}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005510#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005511
John Durkop07cc04a2020-11-16 22:08:34 -08005512#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5513 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005514static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5515 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005517{
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5519 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005520 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5521 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005522 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005523
Janos Follath7742fee2019-06-17 12:58:10 +01005524 /* We can't be wanting more output after block 0xff, otherwise
5525 * the capacity check in psa_key_derivation_output_bytes() would have
5526 * prevented this call. It could happen only if the operation
5527 * object was corrupted or if this function is called directly
5528 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 if (tls12_prf->block_number == 0xff) {
5530 return PSA_ERROR_CORRUPTION_DETECTED;
5531 }
Janos Follath7742fee2019-06-17 12:58:10 +01005532
5533 /* We need a new block */
5534 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005535 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005536
5537 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5538 *
5539 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5540 *
5541 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5542 * HMAC_hash(secret, A(2) + seed) +
5543 * HMAC_hash(secret, A(3) + seed) + ...
5544 *
5545 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005546 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005547 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005548 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005549 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005550 * is currently extracted as `output_block` and where i is
5551 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005552 */
5553
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 status = psa_key_derivation_start_hmac(&hmac,
5555 hash_alg,
5556 tls12_prf->secret,
5557 tls12_prf->secret_length);
5558 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005559 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005561
5562 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005564 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5565 * the variable seed and in this instance means it in the context of the
5566 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 status = psa_mac_update(&hmac,
5568 tls12_prf->label,
5569 tls12_prf->label_length);
5570 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005571 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 }
5573 status = psa_mac_update(&hmac,
5574 tls12_prf->seed,
5575 tls12_prf->seed_length);
5576 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005577 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 }
5579 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005580 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5582 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005583 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005585 }
5586
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 status = psa_mac_sign_finish(&hmac,
5588 tls12_prf->Ai, hash_length,
5589 &hmac_output_length);
5590 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005591 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 }
5593 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005594 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005596
5597 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 status = psa_key_derivation_start_hmac(&hmac,
5599 hash_alg,
5600 tls12_prf->secret,
5601 tls12_prf->secret_length);
5602 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005603 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 }
5605 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_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->label, tls12_prf->label_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->seed, tls12_prf->seed_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_sign_finish(&hmac,
5618 tls12_prf->output_block, hash_length,
5619 &hmac_output_length);
5620 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005621 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005623
Janos Follath7742fee2019-06-17 12:58:10 +01005624
5625cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 cleanup_status = psa_mac_abort(&hmac);
5627 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005628 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005630
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005632}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005633
Janos Follath844eb0e2019-06-19 12:10:49 +01005634static psa_status_t psa_key_derivation_tls12_prf_read(
5635 psa_tls12_prf_key_derivation_t *tls12_prf,
5636 psa_algorithm_t alg,
5637 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005639{
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5641 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005642 psa_status_t status;
5643 uint8_t offset, length;
5644
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005646 case PSA_TLS12_PRF_STATE_LABEL_SET:
5647 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5648 break;
5649 case PSA_TLS12_PRF_STATE_OUTPUT:
5650 break;
5651 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005653 }
5654
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005656 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005657 if (tls12_prf->left_in_block == 0) {
5658 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5659 alg);
5660 if (status != PSA_SUCCESS) {
5661 return status;
5662 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005663
5664 continue;
5665 }
5666
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005668 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005670 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005672
5673 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005675 output += length;
5676 output_length -= length;
5677 tls12_prf->left_in_block -= length;
5678 }
5679
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005681}
John Durkop07cc04a2020-11-16 22:08:34 -08005682#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5683 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005684
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005685#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5686static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5687 psa_tls12_ecjpake_to_pms_t *ecjpake,
5688 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005689 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005690{
5691 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005692 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005693
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 if (output_length != 32) {
5695 return PSA_ERROR_INVALID_ARGUMENT;
5696 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005697
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5699 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5700 &output_size);
5701 if (status != PSA_SUCCESS) {
5702 return status;
5703 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005704
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 if (output_size != output_length) {
5706 return PSA_ERROR_GENERIC_ERROR;
5707 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005708
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005710}
5711#endif
5712
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305713#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305714static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5715 psa_pbkdf2_key_derivation_t *pbkdf2,
5716 psa_algorithm_t prf_alg,
5717 uint8_t prf_output_length,
5718 psa_key_attributes_t *attributes)
5719{
5720 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305721 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305722 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305723 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305724 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305725 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305726 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305727
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305728 mac_operation.is_sign = 1;
5729 mac_operation.mac_size = prf_output_length;
5730 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305731
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305732 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5733 attributes,
5734 pbkdf2->password,
5735 pbkdf2->password_length,
5736 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305737 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305738 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305739 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305740 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5741 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305742 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305743 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305744 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305745 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305746 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305747 }
5748 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5749 &mac_output_length);
5750 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305751 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305752 }
5753
5754 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305755 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305756 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305757 }
5758
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305759 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305760
5761 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305762 /* We are passing prf_output_length as mac_size because the driver
5763 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305764 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305765 status = psa_driver_wrapper_mac_compute(attributes,
5766 pbkdf2->password,
5767 pbkdf2->password_length,
5768 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305769 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305770 &mac_output_length);
5771 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305772 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305773 }
5774
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305775 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305776 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305777
5778cleanup:
5779 /* Zeroise buffers to clear sensitive data from memory. */
5780 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5781 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305782}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305783
5784static psa_status_t psa_key_derivation_pbkdf2_read(
5785 psa_pbkdf2_key_derivation_t *pbkdf2,
5786 psa_algorithm_t kdf_alg,
5787 uint8_t *output,
5788 size_t output_length)
5789{
5790 psa_status_t status;
5791 psa_algorithm_t prf_alg;
5792 uint8_t prf_output_length;
5793 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5794 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5795 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5796
5797 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5798 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5799 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5800 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305801 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5802 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305803 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305804 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305805 } else {
5806 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305807 }
5808
5809 switch (pbkdf2->state) {
5810 case PSA_PBKDF2_STATE_PASSWORD_SET:
5811 /* Initially we need a new block so bytes_used is equal to block size*/
5812 pbkdf2->bytes_used = prf_output_length;
5813 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5814 break;
5815 case PSA_PBKDF2_STATE_OUTPUT:
5816 break;
5817 default:
5818 return PSA_ERROR_BAD_STATE;
5819 }
5820
5821 while (output_length != 0) {
5822 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5823 if (n > output_length) {
5824 n = (uint8_t) output_length;
5825 }
5826 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5827 output += n;
5828 output_length -= n;
5829 pbkdf2->bytes_used += n;
5830
5831 if (output_length == 0) {
5832 break;
5833 }
5834
5835 /* We need a new block */
5836 pbkdf2->bytes_used = 0;
5837 pbkdf2->block_number++;
5838
5839 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5840 prf_output_length,
5841 &attributes);
5842 if (status != PSA_SUCCESS) {
5843 return status;
5844 }
5845 }
5846
5847 return PSA_SUCCESS;
5848}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305849#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305850
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005851psa_status_t psa_key_derivation_output_bytes(
5852 psa_key_derivation_operation_t *operation,
5853 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005855{
5856 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005858
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005860 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005861 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005862 }
5863
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005865 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005866 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005867 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005868 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005869 goto exit;
5870 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005872 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005873 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005874 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5875 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005876 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005877 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005879 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005880 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005881
Przemek Stekiel69c46792022-06-10 12:59:51 +02005882#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005883 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5884 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5885 output, output_length);
5886 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005887#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005888#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5889 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005890 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5891 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5892 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5893 kdf_alg, output,
5894 output_length);
5895 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005896#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5897 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005898#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005900 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005901 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5902 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005903#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305904#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305905 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305906 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5907 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305908 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305909#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005910
Gilles Peskineeab56e42018-07-12 17:12:33 +02005911 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005912 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005914 }
5915
5916exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005917 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005918 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005919 * This allows us to differentiate between exhausted operations and
5920 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5921 * operations. */
5922 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005924 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005926 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005928}
5929
David Brown7807bf72021-02-09 16:28:23 -07005930#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005931static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005932{
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 if (data_size >= 8) {
5934 mbedtls_des_key_set_parity(data);
5935 }
5936 if (data_size >= 16) {
5937 mbedtls_des_key_set_parity(data + 8);
5938 }
5939 if (data_size >= 24) {
5940 mbedtls_des_key_set_parity(data + 16);
5941 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005942}
David Brown7807bf72021-02-09 16:28:23 -07005943#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005944
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005945/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 * ECC keys on a Weierstrass elliptic curve require the generation
5947 * of a private key which is an integer
5948 * in the range [1, N - 1], where N is the boundary of the private key domain:
5949 * N is the prime p for Diffie-Hellman, or the order of the
5950 * curve’s base point for ECC.
5951 *
5952 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5953 * This function generates the private key using the following process:
5954 *
5955 * 1. Draw a byte string of length ceiling(m/8) bytes.
5956 * 2. If m is not a multiple of 8, set the most significant
5957 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5958 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5959 * 4. If k > N - 2, discard the result and return to step 1.
5960 * 5. Output k + 1 as the private key.
5961 *
5962 * This method allows compliance to NIST standards, specifically the methods titled
5963 * Key-Pair Generation by Testing Candidates in the following publications:
5964 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5965 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5966 * Diffie-Hellman keys.
5967 *
5968 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5969 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5970 *
5971 * Note: Function allocates memory for *data buffer, so given *data should be
5972 * always NULL.
5973 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005974#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5975#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005976static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005977 psa_key_slot_t *slot,
5978 size_t bits,
5979 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005980 uint8_t **data
5981 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005982{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005983 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005984 mbedtls_mpi k;
5985 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005986 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005987 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005988 size_t m;
5989 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005990
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 mbedtls_mpi_init(&k);
5992 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005993
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005994 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005996 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005997 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005998
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006000 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006001 goto cleanup;
6002 }
6003
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006004 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006006
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006008
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006009 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006010 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006011 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006012
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006013 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006014
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006015 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006017
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006018 /* Note: This function is always called with *data == NULL and it
6019 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 *data = mbedtls_calloc(1, m_bytes);
6021 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006022 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006023 goto cleanup;
6024 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006025
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006027 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006029 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006031
6032 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006034 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006035 * (8 * ceiling(m/8) - m) bits of the first byte in
6036 * the string to zero.
6037 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006038 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006039 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006040 }
6041
6042 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 * big-endian byte string.
6044 */
6045 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006046
6047 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006048 * Result of comparison is returned. When it indicates error
6049 * then this function is called again.
6050 */
6051 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006052 }
6053
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006054 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006055 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6056 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006057cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 if (ret != 0) {
6059 status = mbedtls_to_psa_error(ret);
6060 }
6061 if (status != PSA_SUCCESS) {
6062 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006063 *data = NULL;
6064 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006065 mbedtls_mpi_free(&k);
6066 mbedtls_mpi_free(&diff_N_2);
6067 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006068}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006069
6070/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6071 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6072 *
6073 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6074 * draw a 32-byte string and process it as specified in
6075 * Elliptic Curves for Security [RFC7748] §5.
6076 *
6077 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6078 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6079 *
6080 * Note: Function allocates memory for *data buffer, so given *data should be
6081 * always NULL.
6082 */
6083
6084static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6085 size_t bits,
6086 psa_key_derivation_operation_t *operation,
6087 uint8_t **data
6088 )
6089{
6090 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006091 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006092
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006094 case 255:
6095 output_length = 32;
6096 break;
6097 case 448:
6098 output_length = 56;
6099 break;
6100 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006102 break;
6103 }
6104
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006106
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 if (*data == NULL) {
6108 return PSA_ERROR_INSUFFICIENT_MEMORY;
6109 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006110
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006112
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006114 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006116
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006118 case 255:
6119 (*data)[0] &= 248;
6120 (*data)[31] &= 127;
6121 (*data)[31] |= 64;
6122 break;
6123 case 448:
6124 (*data)[0] &= 252;
6125 (*data)[55] |= 128;
6126 break;
6127 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006129 break;
6130 }
6131
6132 return status;
6133}
Valerio Setti86587ab2023-06-27 13:09:30 +02006134#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6135static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6136 psa_key_slot_t *slot, size_t bits,
6137 psa_key_derivation_operation_t *operation, uint8_t **data)
6138{
6139 (void) slot;
6140 (void) bits;
6141 (void) operation;
6142 (void) data;
6143 return PSA_ERROR_NOT_SUPPORTED;
6144}
6145
6146static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6147 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6148{
6149 (void) bits;
6150 (void) operation;
6151 (void) data;
6152 return PSA_ERROR_NOT_SUPPORTED;
6153}
6154#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6155#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006156
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006157static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006158 psa_key_slot_t *slot,
6159 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006161{
6162 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306164 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006165 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006166 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006167
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6169 return PSA_ERROR_INVALID_ARGUMENT;
6170 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006171
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006172#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006173 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6175 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6176 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006177 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6179 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006180 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006181 }
6182 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006183 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6185 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006186 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006188 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006189 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006190#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006191 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 if (key_type_is_raw_bytes(slot->attr.type)) {
6193 if (bits % 8 != 0) {
6194 return PSA_ERROR_INVALID_ARGUMENT;
6195 }
6196 data = mbedtls_calloc(1, bytes);
6197 if (data == NULL) {
6198 return PSA_ERROR_INSUFFICIENT_MEMORY;
6199 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006200
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 status = psa_key_derivation_output_bytes(operation, data, bytes);
6202 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006203 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 }
David Brown12ca5032021-02-11 11:02:00 -07006205#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6207 psa_des_set_key_parity(data, bytes);
6208 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006209#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 } else {
6211 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006212 }
Ronald Crondd04d422020-11-28 15:14:42 +01006213
Ronald Cronbf33c932020-11-28 18:06:53 +01006214 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006215 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006217 };
6218
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6220 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6221 &storage_size);
6222 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306223 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 }
Archanad8a83dc2021-06-14 10:04:16 +05306225 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 status = psa_allocate_buffer_to_slot(slot, storage_size);
6227 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306228 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 }
Archanad8a83dc2021-06-14 10:04:16 +05306230
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 status = psa_driver_wrapper_import_key(&attributes,
6232 data, bytes,
6233 slot->key.data,
6234 slot->key.bytes,
6235 &slot->key.bytes, &bits);
6236 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006237 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006239
6240exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 mbedtls_free(data);
6242 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006243}
6244
Gilles Peskine449bd832023-01-11 14:50:10 +01006245psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6246 psa_key_derivation_operation_t *operation,
6247 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006248{
6249 psa_status_t status;
6250 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006251 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006252
Ronald Cron81709fc2020-11-14 12:10:32 +01006253 *key = MBEDTLS_SVC_KEY_ID_INIT;
6254
Gilles Peskine0f84d622019-09-12 19:03:13 +02006255 /* Reject any attempt to create a zero-length key so that we don't
6256 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 if (psa_get_key_bits(attributes) == 0) {
6258 return PSA_ERROR_INVALID_ARGUMENT;
6259 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006260
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 if (operation->alg == PSA_ALG_NONE) {
6262 return PSA_ERROR_BAD_STATE;
6263 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006264
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 if (!operation->can_output_key) {
6266 return PSA_ERROR_NOT_PERMITTED;
6267 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006268
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6270 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006271#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006273 /* Deriving a key in a secure element is not implemented yet. */
6274 status = PSA_ERROR_NOT_SUPPORTED;
6275 }
6276#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 if (status == PSA_SUCCESS) {
6278 status = psa_generate_derived_key_internal(slot,
6279 attributes->core.bits,
6280 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006281 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 if (status == PSA_SUCCESS) {
6283 status = psa_finish_key_creation(slot, driver, key);
6284 }
6285 if (status != PSA_SUCCESS) {
6286 psa_fail_key_creation(slot, driver);
6287 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006288
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006290}
6291
Gilles Peskineeab56e42018-07-12 17:12:33 +02006292
6293
6294/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006295/* Key derivation */
6296/****************************************************************/
6297
Steven Cooreman932ffb72021-02-15 12:14:32 +01006298#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006299static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006300{
6301#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6303 return 1;
6304 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006305#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006306#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006307 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6308 return 1;
6309 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006310#endif
6311#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6313 return 1;
6314 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006315#endif
6316#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6318 return 1;
6319 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006320#endif
6321#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006322 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6323 return 1;
6324 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006325#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006326#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6328 return 1;
6329 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006330#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306331#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6332 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6333 return 1;
6334 }
6335#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306336#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6337 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6338 return 1;
6339 }
6340#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006341 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006342}
6343
Gilles Peskine449bd832023-01-11 14:50:10 +01006344static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006345{
6346 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 psa_status_t status = psa_hash_setup(&operation, alg);
6348 psa_hash_abort(&operation);
6349 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006350}
6351
Gilles Peskine969c5d62019-01-16 15:53:06 +01006352static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006353 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006355{
Janos Follath5fe19732019-06-20 15:09:30 +01006356 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6357 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006359
Gilles Peskine969c5d62019-01-16 15:53:06 +01006360 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006361 if (!is_kdf_alg_supported(kdf_alg)) {
6362 return PSA_ERROR_NOT_SUPPORTED;
6363 }
John Durkop07cc04a2020-11-16 22:08:34 -08006364
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006365 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306366 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6368 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306369 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6370 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6371 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306372 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306373 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 if (hash_size == 0) {
6375 return PSA_ERROR_NOT_SUPPORTED;
6376 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006377
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006378 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6379 * we might fail later, which is somewhat unfriendly and potentially
6380 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 psa_status_t status = psa_hash_try_support(hash_alg);
6382 if (status != PSA_SUCCESS) {
6383 return status;
6384 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006385 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6388 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6389 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6390 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006391 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006392#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006393 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6395 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006396 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006398#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6399 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 operation->capacity = 255 * hash_size;
6401 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006402}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006403
Gilles Peskine449bd832023-01-11 14:50:10 +01006404static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006405{
6406#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 if (alg == PSA_ALG_ECDH) {
6408 return PSA_SUCCESS;
6409 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006410#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006411#if defined(PSA_WANT_ALG_FFDH)
6412 if (alg == PSA_ALG_FFDH) {
6413 return PSA_SUCCESS;
6414 }
6415#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006416 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006418}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006419
6420static int psa_key_derivation_allows_free_form_secret_input(
6421 psa_algorithm_t kdf_alg)
6422{
6423#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6424 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6425 return 0;
6426 }
6427#endif
6428 (void) kdf_alg;
6429 return 1;
6430}
John Durkop07cc04a2020-11-16 22:08:34 -08006431#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006432
Gilles Peskine449bd832023-01-11 14:50:10 +01006433psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6434 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006435{
6436 psa_status_t status;
6437
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 if (operation->alg != 0) {
6439 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006440 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006441
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6443 return PSA_ERROR_INVALID_ARGUMENT;
6444 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6445#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6446 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6447 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6448 status = psa_key_agreement_try_support(ka_alg);
6449 if (status != PSA_SUCCESS) {
6450 return status;
6451 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006452 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6453 return PSA_ERROR_INVALID_ARGUMENT;
6454 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6456#else
6457 return PSA_ERROR_NOT_SUPPORTED;
6458#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6459 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6460#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6461 status = psa_key_derivation_setup_kdf(operation, alg);
6462#else
6463 return PSA_ERROR_NOT_SUPPORTED;
6464#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6465 } else {
6466 return PSA_ERROR_INVALID_ARGUMENT;
6467 }
6468
6469 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006470 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 }
6472 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006473}
6474
Przemek Stekiel69c46792022-06-10 12:59:51 +02006475#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006476static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6477 psa_algorithm_t kdf_alg,
6478 psa_key_derivation_step_t step,
6479 const uint8_t *data,
6480 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006481{
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006483 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006485 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006486#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6488 return PSA_ERROR_INVALID_ARGUMENT;
6489 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006490#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 if (hkdf->state != HKDF_STATE_INIT) {
6492 return PSA_ERROR_BAD_STATE;
6493 } else {
6494 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6495 hash_alg,
6496 data, data_length);
6497 if (status != PSA_SUCCESS) {
6498 return status;
6499 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006500 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006502 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006503 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006504#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006506 /* We shouldn't be in different state as HKDF_EXPAND only allows
6507 * two inputs: SECRET (this case) and INFO which does not modify
6508 * the state. It could happen only if the hkdf
6509 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006510 if (hkdf->state != HKDF_STATE_INIT) {
6511 return PSA_ERROR_BAD_STATE;
6512 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006513
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006514 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6516 return PSA_ERROR_INVALID_ARGUMENT;
6517 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006518
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 memcpy(hkdf->prk, data, data_length);
6520 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006521#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006522 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006523 /* HKDF: If no salt was provided, use an empty salt.
6524 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006526#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006527 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6528 return PSA_ERROR_BAD_STATE;
6529 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006530#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6532 hash_alg,
6533 NULL, 0);
6534 if (status != PSA_SUCCESS) {
6535 return status;
6536 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006537 hkdf->state = HKDF_STATE_STARTED;
6538 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 if (hkdf->state != HKDF_STATE_STARTED) {
6540 return PSA_ERROR_BAD_STATE;
6541 }
6542 status = psa_mac_update(&hkdf->hmac,
6543 data, data_length);
6544 if (status != PSA_SUCCESS) {
6545 return status;
6546 }
6547 status = psa_mac_sign_finish(&hkdf->hmac,
6548 hkdf->prk,
6549 sizeof(hkdf->prk),
6550 &data_length);
6551 if (status != PSA_SUCCESS) {
6552 return status;
6553 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006554 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006555
Gilles Peskine2b522db2019-04-12 15:11:49 +02006556 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006557 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006558#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006560 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006562 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006564#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006565 {
6566 /* Block 0 is empty, and the next block will be
6567 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006569 }
6570
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006572 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006573#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6575 return PSA_ERROR_INVALID_ARGUMENT;
6576 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006577#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006578#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6580 hkdf->state == HKDF_STATE_INIT) {
6581 return PSA_ERROR_BAD_STATE;
6582 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006583#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 if (hkdf->state == HKDF_STATE_OUTPUT) {
6585 return PSA_ERROR_BAD_STATE;
6586 }
6587 if (hkdf->info_set) {
6588 return PSA_ERROR_BAD_STATE;
6589 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006590 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 if (data_length != 0) {
6592 hkdf->info = mbedtls_calloc(1, data_length);
6593 if (hkdf->info == NULL) {
6594 return PSA_ERROR_INSUFFICIENT_MEMORY;
6595 }
6596 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006597 }
6598 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006599 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006600 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006602 }
6603}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006604#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006605
John Durkop07cc04a2020-11-16 22:08:34 -08006606#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6607 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006608static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6609 const uint8_t *data,
6610 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006611{
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6613 return PSA_ERROR_BAD_STATE;
6614 }
Janos Follathf08e2652019-06-13 09:05:41 +01006615
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 if (data_length != 0) {
6617 prf->seed = mbedtls_calloc(1, data_length);
6618 if (prf->seed == NULL) {
6619 return PSA_ERROR_INSUFFICIENT_MEMORY;
6620 }
Janos Follathf08e2652019-06-13 09:05:41 +01006621
Gilles Peskine449bd832023-01-11 14:50:10 +01006622 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006623 prf->seed_length = data_length;
6624 }
Janos Follathf08e2652019-06-13 09:05:41 +01006625
Gilles Peskine43f958b2020-12-13 14:55:14 +01006626 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006627
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006629}
6630
Gilles Peskine449bd832023-01-11 14:50:10 +01006631static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6632 const uint8_t *data,
6633 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006634{
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6636 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6637 return PSA_ERROR_BAD_STATE;
6638 }
Janos Follath81550542019-06-13 14:26:34 +01006639
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 if (data_length != 0) {
6641 prf->secret = mbedtls_calloc(1, data_length);
6642 if (prf->secret == NULL) {
6643 return PSA_ERROR_INSUFFICIENT_MEMORY;
6644 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006645
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006647 prf->secret_length = data_length;
6648 }
Janos Follath81550542019-06-13 14:26:34 +01006649
Gilles Peskine43f958b2020-12-13 14:55:14 +01006650 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006653}
6654
Gilles Peskine449bd832023-01-11 14:50:10 +01006655static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6656 const uint8_t *data,
6657 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006658{
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6660 return PSA_ERROR_BAD_STATE;
6661 }
Janos Follath63028dd2019-06-13 09:15:47 +01006662
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 if (data_length != 0) {
6664 prf->label = mbedtls_calloc(1, data_length);
6665 if (prf->label == NULL) {
6666 return PSA_ERROR_INSUFFICIENT_MEMORY;
6667 }
Janos Follath63028dd2019-06-13 09:15:47 +01006668
Gilles Peskine449bd832023-01-11 14:50:10 +01006669 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006670 prf->label_length = data_length;
6671 }
Janos Follath63028dd2019-06-13 09:15:47 +01006672
Gilles Peskine43f958b2020-12-13 14:55:14 +01006673 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006674
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006676}
6677
Gilles Peskine449bd832023-01-11 14:50:10 +01006678static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6679 psa_key_derivation_step_t step,
6680 const uint8_t *data,
6681 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006682{
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006684 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006686 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006688 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006690 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006691 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006692 }
6693}
John Durkop07cc04a2020-11-16 22:08:34 -08006694#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6695 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6696
6697#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6698static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6699 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006700 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006701 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006702{
6703 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006704 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6705 4 + data_length + prf->other_secret_length :
6706 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006707
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6709 return PSA_ERROR_INVALID_ARGUMENT;
6710 }
John Durkop07cc04a2020-11-16 22:08:34 -08006711
Gilles Peskine449bd832023-01-11 14:50:10 +01006712 uint8_t *pms = mbedtls_calloc(1, pms_len);
6713 if (pms == NULL) {
6714 return PSA_ERROR_INSUFFICIENT_MEMORY;
6715 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006716 uint8_t *cur = pms;
6717
6718 /* pure-PSK:
6719 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006720 *
6721 * The premaster secret is formed as follows: if the PSK is N octets
6722 * long, concatenate a uint16 with the value N, N zero octets, a second
6723 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006724 *
6725 * mixed-PSK:
6726 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6727 * follows: concatenate a uint16 with the length of the other secret,
6728 * the other secret itself, uint16 with the length of PSK, and the
6729 * PSK itself.
6730 * For details please check:
6731 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6732 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6733 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006734 */
6735
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6737 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6738 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6739 if (prf->other_secret_length != 0) {
6740 memcpy(cur, prf->other_secret, prf->other_secret_length);
6741 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006742 cur += prf->other_secret_length;
6743 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 } else {
6745 *cur++ = MBEDTLS_BYTE_1(data_length);
6746 *cur++ = MBEDTLS_BYTE_0(data_length);
6747 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006748 cur += data_length;
6749 }
6750
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 *cur++ = MBEDTLS_BYTE_1(data_length);
6752 *cur++ = MBEDTLS_BYTE_0(data_length);
6753 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006754 cur += data_length;
6755
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006756 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006757
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006758 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006760}
Janos Follath6660f0e2019-06-17 08:44:03 +01006761
Przemek Stekiele47201b2022-04-19 13:53:28 +02006762static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6763 psa_tls12_prf_key_derivation_t *prf,
6764 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006766{
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6768 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006769 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006770
6771 if (data_length != 0) {
6772 prf->other_secret = mbedtls_calloc(1, data_length);
6773 if (prf->other_secret == NULL) {
6774 return PSA_ERROR_INSUFFICIENT_MEMORY;
6775 }
6776
6777 memcpy(prf->other_secret, data, data_length);
6778 prf->other_secret_length = data_length;
6779 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006780 prf->other_secret_length = 0;
6781 }
6782
6783 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6784
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006786}
6787
Janos Follath6660f0e2019-06-17 08:44:03 +01006788static psa_status_t psa_tls12_prf_psk_to_ms_input(
6789 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006790 psa_key_derivation_step_t step,
6791 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006793{
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006795 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006796 return psa_tls12_prf_psk_to_ms_set_key(prf,
6797 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006798 break;
6799 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6801 data,
6802 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006803 break;
6804 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006805 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006806 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006807
Przemek Stekiele47201b2022-04-19 13:53:28 +02006808 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006809}
John Durkop07cc04a2020-11-16 22:08:34 -08006810#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006811
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006812#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6813static psa_status_t psa_tls12_ecjpake_to_pms_input(
6814 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006815 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006816 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006817 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006818{
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6820 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6821 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006822 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006823
6824 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006825 if (data[0] != 0x04) {
6826 return PSA_ERROR_INVALID_ARGUMENT;
6827 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006828
6829 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006831
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006833}
6834#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306835
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306836#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306837static psa_status_t psa_pbkdf2_set_input_cost(
6838 psa_pbkdf2_key_derivation_t *pbkdf2,
6839 psa_key_derivation_step_t step,
6840 uint64_t data)
6841{
6842 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6843 return PSA_ERROR_INVALID_ARGUMENT;
6844 }
6845
6846 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6847 return PSA_ERROR_BAD_STATE;
6848 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306849
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306850 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306851 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306852 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306853
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306854 if (data == 0) {
6855 return PSA_ERROR_INVALID_ARGUMENT;
6856 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306857
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306858 pbkdf2->input_cost = data;
6859 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6860
6861 return PSA_SUCCESS;
6862}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306863
6864static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6865 const uint8_t *data,
6866 size_t data_length)
6867{
Gilles Peskineead17662023-08-20 22:02:51 +02006868 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6869 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6870 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6871 /* Appending to existing salt. No state change. */
6872 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306873 return PSA_ERROR_BAD_STATE;
6874 }
6875
Gilles Peskineca57d782023-07-20 19:08:06 +02006876 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006877 /* Appending an empty string, nothing to do. */
6878 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306879 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306880
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306881 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6882 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306883 return PSA_ERROR_INSUFFICIENT_MEMORY;
6884 }
6885
Gilles Peskineead17662023-08-20 22:02:51 +02006886 if (pbkdf2->salt_length != 0) {
6887 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6888 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306889 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306890 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306891 mbedtls_free(pbkdf2->salt);
6892 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306893 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306894 return PSA_SUCCESS;
6895}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306896
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306897#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306898static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306899 const uint8_t *input,
6900 size_t input_len,
6901 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306902 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306903{
6904 psa_status_t status = PSA_SUCCESS;
6905 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6906 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306907 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306908 } else {
6909 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306910 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306911 }
6912 return status;
6913}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306914#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306915
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306916#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306917static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6918 size_t input_len,
6919 uint8_t *output,
6920 size_t *output_len)
6921{
6922 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306923 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306924 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306925 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306926 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6927 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6928 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306929 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306930 * mac_size as the driver function sets mac_output_length = mac_size
6931 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306932 status = psa_driver_wrapper_mac_compute(&attributes,
6933 zeros, sizeof(zeros),
6934 PSA_ALG_CMAC, input, input_len,
6935 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306936 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6937 128U,
6938 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306939 output_len);
6940 } else {
6941 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306942 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306943 }
6944 return status;
6945}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306946#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306947
6948static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306949 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306950 const uint8_t *data,
6951 size_t data_length)
6952{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306953 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306954 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6955 return PSA_ERROR_BAD_STATE;
6956 }
6957
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306958#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306959 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6960 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6961 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6962 pbkdf2->password,
6963 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306964 } else
6965#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6966#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6967 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306968 status = psa_pbkdf2_cmac_set_password(data, data_length,
6969 pbkdf2->password,
6970 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306971 } else
6972#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6973 {
6974 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306975 }
6976
6977 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6978
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306979 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306980}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306981
6982static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306983 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306984 psa_key_derivation_step_t step,
6985 const uint8_t *data,
6986 size_t data_length)
6987{
6988 switch (step) {
6989 case PSA_KEY_DERIVATION_INPUT_SALT:
6990 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6991 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306992 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306993 default:
6994 return PSA_ERROR_INVALID_ARGUMENT;
6995 }
6996}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306997#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306998
Gilles Peskineb8965192019-09-24 16:21:10 +02006999/** Check whether the given key type is acceptable for the given
7000 * input step of a key derivation.
7001 *
7002 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7003 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7004 * Both secret and non-secret inputs can alternatively have the type
7005 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7006 * that the input was passed as a buffer rather than via a key object.
7007 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007008static int psa_key_derivation_check_input_type(
7009 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007011{
Gilles Peskine449bd832023-01-11 14:50:10 +01007012 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007013 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 if (key_type == PSA_KEY_TYPE_DERIVE) {
7015 return PSA_SUCCESS;
7016 }
7017 if (key_type == PSA_KEY_TYPE_NONE) {
7018 return PSA_SUCCESS;
7019 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007020 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007021 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 if (key_type == PSA_KEY_TYPE_DERIVE) {
7023 return PSA_SUCCESS;
7024 }
7025 if (key_type == PSA_KEY_TYPE_NONE) {
7026 return PSA_SUCCESS;
7027 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007028 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007029 case PSA_KEY_DERIVATION_INPUT_LABEL:
7030 case PSA_KEY_DERIVATION_INPUT_SALT:
7031 case PSA_KEY_DERIVATION_INPUT_INFO:
7032 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7034 return PSA_SUCCESS;
7035 }
7036 if (key_type == PSA_KEY_TYPE_NONE) {
7037 return PSA_SUCCESS;
7038 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007039 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307040 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7041 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7042 return PSA_SUCCESS;
7043 }
7044 if (key_type == PSA_KEY_TYPE_DERIVE) {
7045 return PSA_SUCCESS;
7046 }
7047 if (key_type == PSA_KEY_TYPE_NONE) {
7048 return PSA_SUCCESS;
7049 }
7050 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007051 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007053}
7054
Janos Follathb80a94e2019-06-12 15:54:46 +01007055static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007056 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007057 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007058 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007059 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007061{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007062 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007064
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 status = psa_key_derivation_check_input_type(step, key_type);
7066 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007067 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007068 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007069
Przemek Stekiel69c46792022-06-10 12:59:51 +02007070#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7072 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7073 step, data, data_length);
7074 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007075#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007076#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7078 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7079 step, data, data_length);
7080 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007081#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7082#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7084 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7085 step, data, data_length);
7086 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007087#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007088#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007090 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7092 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007093#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307094#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307095 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307096 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7097 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307098 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307099#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007100 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007101 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007102 (void) data;
7103 (void) data_length;
7104 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007106 }
7107
Gilles Peskine224b0d62019-09-23 18:13:17 +02007108exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 if (status != PSA_SUCCESS) {
7110 psa_key_derivation_abort(operation);
7111 }
7112 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007113}
7114
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307115static psa_status_t psa_key_derivation_input_integer_internal(
7116 psa_key_derivation_operation_t *operation,
7117 psa_key_derivation_step_t step,
7118 uint64_t value)
7119{
7120 psa_status_t status;
7121 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7122
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307123#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307124 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307125 status = psa_pbkdf2_set_input_cost(
7126 &operation->ctx.pbkdf2, step, value);
7127 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307128#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307129 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307130 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307131 (void) value;
7132 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307133 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307134 }
7135
7136 if (status != PSA_SUCCESS) {
7137 psa_key_derivation_abort(operation);
7138 }
7139 return status;
7140}
7141
Janos Follath51f4a0f2019-06-14 11:35:55 +01007142psa_status_t psa_key_derivation_input_bytes(
7143 psa_key_derivation_operation_t *operation,
7144 psa_key_derivation_step_t step,
7145 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007147{
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 return psa_key_derivation_input_internal(operation, step,
7149 PSA_KEY_TYPE_NONE,
7150 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007151}
7152
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307153psa_status_t psa_key_derivation_input_integer(
7154 psa_key_derivation_operation_t *operation,
7155 psa_key_derivation_step_t step,
7156 uint64_t value)
7157{
7158 return psa_key_derivation_input_integer_internal(operation, step, value);
7159}
7160
Janos Follath51f4a0f2019-06-14 11:35:55 +01007161psa_status_t psa_key_derivation_input_key(
7162 psa_key_derivation_operation_t *operation,
7163 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007165{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007166 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007167 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007168 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007169
Ronald Cron5c522922020-11-14 16:35:34 +01007170 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7172 if (status != PSA_SUCCESS) {
7173 psa_key_derivation_abort(operation);
7174 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007175 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007176
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307177 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7178 * permission to output to a key object. */
7179 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7180 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007181 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007183
Gilles Peskine449bd832023-01-11 14:50:10 +01007184 status = psa_key_derivation_input_internal(operation,
7185 step, slot->attr.type,
7186 slot->key.data,
7187 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007188
Ryan Everett1b70a072024-01-04 10:32:49 +00007189 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007190
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007192}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007193
7194
7195
7196/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007197/* Key agreement */
7198/****************************************************************/
7199
Gilles Peskine449bd832023-01-11 14:50:10 +01007200psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7201 const uint8_t *key_buffer,
7202 size_t key_buffer_size,
7203 psa_algorithm_t alg,
7204 const uint8_t *peer_key,
7205 size_t peer_key_length,
7206 uint8_t *shared_secret,
7207 size_t shared_secret_size,
7208 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007209{
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007211#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007212 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7214 key_buffer_size, alg,
7215 peer_key, peer_key_length,
7216 shared_secret,
7217 shared_secret_size,
7218 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007219#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007220
7221#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7222 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007223 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007224 peer_key,
7225 peer_key_length,
7226 key_buffer,
7227 key_buffer_size,
7228 shared_secret,
7229 shared_secret_size,
7230 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007231#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7232
Gilles Peskine01d718c2018-09-18 12:01:02 +02007233 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007234 (void) attributes;
7235 (void) key_buffer;
7236 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007237 (void) peer_key;
7238 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007239 (void) shared_secret;
7240 (void) shared_secret_size;
7241 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007242 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007243 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007244}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007245
Aditya Deshpande17845b82022-10-13 17:21:01 +01007246/** Internal function for raw key agreement
7247 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007248 * to the driver's implementation if a driver is present.
7249 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007250 * (psa_key_agreement_raw_builtin).
7251 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007252static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7253 psa_key_slot_t *private_key,
7254 const uint8_t *peer_key,
7255 size_t peer_key_length,
7256 uint8_t *shared_secret,
7257 size_t shared_secret_size,
7258 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007259{
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7261 return PSA_ERROR_NOT_SUPPORTED;
7262 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007263
7264 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007266 };
7267
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 return psa_driver_wrapper_key_agreement(&attributes,
7269 private_key->key.data,
7270 private_key->key.bytes, alg,
7271 peer_key, peer_key_length,
7272 shared_secret,
7273 shared_secret_size,
7274 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007275}
7276
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007277/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007278 * to potentially free embedded data structures and wipe confidential data.
7279 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007280static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7281 psa_key_derivation_step_t step,
7282 psa_key_slot_t *private_key,
7283 const uint8_t *peer_key,
7284 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007285{
7286 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007287 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007288 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007290
7291 /* Step 1: run the secret agreement algorithm to generate the shared
7292 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 status = psa_key_agreement_raw_internal(ka_alg,
7294 private_key,
7295 peer_key, peer_key_length,
7296 shared_secret,
7297 sizeof(shared_secret),
7298 &shared_secret_length);
7299 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007300 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007301 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007302
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007303 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007304 * the shared secret. A shared secret is permitted wherever a key
7305 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007306 status = psa_key_derivation_input_internal(operation, step,
7307 PSA_KEY_TYPE_DERIVE,
7308 shared_secret,
7309 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007310exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007311 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7312 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007313}
7314
Gilles Peskine449bd832023-01-11 14:50:10 +01007315psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7316 psa_key_derivation_step_t step,
7317 mbedtls_svc_key_id_t private_key,
7318 const uint8_t *peer_key,
7319 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007320{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007321 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007322 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007323 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007324
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7326 return PSA_ERROR_INVALID_ARGUMENT;
7327 }
Ronald Cron5c522922020-11-14 16:35:34 +01007328 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7330 if (status != PSA_SUCCESS) {
7331 return status;
7332 }
7333 status = psa_key_agreement_internal(operation, step,
7334 slot,
7335 peer_key, peer_key_length);
7336 if (status != PSA_SUCCESS) {
7337 psa_key_derivation_abort(operation);
7338 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007339 /* If a private key has been added as SECRET, we allow the derived
7340 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007341 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007342 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007344 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007345
Ryan Everett1b70a072024-01-04 10:32:49 +00007346 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007347
Gilles Peskine449bd832023-01-11 14:50:10 +01007348 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007349}
7350
Gilles Peskine449bd832023-01-11 14:50:10 +01007351psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7352 mbedtls_svc_key_id_t private_key,
7353 const uint8_t *peer_key,
7354 size_t peer_key_length,
7355 uint8_t *output,
7356 size_t output_size,
7357 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007358{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007359 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007360 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007361 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007362 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007363
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007365 status = PSA_ERROR_INVALID_ARGUMENT;
7366 goto exit;
7367 }
Ronald Cron5c522922020-11-14 16:35:34 +01007368 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7370 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007371 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007373
Gilles Peskine3e561302022-04-14 00:17:15 +02007374 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7375 * for the output size. The PSA specification only guarantees that this
7376 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7377 * but it might be nice to allow smaller buffers if the output fits.
7378 * At the time of writing this comment, with only ECDH implemented,
7379 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7380 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7381 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007382 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007383 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7384 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007385 status = PSA_ERROR_BUFFER_TOO_SMALL;
7386 goto exit;
7387 }
7388
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 status = psa_key_agreement_raw_internal(alg, slot,
7390 peer_key, peer_key_length,
7391 output, output_size,
7392 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007393
7394exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007395 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007396 /* If an error happens and is not handled properly, the output
7397 * may be used as a key to protect sensitive data. Arrange for such
7398 * a key to be random, which is likely to result in decryption or
7399 * verification errors. This is better than filling the buffer with
7400 * some constant data such as zeros, which would result in the data
7401 * being protected with a reproducible, easily knowable key.
7402 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007404 *output_length = output_size;
7405 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007406
Ryan Everett1b70a072024-01-04 10:32:49 +00007407 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007408
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007410}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007411
7412
Gilles Peskine30524eb2020-11-13 17:02:26 +01007413
Gilles Peskine86a440b2018-11-12 18:39:40 +01007414/****************************************************************/
7415/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007416/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007417
Gilles Peskine672a7712023-04-28 21:00:28 +02007418#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7419#include "entropy_poll.h"
7420#endif
7421
Gilles Peskine30524eb2020-11-13 17:02:26 +01007422/** Initialize the PSA random generator.
7423 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007424static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007425{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007426#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007428#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7429
Gilles Peskine30524eb2020-11-13 17:02:26 +01007430 /* Set default configuration if
7431 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007433 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 }
7435 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007436 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007438
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007440#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7441 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7442 /* The PSA entropy injection feature depends on using NV seed as an entropy
7443 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 mbedtls_entropy_add_source(&rng->entropy,
7445 mbedtls_nv_seed_poll, NULL,
7446 MBEDTLS_ENTROPY_BLOCK_SIZE,
7447 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007448#endif
7449
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007451#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007452}
7453
7454/** Deinitialize the PSA random generator.
7455 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007456static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007457{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007458#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007459 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007460#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007461 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7462 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007463#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007464}
7465
7466/** Seed the PSA random generator.
7467 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007468static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007469{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007470#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7471 /* Do nothing: the external RNG seeds itself. */
7472 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007474#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007475 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7477 drbg_seed, sizeof(drbg_seed) - 1);
7478 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007479#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007480}
7481
Gilles Peskine449bd832023-01-11 14:50:10 +01007482psa_status_t psa_generate_random(uint8_t *output,
7483 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007484{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007485 GUARD_MODULE_INITIALIZED;
7486
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007487#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7488
7489 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7491 output, output_size,
7492 &output_length);
7493 if (status != PSA_SUCCESS) {
7494 return status;
7495 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007496 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007497 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 if (output_length != output_size) {
7499 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7500 }
7501 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007502
7503#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7504
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007506 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7508 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7509 output_size);
7510 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7511 output, request_size);
7512 if (ret != 0) {
7513 return mbedtls_to_psa_error(ret);
7514 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007515 output_size -= request_size;
7516 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007517 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007519#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007520}
7521
Gilles Peskine8814fc42020-12-14 15:33:44 +01007522/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007523 *
7524 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7525 * `psa_generate_random(...)`. The state parameter is ignored since the
7526 * PSA API doesn't support passing an explicit state.
7527 *
7528 * In the non-external case, psa_generate_random() calls an
7529 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7530 * and semantics as mbedtls_psa_get_random(). As an optimization,
7531 * instead of doing this back-and-forth between the PSA API and the
7532 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7533 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007534 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007535#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7536int mbedtls_psa_get_random(void *p_rng,
7537 unsigned char *output,
7538 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007539{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007540 /* This function takes a pointer to the RNG state because that's what
7541 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7542 * its own state internally and doesn't let the caller access that state.
7543 * So we just ignore the state parameter, and in practice we'll pass
7544 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007545 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 psa_status_t status = psa_generate_random(output, output_size);
7547 if (status == PSA_SUCCESS) {
7548 return 0;
7549 } else {
7550 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7551 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007552}
7553#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7554
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007555#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007556psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7557 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007558{
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 if (global_data.initialized) {
7560 return PSA_ERROR_NOT_PERMITTED;
7561 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7564 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7565 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7566 return PSA_ERROR_INVALID_ARGUMENT;
7567 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007568
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007570}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007571#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007572
Ronald Cron3772afe2021-02-08 16:10:05 +01007573/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007574 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007575 * \param type The key type
7576 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007577 *
7578 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007579 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007580 * \retval #PSA_ERROR_INVALID_ARGUMENT
7581 * The size in bits of the key is not valid.
7582 * \retval #PSA_ERROR_NOT_SUPPORTED
7583 * The type and/or the size in bits of the key or the combination of
7584 * the two is not supported.
7585 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007586static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007588{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007589 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007590
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 if (key_type_is_raw_bytes(type)) {
7592 status = psa_validate_unstructured_key_bit_size(type, bits);
7593 if (status != PSA_SUCCESS) {
7594 return status;
7595 }
7596 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007597#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7599 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7600 return PSA_ERROR_NOT_SUPPORTED;
7601 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007602 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007603 return PSA_ERROR_NOT_SUPPORTED;
7604 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007605
Ronald Cron01b2aba2020-10-05 09:42:02 +02007606 /* Accept only byte-aligned keys, for the same reasons as
7607 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 if (bits % 8 != 0) {
7609 return PSA_ERROR_NOT_SUPPORTED;
7610 }
7611 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007612#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007613
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007614#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007616 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007617 return PSA_SUCCESS;
7618 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007619#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007620
Valerio Settia55f0422023-07-10 15:34:41 +02007621#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007622 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007623 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007624 return PSA_ERROR_NOT_SUPPORTED;
7625 }
7626 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007627#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007628 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007630 }
7631
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007633}
7634
Ronald Cron55ed0592020-10-05 10:30:40 +02007635psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007636 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007638{
7639 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007640 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007641
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 if ((attributes->domain_parameters == NULL) &&
7643 (attributes->domain_parameters_size != 0)) {
7644 return PSA_ERROR_INVALID_ARGUMENT;
7645 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007646
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 if (key_type_is_raw_bytes(type)) {
7648 status = psa_generate_random(key_buffer, key_buffer_size);
7649 if (status != PSA_SUCCESS) {
7650 return status;
7651 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007652
David Brown12ca5032021-02-11 11:02:00 -07007653#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 if (type == PSA_KEY_TYPE_DES) {
7655 psa_des_set_key_parity(key_buffer, key_buffer_size);
7656 }
David Brown8107e312021-02-12 08:08:46 -07007657#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007659
Valerio Setti76df8c12023-07-11 14:11:28 +02007660#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7662 return mbedtls_psa_rsa_generate_key(attributes,
7663 key_buffer,
7664 key_buffer_size,
7665 key_buffer_length);
7666 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007667#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007668
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007669#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007670 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7671 return mbedtls_psa_ecp_generate_key(attributes,
7672 key_buffer,
7673 key_buffer_size,
7674 key_buffer_length);
7675 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007676#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007677
Valerio Settia55f0422023-07-10 15:34:41 +02007678#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007679 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7680 return mbedtls_psa_ffdh_generate_key(attributes,
7681 key_buffer,
7682 key_buffer_size,
7683 key_buffer_length);
7684 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007685#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007686 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007687 (void) key_buffer_length;
7688 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007689 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007690
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007692}
Darryl Green0c6575a2018-11-07 16:05:30 +00007693
Gilles Peskine449bd832023-01-11 14:50:10 +01007694psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7695 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007696{
7697 psa_status_t status;
7698 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007699 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007700 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007701
Ronald Cron81709fc2020-11-14 12:10:32 +01007702 *key = MBEDTLS_SVC_KEY_ID_INIT;
7703
Gilles Peskine0f84d622019-09-12 19:03:13 +02007704 /* Reject any attempt to create a zero-length key so that we don't
7705 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007706 if (psa_get_key_bits(attributes) == 0) {
7707 return PSA_ERROR_INVALID_ARGUMENT;
7708 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007709
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007710 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007711 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7712 return PSA_ERROR_INVALID_ARGUMENT;
7713 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007714
Gilles Peskine449bd832023-01-11 14:50:10 +01007715 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7716 &slot, &driver);
7717 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007718 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 }
Gilles Peskine11792082019-08-06 18:36:36 +02007720
Ronald Cron977c2472020-10-13 08:32:21 +02007721 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307722 * storage ( thus not in the case of generating a key in a secure element
7723 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7724 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 if (slot->key.data == NULL) {
7726 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7727 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007728 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 attributes->core.type, attributes->core.bits);
7730 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007731 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007732 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007733
7734 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 attributes->core.type,
7736 attributes->core.bits);
7737 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007738 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007739 attributes, &key_buffer_size);
7740 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007741 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007742 }
Ronald Cron977c2472020-10-13 08:32:21 +02007743 }
Ronald Cron977c2472020-10-13 08:32:21 +02007744
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7746 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007747 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007748 }
Ronald Cron977c2472020-10-13 08:32:21 +02007749 }
7750
Gilles Peskine449bd832023-01-11 14:50:10 +01007751 status = psa_driver_wrapper_generate_key(attributes,
7752 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007753
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 if (status != PSA_SUCCESS) {
7755 psa_remove_key_data_from_memory(slot);
7756 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007757
Gilles Peskine11792082019-08-06 18:36:36 +02007758exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007759 if (status == PSA_SUCCESS) {
7760 status = psa_finish_key_creation(slot, driver, key);
7761 }
7762 if (status != PSA_SUCCESS) {
7763 psa_fail_key_creation(slot, driver);
7764 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007765
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007767}
7768
Gilles Peskinee59236f2018-01-27 23:32:46 +01007769/****************************************************************/
7770/* Module setup */
7771/****************************************************************/
7772
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007773#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007774psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 void (* entropy_init)(mbedtls_entropy_context *ctx),
7776 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007777{
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7779 return PSA_ERROR_BAD_STATE;
7780 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007781 global_data.rng.entropy_init = entropy_init;
7782 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007784}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007785#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007786
Gilles Peskine449bd832023-01-11 14:50:10 +01007787void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007788{
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007790 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7791 mbedtls_psa_random_free(&global_data.rng);
7792 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007793 /* Wipe all remaining data, including configuration.
7794 * In particular, this sets all state indicator to the value
7795 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007797
7798 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007800}
7801
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007802#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7803/** Recover a transaction that was interrupted by a power failure.
7804 *
7805 * This function is called during initialization, before psa_crypto_init()
7806 * returns. If this function returns a failure status, the initialization
7807 * fails.
7808 */
7809static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007811{
Gilles Peskine449bd832023-01-11 14:50:10 +01007812 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007813 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7814 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 /* TODO - fall through to the failure case until this
7816 * is implemented.
7817 * https://github.com/ARMmbed/mbed-crypto/issues/218
7818 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007819 default:
7820 /* We found an unsupported transaction in the storage.
7821 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007822 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007823 }
7824}
7825#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7826
Gilles Peskine449bd832023-01-11 14:50:10 +01007827psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007828{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007829 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007830
Gilles Peskinec6b69072018-11-20 21:42:52 +01007831 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 if (global_data.initialized != 0) {
7833 return PSA_SUCCESS;
7834 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007835
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007836 /* Init drivers */
7837 status = psa_driver_wrapper_init();
7838 if (status != PSA_SUCCESS) {
7839 goto exit;
7840 }
7841 global_data.drivers_initialized = 1;
7842
Valerio Setti402cfba2023-11-13 10:24:32 +01007843 status = psa_initialize_key_slots();
7844 if (status != PSA_SUCCESS) {
7845 goto exit;
7846 }
7847
Gilles Peskine30524eb2020-11-13 17:02:26 +01007848 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007850 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 status = mbedtls_psa_random_seed(&global_data.rng);
7852 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007853 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007854 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007855 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007856
Gilles Peskine4b734222019-07-24 15:56:31 +02007857#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 status = psa_crypto_load_transaction();
7859 if (status == PSA_SUCCESS) {
7860 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7861 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007862 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 }
7864 status = psa_crypto_stop_transaction();
7865 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007866 /* There's no transaction to complete. It's all good. */
7867 status = PSA_SUCCESS;
7868 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007869#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007870
Gilles Peskinec6b69072018-11-20 21:42:52 +01007871 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007872 global_data.initialized = 1;
7873
7874exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007875 if (status != PSA_SUCCESS) {
7876 mbedtls_psa_crypto_free();
7877 }
7878 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007879}
7880
Yanray Wangffc3c482023-07-11 12:01:04 +08007881#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007882psa_status_t psa_crypto_driver_pake_get_password_len(
7883 const psa_crypto_driver_pake_inputs_t *inputs,
7884 size_t *password_len)
7885{
7886 if (inputs->password_len == 0) {
7887 return PSA_ERROR_BAD_STATE;
7888 }
7889
7890 *password_len = inputs->password_len;
7891
7892 return PSA_SUCCESS;
7893}
7894
7895psa_status_t psa_crypto_driver_pake_get_password(
7896 const psa_crypto_driver_pake_inputs_t *inputs,
7897 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7898{
7899 if (inputs->password_len == 0) {
7900 return PSA_ERROR_BAD_STATE;
7901 }
7902
7903 if (buffer_size < inputs->password_len) {
7904 return PSA_ERROR_BUFFER_TOO_SMALL;
7905 }
7906
7907 memcpy(buffer, inputs->password, inputs->password_len);
7908 *buffer_length = inputs->password_len;
7909
7910 return PSA_SUCCESS;
7911}
7912
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007913psa_status_t psa_crypto_driver_pake_get_user_len(
7914 const psa_crypto_driver_pake_inputs_t *inputs,
7915 size_t *user_len)
7916{
7917 if (inputs->user_len == 0) {
7918 return PSA_ERROR_BAD_STATE;
7919 }
7920
7921 *user_len = inputs->user_len;
7922
7923 return PSA_SUCCESS;
7924}
7925
7926psa_status_t psa_crypto_driver_pake_get_user(
7927 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007928 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007929{
7930 if (inputs->user_len == 0) {
7931 return PSA_ERROR_BAD_STATE;
7932 }
7933
Przemek Stekielc0e62502023-03-14 11:49:36 +01007934 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007935 return PSA_ERROR_BUFFER_TOO_SMALL;
7936 }
7937
Przemek Stekielc0e62502023-03-14 11:49:36 +01007938 memcpy(user_id, inputs->user, inputs->user_len);
7939 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007940
7941 return PSA_SUCCESS;
7942}
7943
7944psa_status_t psa_crypto_driver_pake_get_peer_len(
7945 const psa_crypto_driver_pake_inputs_t *inputs,
7946 size_t *peer_len)
7947{
7948 if (inputs->peer_len == 0) {
7949 return PSA_ERROR_BAD_STATE;
7950 }
7951
7952 *peer_len = inputs->peer_len;
7953
7954 return PSA_SUCCESS;
7955}
7956
7957psa_status_t psa_crypto_driver_pake_get_peer(
7958 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007959 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007960{
7961 if (inputs->peer_len == 0) {
7962 return PSA_ERROR_BAD_STATE;
7963 }
7964
Przemek Stekielc0e62502023-03-14 11:49:36 +01007965 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007966 return PSA_ERROR_BUFFER_TOO_SMALL;
7967 }
7968
Przemek Stekielc0e62502023-03-14 11:49:36 +01007969 memcpy(peer_id, inputs->peer, inputs->peer_len);
7970 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007971
7972 return PSA_SUCCESS;
7973}
7974
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007975psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7976 const psa_crypto_driver_pake_inputs_t *inputs,
7977 psa_pake_cipher_suite_t *cipher_suite)
7978{
7979 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7980 return PSA_ERROR_BAD_STATE;
7981 }
7982
7983 *cipher_suite = inputs->cipher_suite;
7984
7985 return PSA_SUCCESS;
7986}
7987
Neil Armstronga7d08c32022-06-01 18:21:20 +02007988psa_status_t psa_pake_setup(
7989 psa_pake_operation_t *operation,
7990 const psa_pake_cipher_suite_t *cipher_suite)
7991{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007992 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007993
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007994 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007995 status = PSA_ERROR_BAD_STATE;
7996 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007997 }
7998
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007999 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008000 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008001 status = PSA_ERROR_INVALID_ARGUMENT;
8002 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008003 }
8004
Przemek Stekiel51eac532022-12-07 11:04:51 +01008005 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8006
Przemek Stekiele12ed362022-12-21 12:54:46 +01008007 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008008 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8009 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008010 operation->data.inputs.cipher_suite = *cipher_suite;
8011
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008012#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008013 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008014 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008015 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008016
David Horstmann16f01512023-06-14 17:21:07 +01008017 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008018 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008019 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008020#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008021 {
8022 status = PSA_ERROR_NOT_SUPPORTED;
8023 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008024 }
8025
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008026 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8027
Przemek Stekiel51eac532022-12-07 11:04:51 +01008028 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008029exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008030 psa_pake_abort(operation);
8031 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008032}
8033
8034psa_status_t psa_pake_set_password_key(
8035 psa_pake_operation_t *operation,
8036 mbedtls_svc_key_id_t password)
8037{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008038 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008039 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8040 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008041 psa_key_attributes_t attributes;
8042 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008043
Przemek Stekiel51eac532022-12-07 11:04:51 +01008044 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008045 status = PSA_ERROR_BAD_STATE;
8046 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008047 }
8048
Przemek Stekiel6c764412022-11-22 14:05:12 +01008049 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8050 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008051 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008052 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008053 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008054 }
8055
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008056 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008057 .core = slot->attr
8058 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008059
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008060 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008061
Przemek Stekiel51eac532022-12-07 11:04:51 +01008062 if (type != PSA_KEY_TYPE_PASSWORD &&
8063 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8064 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008065 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008066 }
8067
Przemek Stekiel51eac532022-12-07 11:04:51 +01008068 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8069 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008070 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008071 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008072 }
8073
8074 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8075 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008076 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008077exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008078 if (status != PSA_SUCCESS) {
8079 psa_pake_abort(operation);
8080 }
Ryan Everett1b70a072024-01-04 10:32:49 +00008081 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008082 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008083}
8084
8085psa_status_t psa_pake_set_user(
8086 psa_pake_operation_t *operation,
8087 const uint8_t *user_id,
8088 size_t user_id_len)
8089{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008090 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008091
8092 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008093 status = PSA_ERROR_BAD_STATE;
8094 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008095 }
8096
Przemek Stekiel51eac532022-12-07 11:04:51 +01008097 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008098 status = PSA_ERROR_INVALID_ARGUMENT;
8099 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008100 }
8101
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008102 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008103 status = PSA_ERROR_BAD_STATE;
8104 goto exit;
8105 }
8106
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008107 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8108 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008109 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8110 goto exit;
8111 }
8112
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008113 memcpy(operation->data.inputs.user, user_id, user_id_len);
8114 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008115
8116 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008117exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008118 psa_pake_abort(operation);
8119 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008120}
8121
8122psa_status_t psa_pake_set_peer(
8123 psa_pake_operation_t *operation,
8124 const uint8_t *peer_id,
8125 size_t peer_id_len)
8126{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008127 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008128
8129 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008130 status = PSA_ERROR_BAD_STATE;
8131 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008132 }
8133
Przemek Stekiel51eac532022-12-07 11:04:51 +01008134 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008135 status = PSA_ERROR_INVALID_ARGUMENT;
8136 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008137 }
8138
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008139 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008140 status = PSA_ERROR_BAD_STATE;
8141 goto exit;
8142 }
8143
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008144 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8145 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008146 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8147 goto exit;
8148 }
8149
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008150 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8151 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008152
8153 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008154exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008155 psa_pake_abort(operation);
8156 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008157}
8158
8159psa_status_t psa_pake_set_role(
8160 psa_pake_operation_t *operation,
8161 psa_pake_role_t role)
8162{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008163 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008164
Przemek Stekiel51eac532022-12-07 11:04:51 +01008165 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008166 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008167 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008168 }
8169
Przemek Stekiel09104b82023-03-06 14:11:51 +01008170 switch (operation->alg) {
8171#if defined(PSA_WANT_ALG_JPAKE)
8172 case PSA_ALG_JPAKE:
8173 if (role == PSA_PAKE_ROLE_NONE) {
8174 return PSA_SUCCESS;
8175 }
8176 status = PSA_ERROR_INVALID_ARGUMENT;
8177 break;
8178#endif
8179 default:
8180 (void) role;
8181 status = PSA_ERROR_NOT_SUPPORTED;
8182 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008183 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008184exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008185 psa_pake_abort(operation);
8186 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008187}
8188
David Horstmanne7f21e62023-05-12 18:17:21 +01008189/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008190#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008191static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008192 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008193{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008194 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008195 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008196 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008197
David Horstmann024e5c52023-06-14 15:48:21 +01008198 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008199 is_x1 = (stage->outputs < 1);
8200 } else {
8201 is_x1 = (stage->inputs < 1);
8202 }
8203
David Horstmann74a3d8c2023-06-14 18:28:19 +01008204 key_share_step = is_x1 ?
8205 PSA_JPAKE_X1_STEP_KEY_SHARE :
8206 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008207 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008208 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8209 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8210 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8211 } else {
8212 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008213 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008214 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008215}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008216#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008217
Przemek Stekiel2797d372022-12-22 11:19:22 +01008218static psa_status_t psa_pake_complete_inputs(
8219 psa_pake_operation_t *operation)
8220{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008222 /* Create copy of the inputs on stack as inputs share memory
8223 with the driver context which will be setup by the driver. */
8224 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008225
Przemek Stekielfde11282023-03-13 16:06:09 +01008226 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008227 return PSA_ERROR_BAD_STATE;
8228 }
8229
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008230 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008231 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8232 return PSA_ERROR_BAD_STATE;
8233 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008234 }
8235
Przemek Stekiel18620a32023-01-17 16:34:52 +01008236 /* Clear driver context */
8237 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8238
8239 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008240
8241 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008242 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008243
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008244 /* User and peer are translated to role. */
8245 mbedtls_free(inputs.user);
8246 mbedtls_free(inputs.peer);
8247
Przemek Stekiel2797d372022-12-22 11:19:22 +01008248 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008249#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008250 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008251 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008252 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008253#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008254 {
8255 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008256 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008257 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008258 return status;
8259}
8260
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008261#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008262static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008263 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008264 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008265 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008266{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008267 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8268 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8269 step != PSA_PAKE_STEP_ZK_PROOF) {
8270 return PSA_ERROR_INVALID_ARGUMENT;
8271 }
8272
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008273 psa_jpake_computation_stage_t *computation_stage =
8274 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008275
David Horstmann5da95602023-06-08 15:37:12 +01008276 if (computation_stage->round != PSA_JPAKE_FIRST &&
8277 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008278 return PSA_ERROR_BAD_STATE;
8279 }
8280
David Horstmanne7f21e62023-05-12 18:17:21 +01008281 /* Check that the step we are given is the one we were expecting */
8282 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008283 return PSA_ERROR_BAD_STATE;
8284 }
8285
David Horstmanne7f21e62023-05-12 18:17:21 +01008286 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8287 computation_stage->inputs == 0 &&
8288 computation_stage->outputs == 0) {
8289 /* Start of the round, so function decides whether we are inputting
8290 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008291 computation_stage->io_mode = io_mode;
8292 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008293 /* Middle of the round so the mode we are in must match the function
8294 * called by the user */
8295 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008296 }
8297
8298 return PSA_SUCCESS;
8299}
8300
David Horstmanne7f21e62023-05-12 18:17:21 +01008301static psa_status_t psa_jpake_epilogue(
8302 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008303 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008304{
David Horstmanne7f21e62023-05-12 18:17:21 +01008305 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008306 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008307
David Horstmanne7f21e62023-05-12 18:17:21 +01008308 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8309 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008310 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008311 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008312 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008313 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008314 }
8315 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008316 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008317 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008318 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008319 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008320 }
8321 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008322 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8323 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008324 /* End of a round, move to the next round */
8325 stage->inputs = 0;
8326 stage->outputs = 0;
8327 stage->round++;
8328 }
8329 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008330 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008331 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008332 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008333 return PSA_SUCCESS;
8334}
David Horstmanne7f21e62023-05-12 18:17:21 +01008335
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008336#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008337
Neil Armstronga7d08c32022-06-01 18:21:20 +02008338psa_status_t psa_pake_output(
8339 psa_pake_operation_t *operation,
8340 psa_pake_step_t step,
8341 uint8_t *output,
8342 size_t output_size,
8343 size_t *output_length)
8344{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008345 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008346 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008347 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008348
8349 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008350 status = psa_pake_complete_inputs(operation);
8351 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008352 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008353 }
8354 }
8355
8356 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008357 status = PSA_ERROR_BAD_STATE;
8358 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008359 }
8360
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008361 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008362 status = PSA_ERROR_INVALID_ARGUMENT;
8363 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008364 }
8365
Przemek Stekiele12ed362022-12-21 12:54:46 +01008366 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008367#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008368 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008369 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008370 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008371 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008372 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008373 driver_step = convert_jpake_computation_stage_to_driver_step(
8374 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008375 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008376#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008377 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008378 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008379 status = PSA_ERROR_NOT_SUPPORTED;
8380 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008381 }
8382
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008383 status = psa_driver_wrapper_pake_output(operation, driver_step,
8384 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008385
8386 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008387 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008388 }
8389
8390 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008391#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008392 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008393 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008394 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008395 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008396 }
8397 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008398#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008399 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008400 status = PSA_ERROR_NOT_SUPPORTED;
8401 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008402 }
8403
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008404 return PSA_SUCCESS;
8405exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008406 psa_pake_abort(operation);
8407 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008408}
8409
8410psa_status_t psa_pake_input(
8411 psa_pake_operation_t *operation,
8412 psa_pake_step_t step,
8413 const uint8_t *input,
8414 size_t input_length)
8415{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008416 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008417 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008418 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8419 operation->primitive,
8420 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008421
8422 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008423 status = psa_pake_complete_inputs(operation);
8424 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008425 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008426 }
8427 }
8428
8429 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008430 status = PSA_ERROR_BAD_STATE;
8431 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008432 }
8433
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008434 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008435 status = PSA_ERROR_INVALID_ARGUMENT;
8436 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008437 }
8438
Przemek Stekiele12ed362022-12-21 12:54:46 +01008439 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008440#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008441 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008442 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008443 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008444 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008445 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008446 driver_step = convert_jpake_computation_stage_to_driver_step(
8447 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008448 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008449#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008450 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008451 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008452 status = PSA_ERROR_NOT_SUPPORTED;
8453 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008454 }
8455
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008456 status = psa_driver_wrapper_pake_input(operation, driver_step,
8457 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008458
8459 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008460 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008461 }
8462
8463 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008464#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008465 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008466 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008467 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008468 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008469 }
8470 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008471#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008472 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008473 status = PSA_ERROR_NOT_SUPPORTED;
8474 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008475 }
8476
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008477 return PSA_SUCCESS;
8478exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008479 psa_pake_abort(operation);
8480 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008481}
8482
8483psa_status_t psa_pake_get_implicit_key(
8484 psa_pake_operation_t *operation,
8485 psa_key_derivation_operation_t *output)
8486{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008487 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008488 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008489 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008490 size_t shared_key_len = 0;
8491
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008492 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008493 status = PSA_ERROR_BAD_STATE;
8494 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008495 }
8496
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008497#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008498 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008499 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008500 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008501 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008502 status = PSA_ERROR_BAD_STATE;
8503 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008504 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008505 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008506#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008507 {
8508 status = PSA_ERROR_NOT_SUPPORTED;
8509 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008510 }
8511
Przemek Stekiel0c781802022-11-29 14:53:13 +01008512 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8513 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008514 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008515 &shared_key_len);
8516
8517 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008518 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008519 }
8520
8521 status = psa_key_derivation_input_bytes(output,
8522 PSA_KEY_DERIVATION_INPUT_SECRET,
8523 shared_key,
8524 shared_key_len);
8525
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008526 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008527exit:
8528 abort_status = psa_pake_abort(operation);
8529 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008530}
8531
8532psa_status_t psa_pake_abort(
8533 psa_pake_operation_t *operation)
8534{
Przemek Stekield69dca92023-01-31 19:59:20 +01008535 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008536
Przemek Stekield69dca92023-01-31 19:59:20 +01008537 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008538 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008539 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008540
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008541 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8542 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008543 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008544 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008545 }
8546 if (operation->data.inputs.user != NULL) {
8547 mbedtls_free(operation->data.inputs.user);
8548 }
8549 if (operation->data.inputs.peer != NULL) {
8550 mbedtls_free(operation->data.inputs.peer);
8551 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008552 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008553 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008554
Przemek Stekield69dca92023-01-31 19:59:20 +01008555 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008556}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008557#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008558
David Horstmann00d7a042023-12-07 18:39:17 +00008559/* Memory copying test hooks. These are called before input copy, after input
8560 * copy, before output copy and after output copy, respectively.
8561 * They are used by memory-poisoning tests to temporarily unpoison buffers
8562 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008563#if defined(MBEDTLS_TEST_HOOKS)
8564void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8565void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8566void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8567void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8568#endif
David Horstmannfde97392023-10-30 20:29:43 +00008569
David Horstmann1b7279a2023-11-15 15:18:30 +00008570/** Copy from an input buffer to a local copy.
8571 *
8572 * \param[in] input Pointer to input buffer.
8573 * \param[in] input_len Length of the input buffer.
8574 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8575 * \param[out] input_copy_len Length of the local copy buffer.
8576 * \return #PSA_SUCCESS, if the buffer was successfully
8577 * copied.
8578 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8579 * copy is too small to hold contents of the
8580 * input buffer.
8581 */
8582MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008583psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8584 uint8_t *input_copy, size_t input_copy_len)
8585{
8586 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008587 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008588 }
8589
David Horstmann372b8bb2023-11-24 16:21:04 +00008590#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008591 if (psa_input_pre_copy_hook != NULL) {
8592 psa_input_pre_copy_hook(input, input_len);
8593 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008594#endif
8595
David Horstmann777e7412023-11-15 17:33:47 +00008596 if (input_len > 0) {
8597 memcpy(input_copy, input, input_len);
8598 }
David Horstmannfde97392023-10-30 20:29:43 +00008599
David Horstmann372b8bb2023-11-24 16:21:04 +00008600#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008601 if (psa_input_post_copy_hook != NULL) {
8602 psa_input_post_copy_hook(input, input_len);
8603 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008604#endif
8605
David Horstmannfde97392023-10-30 20:29:43 +00008606 return PSA_SUCCESS;
8607}
8608
David Horstmann1b7279a2023-11-15 15:18:30 +00008609/** Copy from a local output buffer into a user-supplied one.
8610 *
8611 * \param[in] output_copy Pointer to a local buffer containing the output.
8612 * \param[in] output_copy_len Length of the local buffer.
8613 * \param[out] output Pointer to user-supplied output buffer.
8614 * \param[out] output_len Length of the user-supplied output buffer.
8615 * \return #PSA_SUCCESS, if the buffer was successfully
8616 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008617 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008618 * user-supplied output buffer is too small to
8619 * hold the contents of the local buffer.
8620 */
8621MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008622psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8623 uint8_t *output, size_t output_len)
8624{
8625 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008626 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008627 }
David Horstmann777e7412023-11-15 17:33:47 +00008628
David Horstmann372b8bb2023-11-24 16:21:04 +00008629#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008630 if (psa_output_pre_copy_hook != NULL) {
8631 psa_output_pre_copy_hook(output, output_len);
8632 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008633#endif
8634
David Horstmann777e7412023-11-15 17:33:47 +00008635 if (output_copy_len > 0) {
8636 memcpy(output, output_copy, output_copy_len);
8637 }
8638
David Horstmann372b8bb2023-11-24 16:21:04 +00008639#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008640 if (psa_output_post_copy_hook != NULL) {
8641 psa_output_post_copy_hook(output, output_len);
8642 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008643#endif
8644
David Horstmann8978f5c2023-10-30 20:37:12 +00008645 return PSA_SUCCESS;
8646}
8647
David Horstmannf1734052023-11-20 17:15:32 +00008648psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8649 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008650{
8651 psa_status_t status;
8652
David Horstmann9db14482023-11-23 15:50:37 +00008653 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008654
David Horstmannc5cc1c32023-11-15 18:11:26 +00008655 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008656 return PSA_SUCCESS;
8657 }
8658
David Horstmannf1734052023-11-20 17:15:32 +00008659 local_input->buffer = mbedtls_calloc(input_len, 1);
8660 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008661 /* Since we dealt with the zero-length case above, we know that
8662 * a NULL return value means a failure of allocation. */
8663 return PSA_ERROR_INSUFFICIENT_MEMORY;
8664 }
David Horstmannf1734052023-11-20 17:15:32 +00008665 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008666
David Horstmannf1734052023-11-20 17:15:32 +00008667 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008668
8669 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008670 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008671 if (status != PSA_SUCCESS) {
8672 goto error;
8673 }
8674
8675 return PSA_SUCCESS;
8676
8677error:
David Horstmannf1734052023-11-20 17:15:32 +00008678 mbedtls_free(local_input->buffer);
8679 local_input->buffer = NULL;
8680 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008681 return status;
8682}
8683
David Horstmannf1734052023-11-20 17:15:32 +00008684void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008685{
David Horstmannf1734052023-11-20 17:15:32 +00008686 mbedtls_free(local_input->buffer);
8687 local_input->buffer = NULL;
8688 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008689}
8690
David Horstmann89875a42023-11-20 12:54:09 +00008691psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8692 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008693{
David Horstmann9db14482023-11-23 15:50:37 +00008694 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008695
David Horstmannc5cc1c32023-11-15 18:11:26 +00008696 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008697 return PSA_SUCCESS;
8698 }
David Horstmann89875a42023-11-20 12:54:09 +00008699 local_output->buffer = mbedtls_calloc(output_len, 1);
8700 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008701 /* Since we dealt with the zero-length case above, we know that
8702 * a NULL return value means a failure of allocation. */
8703 return PSA_ERROR_INSUFFICIENT_MEMORY;
8704 }
David Horstmann89875a42023-11-20 12:54:09 +00008705 local_output->length = output_len;
8706 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008707
8708 return PSA_SUCCESS;
8709}
8710
Gabor Mezei1882c512024-01-24 13:07:17 +01008711psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8712 psa_crypto_local_output_t *local_output)
8713{
8714 psa_status_t status;
8715 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8716
8717 if (output_len == 0) {
8718 return PSA_SUCCESS;
8719 }
8720 local_output->buffer = mbedtls_calloc(output_len, 1);
8721 if (local_output->buffer == NULL) {
8722 /* Since we dealt with the zero-length case above, we know that
8723 * a NULL return value means a failure of allocation. */
8724 return PSA_ERROR_INSUFFICIENT_MEMORY;
8725 }
8726 local_output->length = output_len;
8727 local_output->original = output;
8728
8729 status = psa_crypto_copy_input(output, output_len,
8730 local_output->buffer, local_output->length);
8731 if (status != PSA_SUCCESS) {
8732 goto error;
8733 }
8734
8735 return PSA_SUCCESS;
8736
8737error:
8738 mbedtls_free(local_output->buffer);
8739 local_output->buffer = NULL;
8740 local_output->length = 0;
8741 return status;
8742}
8743
David Horstmann89875a42023-11-20 12:54:09 +00008744psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008745{
David Horstmannc335a4e2023-11-15 15:57:32 +00008746 psa_status_t status;
8747
David Horstmann89875a42023-11-20 12:54:09 +00008748 if (local_output->buffer == NULL) {
8749 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008750 return PSA_SUCCESS;
8751 }
David Horstmann89875a42023-11-20 12:54:09 +00008752 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008753 /* We have an internal copy but nothing to copy back to. */
8754 return PSA_ERROR_CORRUPTION_DETECTED;
8755 }
8756
David Horstmann89875a42023-11-20 12:54:09 +00008757 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8758 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008759 if (status != PSA_SUCCESS) {
8760 return status;
8761 }
David Horstmann9467ea32023-11-08 17:44:18 +00008762
David Horstmann89875a42023-11-20 12:54:09 +00008763 mbedtls_free(local_output->buffer);
8764 local_output->buffer = NULL;
8765 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008766
8767 return PSA_SUCCESS;
8768}
8769
Gilles Peskinee59236f2018-01-27 23:32:46 +01008770#endif /* MBEDTLS_PSA_CRYPTO_C */