blob: bd67887e321dad5c49dc2b94bdb9ec949f905ae6 [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,
2369 const uint8_t *input,
2370 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;
2373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002375 status = PSA_ERROR_BAD_STATE;
2376 goto exit;
2377 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002378
Steven Cooremanc8288352021-03-04 14:02:19 +01002379 /* Don't require hash implementations to behave correctly on a
2380 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 if (input_length == 0) {
2382 return PSA_SUCCESS;
2383 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002384
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002386
2387exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 if (status != PSA_SUCCESS) {
2389 psa_hash_abort(operation);
2390 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002391
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002393}
2394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2396 uint8_t *hash,
2397 size_t hash_size,
2398 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002399{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002400 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 if (operation->id == 0) {
2402 return PSA_ERROR_BAD_STATE;
2403 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002404
Steven Cooreman1e582352021-02-18 17:24:37 +01002405 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 operation, hash, hash_size, hash_length);
2407 psa_hash_abort(operation);
2408 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002409}
2410
Gilles Peskine449bd832023-01-11 14:50:10 +01002411psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2412 const uint8_t *hash,
2413 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002414{
Ronald Cron69a63422021-10-18 09:47:58 +02002415 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002416 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002417 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 operation,
2419 actual_hash, sizeof(actual_hash),
2420 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002421
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002423 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002427 status = PSA_ERROR_INVALID_SIGNATURE;
2428 goto exit;
2429 }
2430
Dave Rodgman78701152023-08-29 14:20:18 +01002431 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002432 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002434
2435exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2437 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002438 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002440
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002442}
2443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444psa_status_t psa_hash_compute(psa_algorithm_t alg,
2445 const uint8_t *input, size_t input_length,
2446 uint8_t *hash, size_t hash_size,
2447 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002448{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002449 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 if (!PSA_ALG_IS_HASH(alg)) {
2451 return PSA_ERROR_INVALID_ARGUMENT;
2452 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2455 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002456}
2457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458psa_status_t psa_hash_compare(psa_algorithm_t alg,
2459 const uint8_t *input, size_t input_length,
2460 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002461{
Ronald Cron69a63422021-10-18 09:47:58 +02002462 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002463 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 if (!PSA_ALG_IS_HASH(alg)) {
2466 return PSA_ERROR_INVALID_ARGUMENT;
2467 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002468
Steven Cooreman1e582352021-02-18 17:24:37 +01002469 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 alg, input, input_length,
2471 actual_hash, sizeof(actual_hash),
2472 &actual_hash_length);
2473 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002474 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 }
2476 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002477 status = PSA_ERROR_INVALID_SIGNATURE;
2478 goto exit;
2479 }
Dave Rodgman78701152023-08-29 14:20:18 +01002480 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002481 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002483
2484exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2486 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002487}
2488
Gilles Peskine449bd832023-01-11 14:50:10 +01002489psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2490 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002491{
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 if (source_operation->id == 0 ||
2493 target_operation->id != 0) {
2494 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002495 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002496
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2498 target_operation);
2499 if (status != PSA_SUCCESS) {
2500 psa_hash_abort(target_operation);
2501 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002502
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002504}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002505
2506
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002507/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002508/* MAC */
2509/****************************************************************/
2510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002512{
Steven Cooremane6804192021-03-19 18:28:56 +01002513 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 if (operation->id == 0) {
2515 return PSA_SUCCESS;
2516 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002517
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002519 operation->mac_size = 0;
2520 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002521 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002522
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002524}
2525
Ronald Cron2dff3b22021-06-17 16:33:22 +02002526static psa_status_t psa_mac_finalize_alg_and_key_validation(
2527 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002528 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002530{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002531 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 psa_key_type_t key_type = psa_get_key_type(attributes);
2533 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 if (!PSA_ALG_IS_MAC(alg)) {
2536 return PSA_ERROR_INVALID_ARGUMENT;
2537 }
Steven Cooremane6804192021-03-19 18:28:56 +01002538
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002539 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 status = psa_mac_key_can_do(alg, key_type);
2541 if (status != PSA_SUCCESS) {
2542 return status;
2543 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002544
Steven Cooremand1a68f12021-05-10 11:13:41 +02002545 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002549 /* A very short MAC is too short for security since it can be
2550 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2551 * so we make this our minimum, even though 32 bits is still
2552 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002554 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2557 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002558 /* It's impossible to "truncate" to a larger length than the full length
2559 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002561 }
2562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002564 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2565 * that is disabled in the compile-time configuration. The result can
2566 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2567 * configuration into account. In this case, force a return of
2568 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2569 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2570 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2571 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2572 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002574 }
2575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002577}
2578
Gilles Peskine449bd832023-01-11 14:50:10 +01002579static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2580 mbedtls_svc_key_id_t key,
2581 psa_algorithm_t alg,
2582 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002583{
2584 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2585 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002586 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002587 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002588
2589 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002591 status = PSA_ERROR_BAD_STATE;
2592 goto exit;
2593 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002594
2595 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 key,
2597 &slot,
2598 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2599 alg);
2600 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002601 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002603
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002604 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002605 .core = slot->attr
2606 };
2607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2609 &operation->mac_size);
2610 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002611 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002613
2614 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002615 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (is_sign) {
2617 status = psa_driver_wrapper_mac_sign_setup(operation,
2618 &attributes,
2619 slot->key.data,
2620 slot->key.bytes,
2621 alg);
2622 } else {
2623 status = psa_driver_wrapper_mac_verify_setup(operation,
2624 &attributes,
2625 slot->key.data,
2626 slot->key.bytes,
2627 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002628 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002629
Gilles Peskinefbfac682018-07-08 20:51:54 +02002630exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 if (status != PSA_SUCCESS) {
2632 psa_mac_abort(operation);
2633 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002634
Ryan Everett1b70a072024-01-04 10:32:49 +00002635 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002638}
2639
Gilles Peskine449bd832023-01-11 14:50:10 +01002640psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2641 mbedtls_svc_key_id_t key,
2642 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002643{
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002645}
2646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2648 mbedtls_svc_key_id_t key,
2649 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002650{
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002652}
2653
Gilles Peskine449bd832023-01-11 14:50:10 +01002654psa_status_t psa_mac_update(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002655 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002657{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002658 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2659 LOCAL_INPUT_DECLARE(input_external, input);
2660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if (operation->id == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002662 status = PSA_ERROR_BAD_STATE;
2663 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002665
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002666 /* Don't require hash implementations to behave correctly on a
2667 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 if (input_length == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002669 status = PSA_SUCCESS;
2670 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002672
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002673 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2674 status = psa_driver_wrapper_mac_update(operation, input, input_length);
2675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 if (status != PSA_SUCCESS) {
2677 psa_mac_abort(operation);
2678 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002679
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002680exit:
2681 LOCAL_INPUT_FREE(input_external, input);
2682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002684}
2685
Gilles Peskine449bd832023-01-11 14:50:10 +01002686psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002687 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 size_t mac_size,
2689 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002690{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002691 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2692 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002693 LOCAL_OUTPUT_DECLARE(mac_external, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002694
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002696 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002697 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002698 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002701 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002702 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002703 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002704
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002705 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2706 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002708 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002709 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002710 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002713 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002714 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002715 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002716
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002717 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 status = psa_driver_wrapper_mac_sign_finish(operation,
2719 mac, operation->mac_size,
2720 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002721
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002722exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002723 /* In case of success, set the potential excess room in the output buffer
2724 * to an invalid value, to avoid potentially leaking a longer MAC.
2725 * In case of error, set the output length and content to a safe default,
2726 * such that in case the caller misses an error check, the output would be
2727 * an unachievable MAC.
2728 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002730 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002731 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002732 }
mohammad16036df908f2018-04-02 08:34:15 -07002733
Paul Elliottdc42ca82023-02-24 18:11:59 +00002734 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002735
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002737 LOCAL_OUTPUT_FREE(mac_external, mac);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002738
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002740}
2741
Gilles Peskine449bd832023-01-11 14:50:10 +01002742psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002743 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002745{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002746 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2747 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002748 LOCAL_INPUT_DECLARE(mac_external, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002749
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002751 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002752 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002753 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002754
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002756 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002757 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002758 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002759
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002761 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002762 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002763 }
2764
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002765 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 status = psa_driver_wrapper_mac_verify_finish(operation,
2767 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002768
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002769exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002771 LOCAL_INPUT_FREE(mac_external, mac);
mohammad16036df908f2018-04-02 08:34:15 -07002772
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002774}
2775
Gilles Peskine449bd832023-01-11 14:50:10 +01002776static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2777 psa_algorithm_t alg,
2778 const uint8_t *input,
2779 size_t input_length,
2780 uint8_t *mac,
2781 size_t mac_size,
2782 size_t *mac_length,
2783 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002784{
2785 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002786 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2787 psa_key_slot_t *slot;
2788 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002789 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002790
Ronald Cron51131b52021-06-17 17:17:20 +02002791 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 key,
2793 &slot,
2794 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2795 alg);
2796 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002797 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002799
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002800 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002801 .core = slot->attr
2802 };
2803
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2805 &operation_mac_size);
2806 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002807 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002809
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002811 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002812 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002813 }
2814
2815 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 &attributes,
2817 slot->key.data, slot->key.bytes,
2818 alg,
2819 input, input_length,
2820 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002821
2822exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002823 /* In case of success, set the potential excess room in the output buffer
2824 * to an invalid value, to avoid potentially leaking a longer MAC.
2825 * In case of error, set the output length and content to a safe default,
2826 * such that in case the caller misses an error check, the output would be
2827 * an unachievable MAC.
2828 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002830 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002831 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002832 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002833
2834 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002835
Ryan Everett1b70a072024-01-04 10:32:49 +00002836 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002839}
2840
Gilles Peskine449bd832023-01-11 14:50:10 +01002841psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002842 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002843 const uint8_t *input_external,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002844 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002845 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 size_t mac_size,
2847 size_t *mac_length)
2848{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002849 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2850 LOCAL_INPUT_DECLARE(input_external, input);
2851 LOCAL_OUTPUT_DECLARE(mac_external, mac);
2852
2853 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2854 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
2855 status = psa_mac_compute_internal(key, alg,
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 input, input_length,
2857 mac, mac_size, mac_length, 1);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002858exit:
2859 LOCAL_INPUT_FREE(input_external, input);
2860 LOCAL_OUTPUT_FREE(mac_external, mac);
2861
2862 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002863}
2864
2865psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2866 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002867 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002869 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002871{
2872 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002873 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2874 size_t actual_mac_length;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002875 LOCAL_INPUT_DECLARE(input_external, input);
2876 LOCAL_INPUT_DECLARE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002877
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002878 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 status = psa_mac_compute_internal(key, alg,
2880 input, input_length,
2881 actual_mac, sizeof(actual_mac),
2882 &actual_mac_length, 0);
2883 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002884 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002888 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002889 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002890 }
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002891
2892 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Dave Rodgman78701152023-08-29 14:20:18 +01002893 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002894 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002895 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002896 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002897
2898exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002900 LOCAL_INPUT_FREE(input_external, input);
2901 LOCAL_INPUT_FREE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002902
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002904}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002905
Gilles Peskinee59236f2018-01-27 23:32:46 +01002906/****************************************************************/
2907/* Asymmetric cryptography */
2908/****************************************************************/
2909
Gilles Peskine449bd832023-01-11 14:50:10 +01002910static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2911 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002912{
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 if (input_is_message) {
2914 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2915 return PSA_ERROR_INVALID_ARGUMENT;
2916 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2919 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2920 return PSA_ERROR_INVALID_ARGUMENT;
2921 }
2922 }
2923 } else {
2924 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2925 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002926 }
2927 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002928
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002930}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002931
Gilles Peskine449bd832023-01-11 14:50:10 +01002932static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2933 int input_is_message,
2934 psa_algorithm_t alg,
2935 const uint8_t *input,
2936 size_t input_length,
2937 uint8_t *signature,
2938 size_t signature_size,
2939 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002940{
2941 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2942 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2943 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002944 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002945
2946 *signature_length = 0;
2947
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 status = psa_sign_verify_check_alg(input_is_message, alg);
2949 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002950 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002952
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002953 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002954 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002955 * buffer can in principle be empty since it doesn't actually have
2956 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 if (signature_size == 0) {
2958 return PSA_ERROR_BUFFER_TOO_SMALL;
2959 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002960
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002961 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 key, &slot,
2963 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2964 PSA_KEY_USAGE_SIGN_HASH,
2965 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002966
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002968 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002972 status = PSA_ERROR_INVALID_ARGUMENT;
2973 goto exit;
2974 }
2975
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002976 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002978 };
2979
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002981 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002982 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002983 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 signature, signature_size, signature_length);
2985 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002986
2987 status = psa_driver_wrapper_sign_hash(
2988 &attributes, slot->key.data, slot->key.bytes,
2989 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002991 }
2992
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002993
2994exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002995 psa_wipe_tag_output_buffer(signature, status, signature_size,
2996 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002997
Ryan Everett1b70a072024-01-04 10:32:49 +00002998 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002999
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003001}
3002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3004 int input_is_message,
3005 psa_algorithm_t alg,
3006 const uint8_t *input,
3007 size_t input_length,
3008 const uint8_t *signature,
3009 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003010{
3011 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3012 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3013 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003014
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 status = psa_sign_verify_check_alg(input_is_message, alg);
3016 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003017 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003019
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003020 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 key, &slot,
3022 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3023 PSA_KEY_USAGE_VERIFY_HASH,
3024 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003025
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 if (status != PSA_SUCCESS) {
3027 return status;
3028 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003029
3030 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003032 };
3033
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003035 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003036 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003037 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 signature, signature_length);
3039 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003040 status = psa_driver_wrapper_verify_hash(
3041 &attributes, slot->key.data, slot->key.bytes,
3042 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003044 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003045
Ryan Everett1b70a072024-01-04 10:32:49 +00003046 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003047
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003049
3050}
3051
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003052psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003053 const psa_key_attributes_t *attributes,
3054 const uint8_t *key_buffer,
3055 size_t key_buffer_size,
3056 psa_algorithm_t alg,
3057 const uint8_t *input,
3058 size_t input_length,
3059 uint8_t *signature,
3060 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003062{
3063 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003064
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003066 size_t hash_length;
3067 uint8_t hash[PSA_HASH_MAX_SIZE];
3068
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003069 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 PSA_ALG_SIGN_GET_HASH(alg),
3071 input, input_length,
3072 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003073
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003075 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003076 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003077
3078 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 attributes, key_buffer, key_buffer_size,
3080 alg, hash, hash_length,
3081 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003082 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003083
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003085}
3086
Gilles Peskine449bd832023-01-11 14:50:10 +01003087psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3088 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003089 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003091 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 size_t signature_size,
3093 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003094{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003095 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3096 LOCAL_INPUT_DECLARE(input_external, input);
3097 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3098
3099 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3100 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3101 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3102 signature_size, signature_length);
3103
Thomas Daubney3e65f522024-01-30 12:37:25 +00003104#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003105exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003106#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003107 LOCAL_INPUT_FREE(input_external, input);
3108 LOCAL_OUTPUT_FREE(signature_external, signature);
3109 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003110}
3111
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003112psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003113 const psa_key_attributes_t *attributes,
3114 const uint8_t *key_buffer,
3115 size_t key_buffer_size,
3116 psa_algorithm_t alg,
3117 const uint8_t *input,
3118 size_t input_length,
3119 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003120 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003121{
3122 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003123
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003125 size_t hash_length;
3126 uint8_t hash[PSA_HASH_MAX_SIZE];
3127
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003128 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 PSA_ALG_SIGN_GET_HASH(alg),
3130 input, input_length,
3131 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003132
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003134 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003136
3137 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 attributes, key_buffer, key_buffer_size,
3139 alg, hash, hash_length,
3140 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003141 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003142
Gilles Peskine449bd832023-01-11 14:50:10 +01003143 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003144}
3145
Gilles Peskine449bd832023-01-11 14:50:10 +01003146psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3147 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003148 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003150 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003152{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003153 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3154 LOCAL_INPUT_DECLARE(input_external, input);
3155 LOCAL_INPUT_DECLARE(signature_external, signature);
3156
3157 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3158 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3159 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3160 signature_length);
3161
Thomas Daubney3e65f522024-01-30 12:37:25 +00003162#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003163exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003164#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003165 LOCAL_INPUT_FREE(input_external, input);
3166 LOCAL_INPUT_FREE(signature_external, signature);
3167
3168 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003169}
3170
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003171psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003172 const psa_key_attributes_t *attributes,
3173 const uint8_t *key_buffer, size_t key_buffer_size,
3174 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003176{
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3178 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3179 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003180#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003181 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3182 return mbedtls_psa_rsa_sign_hash(
3183 attributes,
3184 key_buffer, key_buffer_size,
3185 alg, hash, hash_length,
3186 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003187#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3188 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003189 } else {
3190 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003191 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3193 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003194#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003195 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3196 return mbedtls_psa_ecdsa_sign_hash(
3197 attributes,
3198 key_buffer, key_buffer_size,
3199 alg, hash, hash_length,
3200 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003201#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3202 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003203 } else {
3204 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003205 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003206 }
Ronald Cron4501c982021-03-19 20:09:32 +01003207
Gilles Peskine449bd832023-01-11 14:50:10 +01003208 (void) key_buffer;
3209 (void) key_buffer_size;
3210 (void) hash;
3211 (void) hash_length;
3212 (void) signature;
3213 (void) signature_size;
3214 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003217}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003218
Gilles Peskine449bd832023-01-11 14:50:10 +01003219psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3220 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003221 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003223 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003224 size_t signature_size,
3225 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003226{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003227 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3228 LOCAL_INPUT_DECLARE(hash_external, hash);
3229 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3230
3231 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3232 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3233 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3234 signature_size, signature_length);
3235
Thomas Daubney3e65f522024-01-30 12:37:25 +00003236#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003237exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003238#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003239 LOCAL_INPUT_FREE(hash_external, hash);
3240 LOCAL_OUTPUT_FREE(signature_external, signature);
3241
3242 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003243}
3244
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003245psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003246 const psa_key_attributes_t *attributes,
3247 const uint8_t *key_buffer, size_t key_buffer_size,
3248 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003249 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003250{
Gilles Peskine449bd832023-01-11 14:50:10 +01003251 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3252 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3253 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003254#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003255 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3256 return mbedtls_psa_rsa_verify_hash(
3257 attributes,
3258 key_buffer, key_buffer_size,
3259 alg, hash, hash_length,
3260 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003261#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3262 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 } else {
3264 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003265 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3267 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003268#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3270 return mbedtls_psa_ecdsa_verify_hash(
3271 attributes,
3272 key_buffer, key_buffer_size,
3273 alg, hash, hash_length,
3274 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003275#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3276 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003277 } else {
3278 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003279 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003280 }
Ronald Cron4501c982021-03-19 20:09:32 +01003281
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 (void) key_buffer;
3283 (void) key_buffer_size;
3284 (void) hash;
3285 (void) hash_length;
3286 (void) signature;
3287 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003288
Gilles Peskine449bd832023-01-11 14:50:10 +01003289 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003290}
3291
Gilles Peskine449bd832023-01-11 14:50:10 +01003292psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3293 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003294 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003295 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003296 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003298{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003299 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3300 LOCAL_INPUT_DECLARE(hash_external, hash);
3301 LOCAL_INPUT_DECLARE(signature_external, signature);
3302
3303 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3304 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3305 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3306 signature_length);
3307
Thomas Daubney3e65f522024-01-30 12:37:25 +00003308#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003309exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003310#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003311 LOCAL_INPUT_FREE(hash_external, hash);
3312 LOCAL_INPUT_FREE(signature_external, signature);
3313
3314 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003315}
3316
Gilles Peskine449bd832023-01-11 14:50:10 +01003317psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3318 psa_algorithm_t alg,
3319 const uint8_t *input,
3320 size_t input_length,
3321 const uint8_t *salt,
3322 size_t salt_length,
3323 uint8_t *output,
3324 size_t output_size,
3325 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003326{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003327 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003328 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003329 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003330 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003331
Darryl Green5cc689a2018-07-24 15:34:10 +01003332 (void) input;
3333 (void) input_length;
3334 (void) salt;
3335 (void) output;
3336 (void) output_size;
3337
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003338 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003339
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3341 return PSA_ERROR_INVALID_ARGUMENT;
3342 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003343
Valerio Setti5bb454a2024-01-15 10:43:16 +01003344 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003345 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3346 if (status != PSA_SUCCESS) {
3347 return status;
3348 }
3349 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3350 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003351 status = PSA_ERROR_INVALID_ARGUMENT;
3352 goto exit;
3353 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003354
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003355 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003357 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003358
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003359 status = psa_driver_wrapper_asymmetric_encrypt(
3360 &attributes, slot->key.data, slot->key.bytes,
3361 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003363exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003364 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003365
Gilles Peskine449bd832023-01-11 14:50:10 +01003366 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003367}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003368
Gilles Peskine449bd832023-01-11 14:50:10 +01003369psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3370 psa_algorithm_t alg,
3371 const uint8_t *input,
3372 size_t input_length,
3373 const uint8_t *salt,
3374 size_t salt_length,
3375 uint8_t *output,
3376 size_t output_size,
3377 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003378{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003379 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003380 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003381 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003382 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003383
Darryl Green5cc689a2018-07-24 15:34:10 +01003384 (void) input;
3385 (void) input_length;
3386 (void) salt;
3387 (void) output;
3388 (void) output_size;
3389
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003390 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003391
Gilles Peskine449bd832023-01-11 14:50:10 +01003392 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3393 return PSA_ERROR_INVALID_ARGUMENT;
3394 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003395
Valerio Setti5bb454a2024-01-15 10:43:16 +01003396 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003397 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3398 if (status != PSA_SUCCESS) {
3399 return status;
3400 }
3401 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003402 status = PSA_ERROR_INVALID_ARGUMENT;
3403 goto exit;
3404 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003405
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003406 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003407 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003408 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003409
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003410 status = psa_driver_wrapper_asymmetric_decrypt(
3411 &attributes, slot->key.data, slot->key.bytes,
3412 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003414
3415exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003416 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003417
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003419}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003420
Paul Elliott9fe12f62022-11-30 19:16:02 +00003421/****************************************************************/
3422/* Asymmetric interruptible cryptography */
3423/****************************************************************/
3424
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003425static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3426
Paul Elliott9fe12f62022-11-30 19:16:02 +00003427void psa_interruptible_set_max_ops(uint32_t max_ops)
3428{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003429 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003430}
3431
3432uint32_t psa_interruptible_get_max_ops(void)
3433{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003434 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003435}
3436
Paul Elliott9fe12f62022-11-30 19:16:02 +00003437uint32_t psa_sign_hash_get_num_ops(
3438 const psa_sign_hash_interruptible_operation_t *operation)
3439{
Paul Elliott296ede92022-12-15 17:00:30 +00003440 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003441}
3442
3443uint32_t psa_verify_hash_get_num_ops(
3444 const psa_verify_hash_interruptible_operation_t *operation)
3445{
Paul Elliott296ede92022-12-15 17:00:30 +00003446 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003447}
3448
Paul Elliott59ad9452022-12-18 15:09:02 +00003449static psa_status_t psa_sign_hash_abort_internal(
3450 psa_sign_hash_interruptible_operation_t *operation)
3451{
3452 if (operation->id == 0) {
3453 /* The object has (apparently) been initialized but it is not (yet)
3454 * in use. It's ok to call abort on such an object, and there's
3455 * nothing to do. */
3456 return PSA_SUCCESS;
3457 }
3458
3459 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3460
3461 status = psa_driver_wrapper_sign_hash_abort(operation);
3462
3463 operation->id = 0;
3464
Paul Elliotte6145dc2023-02-07 12:51:21 +00003465 /* Do not clear either the error_occurred or num_ops elements here as they
3466 * only want to be cleared by the application calling abort, not by abort
3467 * being called at completion of an operation. */
3468
Paul Elliott59ad9452022-12-18 15:09:02 +00003469 return status;
3470}
3471
Paul Elliott9fe12f62022-11-30 19:16:02 +00003472psa_status_t psa_sign_hash_start(
3473 psa_sign_hash_interruptible_operation_t *operation,
3474 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3475 const uint8_t *hash, size_t hash_length)
3476{
3477 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3478 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3479 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003480 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003481
Paul Elliottc9774412023-02-06 15:14:07 +00003482 /* Check that start has not been previously called, or operation has not
3483 * previously errored. */
3484 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003485 return PSA_ERROR_BAD_STATE;
3486 }
3487
Paul Elliott9fe12f62022-11-30 19:16:02 +00003488 status = psa_sign_verify_check_alg(0, alg);
3489 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003490 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003491 return status;
3492 }
3493
3494 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3495 PSA_KEY_USAGE_SIGN_HASH,
3496 alg);
3497
3498 if (status != PSA_SUCCESS) {
3499 goto exit;
3500 }
3501
3502 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3503 status = PSA_ERROR_INVALID_ARGUMENT;
3504 goto exit;
3505 }
3506
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003507 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003508 .core = slot->attr
3509 };
3510
Paul Elliott296ede92022-12-15 17:00:30 +00003511 /* Ensure ops count gets reset, in case of operation re-use. */
3512 operation->num_ops = 0;
3513
Paul Elliott9fe12f62022-11-30 19:16:02 +00003514 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3515 slot->key.data,
3516 slot->key.bytes, alg,
3517 hash, hash_length);
3518exit:
3519
3520 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003521 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003522 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003523 }
3524
Ryan Everett1b70a072024-01-04 10:32:49 +00003525 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003526
Paul Elliottc9774412023-02-06 15:14:07 +00003527 if (unlock_status != PSA_SUCCESS) {
3528 operation->error_occurred = 1;
3529 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003530
Paul Elliottc9774412023-02-06 15:14:07 +00003531 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003532}
3533
3534
3535psa_status_t psa_sign_hash_complete(
3536 psa_sign_hash_interruptible_operation_t *operation,
3537 uint8_t *signature, size_t signature_size,
3538 size_t *signature_length)
3539{
3540 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3541
3542 *signature_length = 0;
3543
Paul Elliottc9774412023-02-06 15:14:07 +00003544 /* Check that start has been called first, and that operation has not
3545 * previously errored. */
3546 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003547 status = PSA_ERROR_BAD_STATE;
3548 goto exit;
3549 }
3550
Paul Elliott096abc42023-02-03 18:33:23 +00003551 /* Immediately reject a zero-length signature buffer. This guarantees that
3552 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003553 if (signature_size == 0) {
3554 status = PSA_ERROR_BUFFER_TOO_SMALL;
3555 goto exit;
3556 }
3557
3558 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3559 signature_size,
3560 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003561
Paul Elliott296ede92022-12-15 17:00:30 +00003562 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003563 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003564
Paul Elliottebe225c2023-02-10 14:32:53 +00003565exit:
3566
Paul Elliott59200a22023-02-21 15:07:40 +00003567 psa_wipe_tag_output_buffer(signature, status, signature_size,
3568 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003569
Paul Elliott53bb3122023-02-10 14:22:22 +00003570 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003571 if (status != PSA_SUCCESS) {
3572 operation->error_occurred = 1;
3573 }
3574
Paul Elliott59ad9452022-12-18 15:09:02 +00003575 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003576 }
3577
3578 return status;
3579}
3580
3581psa_status_t psa_sign_hash_abort(
3582 psa_sign_hash_interruptible_operation_t *operation)
3583{
Paul Elliott59ad9452022-12-18 15:09:02 +00003584 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3585
3586 status = psa_sign_hash_abort_internal(operation);
3587
3588 /* We clear the number of ops done here, so that it is not cleared when
3589 * the operation fails or succeeds, only on manual abort. */
3590 operation->num_ops = 0;
3591
Paul Elliottc9774412023-02-06 15:14:07 +00003592 /* Likewise, failure state. */
3593 operation->error_occurred = 0;
3594
Paul Elliott59ad9452022-12-18 15:09:02 +00003595 return status;
3596}
3597
3598static psa_status_t psa_verify_hash_abort_internal(
3599 psa_verify_hash_interruptible_operation_t *operation)
3600{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003601 if (operation->id == 0) {
3602 /* The object has (apparently) been initialized but it is not (yet)
3603 * in use. It's ok to call abort on such an object, and there's
3604 * nothing to do. */
3605 return PSA_SUCCESS;
3606 }
3607
Paul Elliott59ad9452022-12-18 15:09:02 +00003608 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3609
3610 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003611
3612 operation->id = 0;
3613
Paul Elliotte6145dc2023-02-07 12:51:21 +00003614 /* Do not clear either the error_occurred or num_ops elements here as they
3615 * only want to be cleared by the application calling abort, not by abort
3616 * being called at completion of an operation. */
3617
Paul Elliott59ad9452022-12-18 15:09:02 +00003618 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003619}
3620
3621psa_status_t psa_verify_hash_start(
3622 psa_verify_hash_interruptible_operation_t *operation,
3623 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3624 const uint8_t *hash, size_t hash_length,
3625 const uint8_t *signature, size_t signature_length)
3626{
3627 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3628 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3629 psa_key_slot_t *slot;
3630
Paul Elliottc9774412023-02-06 15:14:07 +00003631 /* Check that start has not been previously called, or operation has not
3632 * previously errored. */
3633 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003634 return PSA_ERROR_BAD_STATE;
3635 }
3636
3637 status = psa_sign_verify_check_alg(0, alg);
3638 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003639 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003640 return status;
3641 }
3642
3643 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3644 PSA_KEY_USAGE_VERIFY_HASH,
3645 alg);
3646
3647 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003648 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003649 return status;
3650 }
3651
3652 psa_key_attributes_t attributes = {
3653 .core = slot->attr
3654 };
3655
Paul Elliott296ede92022-12-15 17:00:30 +00003656 /* Ensure ops count gets reset, in case of operation re-use. */
3657 operation->num_ops = 0;
3658
Paul Elliott9fe12f62022-11-30 19:16:02 +00003659 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3660 slot->key.data,
3661 slot->key.bytes,
3662 alg, hash, hash_length,
3663 signature, signature_length);
3664
3665 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003666 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003667 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003668 }
3669
Ryan Everett1b70a072024-01-04 10:32:49 +00003670 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003671
Paul Elliottc9774412023-02-06 15:14:07 +00003672 if (unlock_status != PSA_SUCCESS) {
3673 operation->error_occurred = 1;
3674 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003675
Paul Elliottc9774412023-02-06 15:14:07 +00003676 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003677}
3678
3679psa_status_t psa_verify_hash_complete(
3680 psa_verify_hash_interruptible_operation_t *operation)
3681{
3682 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3683
Paul Elliottc9774412023-02-06 15:14:07 +00003684 /* Check that start has been called first, and that operation has not
3685 * previously errored. */
3686 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003687 status = PSA_ERROR_BAD_STATE;
3688 goto exit;
3689 }
3690
3691 status = psa_driver_wrapper_verify_hash_complete(operation);
3692
Paul Elliott296ede92022-12-15 17:00:30 +00003693 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003694 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003695 operation);
3696
Paul Elliottebe225c2023-02-10 14:32:53 +00003697exit:
3698
Paul Elliott9fe12f62022-11-30 19:16:02 +00003699 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003700 if (status != PSA_SUCCESS) {
3701 operation->error_occurred = 1;
3702 }
3703
Paul Elliott59ad9452022-12-18 15:09:02 +00003704 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003705 }
3706
3707 return status;
3708}
3709
3710psa_status_t psa_verify_hash_abort(
3711 psa_verify_hash_interruptible_operation_t *operation)
3712{
Paul Elliott59ad9452022-12-18 15:09:02 +00003713 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003714
Paul Elliott59ad9452022-12-18 15:09:02 +00003715 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003716
Paul Elliott59ad9452022-12-18 15:09:02 +00003717 /* We clear the number of ops done here, so that it is not cleared when
3718 * the operation fails or succeeds, only on manual abort. */
3719 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003720
Paul Elliottc9774412023-02-06 15:14:07 +00003721 /* Likewise, failure state. */
3722 operation->error_occurred = 0;
3723
Paul Elliott59ad9452022-12-18 15:09:02 +00003724 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003725}
3726
Paul Elliott588f8ed2022-12-02 18:10:26 +00003727/****************************************************************/
3728/* Asymmetric interruptible cryptography internal */
3729/* implementations */
3730/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003731
Paul Elliott588f8ed2022-12-02 18:10:26 +00003732void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3733{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003734
Paul Elliott588f8ed2022-12-02 18:10:26 +00003735#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3736 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3737 defined(MBEDTLS_ECP_RESTARTABLE)
3738
3739 /* Internal implementation uses zero to indicate infinite number max ops,
3740 * therefore avoid this value, and set to minimum possible. */
3741 if (max_ops == 0) {
3742 max_ops = 1;
3743 }
3744
Paul Elliott588f8ed2022-12-02 18:10:26 +00003745 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003746#else
3747 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003748#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3749 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3750 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3751}
3752
Paul Elliott588f8ed2022-12-02 18:10:26 +00003753uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003754 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003755{
3756#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3757 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3758 defined(MBEDTLS_ECP_RESTARTABLE)
3759
Paul Elliott93d9ca82023-02-15 18:14:21 +00003760 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003761#else
3762 (void) operation;
3763 return 0;
3764#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3765 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3766 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3767}
3768
3769uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003770 const mbedtls_psa_verify_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
3785psa_status_t mbedtls_psa_sign_hash_start(
3786 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3787 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3788 size_t key_buffer_size, psa_algorithm_t alg,
3789 const uint8_t *hash, size_t hash_length)
3790{
3791 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003792 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003793
Paul Elliott068fe072023-01-16 13:59:15 +00003794 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3795 return PSA_ERROR_NOT_SUPPORTED;
3796 }
3797
3798 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003799 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003800 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003801
3802#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003803 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3804 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003805
Paul Elliotta1c94092023-02-15 16:38:04 +00003806 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3807
Paul Elliott93d9ca82023-02-15 18:14:21 +00003808 /* Ensure num_ops is zero'ed in case of context re-use. */
3809 operation->num_ops = 0;
3810
Paul Elliott068fe072023-01-16 13:59:15 +00003811 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3812 attributes->core.bits,
3813 key_buffer,
3814 key_buffer_size,
3815 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003816
Paul Elliott068fe072023-01-16 13:59:15 +00003817 if (status != PSA_SUCCESS) {
3818 return status;
3819 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003820
Paul Elliott1bc59df2023-02-05 13:41:57 +00003821 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003822 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003823
Paul Elliott068fe072023-01-16 13:59:15 +00003824 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003825 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003826 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003827
Paul Elliott0290a762023-02-09 14:30:24 +00003828 /* We only need to store the same length of hash as the private key size
3829 * here, it would be truncated by the internal implementation anyway. */
3830 required_hash_length = (hash_length < operation->coordinate_bytes ?
3831 hash_length : operation->coordinate_bytes);
3832
Paul Elliottba70ad42023-02-15 18:23:53 +00003833 if (required_hash_length > sizeof(operation->hash)) {
3834 /* Shouldn't happen, but better safe than sorry. */
3835 return PSA_ERROR_CORRUPTION_DETECTED;
3836 }
3837
Paul Elliott0290a762023-02-09 14:30:24 +00003838 memcpy(operation->hash, hash, required_hash_length);
3839 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003840
3841 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003842
3843#else
Paul Elliott068fe072023-01-16 13:59:15 +00003844 (void) operation;
3845 (void) key_buffer;
3846 (void) key_buffer_size;
3847 (void) alg;
3848 (void) hash;
3849 (void) hash_length;
3850 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003851 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003852
Paul Elliott068fe072023-01-16 13:59:15 +00003853 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003854#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3855 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3856 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003857}
3858
3859psa_status_t mbedtls_psa_sign_hash_complete(
3860 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3861 uint8_t *signature, size_t signature_size,
3862 size_t *signature_length)
3863{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003864#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3865 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3866 defined(MBEDTLS_ECP_RESTARTABLE)
3867
Paul Elliotta1c94092023-02-15 16:38:04 +00003868 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003869 mbedtls_mpi r;
3870 mbedtls_mpi s;
3871
Paul Elliott46845252023-02-03 14:59:11 +00003872 mbedtls_mpi_init(&r);
3873 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003874
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003875 /* Ensure max_ops is set to the current value (or default). */
3876 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3877
Paul Elliotta1c94092023-02-15 16:38:04 +00003878 if (signature_size < 2 * operation->coordinate_bytes) {
3879 status = PSA_ERROR_BUFFER_TOO_SMALL;
3880 goto exit;
3881 }
3882
Paul Elliott588f8ed2022-12-02 18:10:26 +00003883 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003884
Paul Elliott588f8ed2022-12-02 18:10:26 +00003885#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3886 status = mbedtls_to_psa_error(
3887 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003888 &r,
3889 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003890 &operation->ctx->d,
3891 operation->hash,
3892 operation->hash_length,
3893 operation->md_alg,
3894 mbedtls_psa_get_random,
3895 MBEDTLS_PSA_RANDOM_STATE,
3896 &operation->restart_ctx));
3897#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003898 status = PSA_ERROR_NOT_SUPPORTED;
3899 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003900#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3901 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003902 status = mbedtls_to_psa_error(
3903 mbedtls_ecdsa_sign_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 mbedtls_psa_get_random,
3910 MBEDTLS_PSA_RANDOM_STATE,
3911 mbedtls_psa_get_random,
3912 MBEDTLS_PSA_RANDOM_STATE,
3913 &operation->restart_ctx));
3914 }
3915
Paul Elliottf8e5b562023-02-19 18:43:45 +00003916 /* Hide the fact that the restart context only holds a delta of number of
3917 * ops done during the last operation, not an absolute value. */
3918 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3919
Paul Elliott724bd252023-02-08 12:35:08 +00003920 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003921 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003922 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003923 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003924 operation->coordinate_bytes)
3925 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003926
3927 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003928 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003929 }
3930
3931 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003932 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003933 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003934 operation->coordinate_bytes,
3935 operation->coordinate_bytes)
3936 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003937
3938 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003939 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003940 }
3941
Paul Elliott1bc59df2023-02-05 13:41:57 +00003942 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003943
Paul Elliott724bd252023-02-08 12:35:08 +00003944 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003945 }
Paul Elliott724bd252023-02-08 12:35:08 +00003946
3947exit:
3948
3949 mbedtls_mpi_free(&r);
3950 mbedtls_mpi_free(&s);
3951 return status;
3952
Paul Elliott588f8ed2022-12-02 18:10:26 +00003953 #else
3954
3955 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003956 (void) signature;
3957 (void) signature_size;
3958 (void) signature_length;
3959
3960 return PSA_ERROR_NOT_SUPPORTED;
3961
3962#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3963 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3964 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3965}
3966
3967psa_status_t mbedtls_psa_sign_hash_abort(
3968 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3969{
3970
3971#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3972 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3973 defined(MBEDTLS_ECP_RESTARTABLE)
3974
3975 if (operation->ctx) {
3976 mbedtls_ecdsa_free(operation->ctx);
3977 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003978 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003979 }
3980
3981 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3982
Paul Elliott93d9ca82023-02-15 18:14:21 +00003983 operation->num_ops = 0;
3984
Paul Elliott588f8ed2022-12-02 18:10:26 +00003985 return PSA_SUCCESS;
3986
3987#else
3988
3989 (void) operation;
3990
3991 return PSA_ERROR_NOT_SUPPORTED;
3992
3993#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3994 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3995 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3996}
3997
3998psa_status_t mbedtls_psa_verify_hash_start(
3999 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4000 const psa_key_attributes_t *attributes,
4001 const uint8_t *key_buffer, size_t key_buffer_size,
4002 psa_algorithm_t alg,
4003 const uint8_t *hash, size_t hash_length,
4004 const uint8_t *signature, size_t signature_length)
4005{
4006 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004007 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004008 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004009
Paul Elliott068fe072023-01-16 13:59:15 +00004010 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4011 return PSA_ERROR_NOT_SUPPORTED;
4012 }
4013
4014 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004015 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004016 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004017
4018#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004019 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4020 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004021
Paul Elliotta1c94092023-02-15 16:38:04 +00004022 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4023 mbedtls_mpi_init(&operation->r);
4024 mbedtls_mpi_init(&operation->s);
4025
Paul Elliott93d9ca82023-02-15 18:14:21 +00004026 /* Ensure num_ops is zero'ed in case of context re-use. */
4027 operation->num_ops = 0;
4028
Paul Elliott068fe072023-01-16 13:59:15 +00004029 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4030 attributes->core.bits,
4031 key_buffer,
4032 key_buffer_size,
4033 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004034
Paul Elliott068fe072023-01-16 13:59:15 +00004035 if (status != PSA_SUCCESS) {
4036 return status;
4037 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004038
Paul Elliottc569fc22023-02-10 13:02:54 +00004039 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004040
Paul Elliott1bc59df2023-02-05 13:41:57 +00004041 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004042 return PSA_ERROR_INVALID_SIGNATURE;
4043 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004044
Paul Elliott068fe072023-01-16 13:59:15 +00004045 status = mbedtls_to_psa_error(
4046 mbedtls_mpi_read_binary(&operation->r,
4047 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004048 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004049
Paul Elliott068fe072023-01-16 13:59:15 +00004050 if (status != PSA_SUCCESS) {
4051 return status;
4052 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004053
Paul Elliott068fe072023-01-16 13:59:15 +00004054 status = mbedtls_to_psa_error(
4055 mbedtls_mpi_read_binary(&operation->s,
4056 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004057 coordinate_bytes,
4058 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004059
Paul Elliott068fe072023-01-16 13:59:15 +00004060 if (status != PSA_SUCCESS) {
4061 return status;
4062 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004063
Paul Elliott2c9843f2023-02-15 17:32:42 +00004064 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004065
Paul Elliott2c9843f2023-02-15 17:32:42 +00004066 if (status != PSA_SUCCESS) {
4067 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004068 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004069
Paul Elliott0290a762023-02-09 14:30:24 +00004070 /* We only need to store the same length of hash as the private key size
4071 * here, it would be truncated by the internal implementation anyway. */
4072 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4073 coordinate_bytes);
4074
Paul Elliottba70ad42023-02-15 18:23:53 +00004075 if (required_hash_length > sizeof(operation->hash)) {
4076 /* Shouldn't happen, but better safe than sorry. */
4077 return PSA_ERROR_CORRUPTION_DETECTED;
4078 }
4079
Paul Elliott0290a762023-02-09 14:30:24 +00004080 memcpy(operation->hash, hash, required_hash_length);
4081 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004082
4083 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004084#else
Paul Elliott068fe072023-01-16 13:59:15 +00004085 (void) operation;
4086 (void) key_buffer;
4087 (void) key_buffer_size;
4088 (void) alg;
4089 (void) hash;
4090 (void) hash_length;
4091 (void) signature;
4092 (void) signature_length;
4093 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004094 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004095 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004096
Paul Elliott068fe072023-01-16 13:59:15 +00004097 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004098#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4099 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4100 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004101}
4102
4103psa_status_t mbedtls_psa_verify_hash_complete(
4104 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4105{
4106
4107#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4108 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4109 defined(MBEDTLS_ECP_RESTARTABLE)
4110
Paul Elliottf8e5b562023-02-19 18:43:45 +00004111 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4112
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004113 /* Ensure max_ops is set to the current value (or default). */
4114 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4115
Paul Elliottf8e5b562023-02-19 18:43:45 +00004116 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004117 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4118 operation->hash,
4119 operation->hash_length,
4120 &operation->ctx->Q,
4121 &operation->r,
4122 &operation->s,
4123 &operation->restart_ctx));
4124
Paul Elliottf8e5b562023-02-19 18:43:45 +00004125 /* Hide the fact that the restart context only holds a delta of number of
4126 * ops done during the last operation, not an absolute value. */
4127 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4128
4129 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004130#else
4131 (void) operation;
4132
4133 return PSA_ERROR_NOT_SUPPORTED;
4134
4135#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4136 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4137 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4138}
4139
4140psa_status_t mbedtls_psa_verify_hash_abort(
4141 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4142{
4143
4144#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4145 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4146 defined(MBEDTLS_ECP_RESTARTABLE)
4147
4148 if (operation->ctx) {
4149 mbedtls_ecdsa_free(operation->ctx);
4150 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004151 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004152 }
4153
4154 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4155
Paul Elliott93d9ca82023-02-15 18:14:21 +00004156 operation->num_ops = 0;
4157
Paul Elliott588f8ed2022-12-02 18:10:26 +00004158 mbedtls_mpi_free(&operation->r);
4159 mbedtls_mpi_free(&operation->s);
4160
4161 return PSA_SUCCESS;
4162
4163#else
4164 (void) operation;
4165
4166 return PSA_ERROR_NOT_SUPPORTED;
4167
4168#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4169 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4170 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4171}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004172
mohammad1603503973b2018-03-12 15:59:30 +02004173/****************************************************************/
4174/* Symmetric cryptography */
4175/****************************************************************/
4176
Gilles Peskine449bd832023-01-11 14:50:10 +01004177static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4178 mbedtls_svc_key_id_t key,
4179 psa_algorithm_t alg,
4180 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004181{
4182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4183 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004184 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4186 PSA_KEY_USAGE_ENCRYPT :
4187 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004188 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004189
4190 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004192 status = PSA_ERROR_BAD_STATE;
4193 goto exit;
4194 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004195
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004197 status = PSA_ERROR_INVALID_ARGUMENT;
4198 goto exit;
4199 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004200
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4202 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004203 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004205
Ronald Cron49fafa92021-03-10 08:34:23 +01004206 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004207 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004208 * so we only set it (in the driver wrapper) after resources have been
4209 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004210 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004212 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004214 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 }
4216 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004217
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004218 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004220 };
4221
Ronald Cronab99ac22020-10-01 16:38:28 +02004222 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 if (cipher_operation == MBEDTLS_ENCRYPT) {
4224 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4225 &attributes,
4226 slot->key.data,
4227 slot->key.bytes,
4228 alg);
4229 } else {
4230 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4231 &attributes,
4232 slot->key.data,
4233 slot->key.bytes,
4234 alg);
4235 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004236
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004237exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 if (status != PSA_SUCCESS) {
4239 psa_cipher_abort(operation);
4240 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004241
Ryan Everett1b70a072024-01-04 10:32:49 +00004242 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004243
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004245}
4246
Gilles Peskine449bd832023-01-11 14:50:10 +01004247psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4248 mbedtls_svc_key_id_t key,
4249 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004250{
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004252}
4253
Gilles Peskine449bd832023-01-11 14:50:10 +01004254psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4255 mbedtls_svc_key_id_t key,
4256 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004257{
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004259}
4260
Gilles Peskine449bd832023-01-11 14:50:10 +01004261psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4262 uint8_t *iv,
4263 size_t iv_size,
4264 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004265{
Ronald Cron6d051732020-10-01 14:10:20 +02004266 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004267 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004268 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004269
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004271 status = PSA_ERROR_BAD_STATE;
4272 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004273 }
4274
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004276 status = PSA_ERROR_BAD_STATE;
4277 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004278 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004279
Ronald Cron2fb90522021-07-05 12:31:44 +02004280 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004282 status = PSA_ERROR_BUFFER_TOO_SMALL;
4283 goto exit;
4284 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004285
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004287 status = PSA_ERROR_GENERIC_ERROR;
4288 goto exit;
4289 }
4290
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 status = psa_generate_random(local_iv, default_iv_length);
4292 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004293 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 }
Ronald Cron5618a392021-03-26 09:52:26 +01004295
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 status = psa_driver_wrapper_cipher_set_iv(operation,
4297 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004298
4299exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 if (status == PSA_SUCCESS) {
4301 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004302 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004303 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004305 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004307 }
Ronald Cron6d051732020-10-01 14:10:20 +02004308
Gilles Peskine449bd832023-01-11 14:50:10 +01004309 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004310}
4311
Gilles Peskine449bd832023-01-11 14:50:10 +01004312psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4313 const uint8_t *iv,
4314 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004315{
Ronald Cron6d051732020-10-01 14:10:20 +02004316 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004317
Gilles Peskine449bd832023-01-11 14:50:10 +01004318 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004319 status = PSA_ERROR_BAD_STATE;
4320 goto exit;
4321 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004322
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004324 status = PSA_ERROR_BAD_STATE;
4325 goto exit;
4326 }
Ronald Crona0d68172021-03-26 10:15:08 +01004327
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004329 status = PSA_ERROR_INVALID_ARGUMENT;
4330 goto exit;
4331 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004332
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 status = psa_driver_wrapper_cipher_set_iv(operation,
4334 iv,
4335 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004336
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004337exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004339 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 } else {
4341 psa_cipher_abort(operation);
4342 }
4343 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004344}
4345
Gilles Peskine449bd832023-01-11 14:50:10 +01004346psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4347 const uint8_t *input,
4348 size_t input_length,
4349 uint8_t *output,
4350 size_t output_size,
4351 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004352{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004353 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004354
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004356 status = PSA_ERROR_BAD_STATE;
4357 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004358 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004359
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004361 status = PSA_ERROR_BAD_STATE;
4362 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004363 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004364
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 status = psa_driver_wrapper_cipher_update(operation,
4366 input,
4367 input_length,
4368 output,
4369 output_size,
4370 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004371
4372exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 if (status != PSA_SUCCESS) {
4374 psa_cipher_abort(operation);
4375 }
Ronald Cron6d051732020-10-01 14:10:20 +02004376
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004378}
4379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4381 uint8_t *output,
4382 size_t output_size,
4383 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004384{
David Saadab4ecc272019-02-14 13:48:10 +02004385 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004386
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004388 status = PSA_ERROR_BAD_STATE;
4389 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004390 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004391
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004393 status = PSA_ERROR_BAD_STATE;
4394 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004395 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004396
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 status = psa_driver_wrapper_cipher_finish(operation,
4398 output,
4399 output_size,
4400 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004401
4402exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 if (status == PSA_SUCCESS) {
4404 return psa_cipher_abort(operation);
4405 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004406 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004408
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004410 }
mohammad1603503973b2018-03-12 15:59:30 +02004411}
4412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004414{
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004416 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004417 * in use. It's ok to call abort on such an object, and there's
4418 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004420 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004421
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004423
Ronald Cron49fafa92021-03-10 08:34:23 +01004424 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004425 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004426 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004427
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004429}
4430
Gilles Peskine449bd832023-01-11 14:50:10 +01004431psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4432 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004433 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004435 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 size_t output_size,
4437 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004438{
4439 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004440 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004441 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004442 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4443 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004444 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004445
David Horstmann62a56d92023-12-14 18:12:47 +00004446 LOCAL_INPUT_DECLARE(input_external, input);
4447 LOCAL_OUTPUT_DECLARE(output_external, output);
4448
David Horstmann36df4b22023-12-13 15:55:25 +00004449 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004450 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004451
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004453 status = PSA_ERROR_INVALID_ARGUMENT;
4454 goto exit;
4455 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004456
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4458 PSA_KEY_USAGE_ENCRYPT,
4459 alg);
4460 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004461 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004463
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004464 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004466 };
4467
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4469 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004470 status = PSA_ERROR_GENERIC_ERROR;
4471 goto exit;
4472 }
4473
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 if (default_iv_length > 0) {
4475 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004476 status = PSA_ERROR_BUFFER_TOO_SMALL;
4477 goto exit;
4478 }
4479
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 status = psa_generate_random(local_iv, default_iv_length);
4481 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004482 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004484 }
4485
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004486 status = psa_driver_wrapper_cipher_encrypt(
4487 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004488 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004489 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004491
4492exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004493 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004495 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004496 }
Ronald Cron23919522021-07-08 19:00:07 +02004497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 if (status == PSA_SUCCESS) {
4499 if (default_iv_length > 0) {
4500 memcpy(output, local_iv, default_iv_length);
4501 }
4502 *output_length += default_iv_length;
4503 } else {
4504 *output_length = 0;
4505 }
4506
David Horstmann62a56d92023-12-14 18:12:47 +00004507 LOCAL_INPUT_FREE(input_external, input);
4508 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004509
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004511}
4512
Gilles Peskine449bd832023-01-11 14:50:10 +01004513psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4514 psa_algorithm_t alg,
4515 const uint8_t *input,
4516 size_t input_length,
4517 uint8_t *output,
4518 size_t output_size,
4519 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004520{
4521 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004522 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004523 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004524 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004525
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004527 status = PSA_ERROR_INVALID_ARGUMENT;
4528 goto exit;
4529 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4532 PSA_KEY_USAGE_DECRYPT,
4533 alg);
4534 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004535 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004537
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004538 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004540 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004541
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4543 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004544 status = PSA_ERROR_INVALID_ARGUMENT;
4545 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004547 status = PSA_ERROR_INVALID_ARGUMENT;
4548 goto exit;
4549 }
4550
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004551 status = psa_driver_wrapper_cipher_decrypt(
4552 &attributes, slot->key.data, slot->key.bytes,
4553 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004555
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004556exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004557 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004559 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004563 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 }
Ronald Cron23919522021-07-08 19:00:07 +02004565
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004567}
4568
4569
mohammad16035955c982018-04-26 00:53:03 +03004570/****************************************************************/
4571/* AEAD */
4572/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004573
Paul Elliottbaff51c2021-09-28 17:44:45 +01004574/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004575static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004576{
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004578}
4579
4580/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004581static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4582 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004583{
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004585
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004587#if defined(PSA_WANT_ALG_GCM)
4588 case PSA_ALG_GCM:
4589 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 * arbitrarily large nonces. Please note that we do not generally
4591 * recommend the usage of nonces of greater length than
4592 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4593 * size, which can then lead to collisions if you encrypt a very
4594 * large number of messages.*/
4595 if (nonce_length != 0) {
4596 return PSA_SUCCESS;
4597 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004598 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004599#endif /* PSA_WANT_ALG_GCM */
4600#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004601 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 if (nonce_length >= 7 && nonce_length <= 13) {
4603 return PSA_SUCCESS;
4604 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004605 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004606#endif /* PSA_WANT_ALG_CCM */
4607#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004608 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 if (nonce_length == 12) {
4610 return PSA_SUCCESS;
4611 } else if (nonce_length == 8) {
4612 return PSA_ERROR_NOT_SUPPORTED;
4613 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004614 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004615#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004616 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004617 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004619 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004620
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004622}
4623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004625{
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4627 return PSA_ERROR_INVALID_ARGUMENT;
4628 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004629
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004631}
4632
Gilles Peskine449bd832023-01-11 14:50:10 +01004633psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4634 psa_algorithm_t alg,
4635 const uint8_t *nonce,
4636 size_t nonce_length,
4637 const uint8_t *additional_data,
4638 size_t additional_data_length,
4639 const uint8_t *plaintext,
4640 size_t plaintext_length,
4641 uint8_t *ciphertext,
4642 size_t ciphertext_size,
4643 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004644{
Ronald Cron215633c2021-03-16 17:15:37 +01004645 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4646 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004647
mohammad1603f08a5502018-06-03 15:05:47 +03004648 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004649
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 status = psa_aead_check_algorithm(alg);
4651 if (status != PSA_SUCCESS) {
4652 return status;
4653 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004654
Ronald Cron9a986162021-03-26 12:40:07 +01004655 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4657 if (status != PSA_SUCCESS) {
4658 return status;
4659 }
mohammad16035955c982018-04-26 00:53:03 +03004660
Ronald Cron215633c2021-03-16 17:15:37 +01004661 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004663 };
mohammad16035955c982018-04-26 00:53:03 +03004664
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 status = psa_aead_check_nonce_length(alg, nonce_length);
4666 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004667 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004669
Ronald Cronde822812021-03-17 16:08:20 +01004670 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004671 &attributes, slot->key.data, slot->key.bytes,
4672 alg,
4673 nonce, nonce_length,
4674 additional_data, additional_data_length,
4675 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004677
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4679 memset(ciphertext, 0, ciphertext_size);
4680 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004681
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004682exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004683 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004684
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004686}
4687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4689 psa_algorithm_t alg,
4690 const uint8_t *nonce,
4691 size_t nonce_length,
4692 const uint8_t *additional_data,
4693 size_t additional_data_length,
4694 const uint8_t *ciphertext,
4695 size_t ciphertext_length,
4696 uint8_t *plaintext,
4697 size_t plaintext_size,
4698 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004699{
Ronald Cron215633c2021-03-16 17:15:37 +01004700 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4701 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004702
Gilles Peskineee652a32018-06-01 19:23:52 +02004703 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004704
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 status = psa_aead_check_algorithm(alg);
4706 if (status != PSA_SUCCESS) {
4707 return status;
4708 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004709
Ronald Cron9a986162021-03-26 12:40:07 +01004710 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4712 if (status != PSA_SUCCESS) {
4713 return status;
4714 }
mohammad16035955c982018-04-26 00:53:03 +03004715
Ronald Cron215633c2021-03-16 17:15:37 +01004716 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004718 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004719
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 status = psa_aead_check_nonce_length(alg, nonce_length);
4721 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004722 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004724
Ronald Cronde822812021-03-17 16:08:20 +01004725 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004726 &attributes, slot->key.data, slot->key.bytes,
4727 alg,
4728 nonce, nonce_length,
4729 additional_data, additional_data_length,
4730 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004732
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 if (status != PSA_SUCCESS && plaintext_size != 0) {
4734 memset(plaintext, 0, plaintext_size);
4735 }
mohammad160360a64d02018-06-03 17:20:42 +03004736
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004737exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004738 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004739
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 return status;
mohammad16035955c982018-04-26 00:53:03 +03004741}
4742
Gilles Peskine449bd832023-01-11 14:50:10 +01004743static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4744{
4745 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004746
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004748#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004750 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4752 return PSA_ERROR_INVALID_ARGUMENT;
4753 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004754 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004755#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004756
Przemek Stekiel86679c72022-10-06 17:06:56 +02004757#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004759 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4761 return PSA_ERROR_INVALID_ARGUMENT;
4762 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004763 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004764#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004765
Przemek Stekiel86679c72022-10-06 17:06:56 +02004766#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004768 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 if (tag_len != 16) {
4770 return PSA_ERROR_INVALID_ARGUMENT;
4771 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004772 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004773#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004774
4775 default:
4776 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004778 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004780}
4781
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004782/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004783static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4784 int is_encrypt,
4785 mbedtls_svc_key_id_t key,
4786 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004787{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004788 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4789 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4790 psa_key_slot_t *slot = NULL;
4791 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004792 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004793
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 status = psa_aead_check_algorithm(alg);
4795 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004796 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004798
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004800 status = PSA_ERROR_BAD_STATE;
4801 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004802 }
4803
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (operation->nonce_set || operation->lengths_set ||
4805 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004806 status = PSA_ERROR_BAD_STATE;
4807 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004808 }
4809
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004811 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004813 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004815
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4817 alg);
4818 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004819 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004821
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004822 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004823 .core = slot->attr
4824 };
4825
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004827 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if (is_encrypt) {
4831 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4832 &attributes,
4833 slot->key.data,
4834 slot->key.bytes,
4835 alg);
4836 } else {
4837 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4838 &attributes,
4839 slot->key.data,
4840 slot->key.bytes,
4841 alg);
4842 }
4843 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004844 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004846
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004848
4849exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004850 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004851
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004853 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004855 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 } else {
4857 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004858 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004859
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004861}
4862
Paul Elliott302ff6b2021-04-20 18:10:30 +01004863/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004864psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4865 mbedtls_svc_key_id_t key,
4866 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004867{
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004869}
4870
4871/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004872psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4873 mbedtls_svc_key_id_t key,
4874 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004875{
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004877}
4878
4879/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004880psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4881 uint8_t *nonce,
4882 size_t nonce_size,
4883 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004884{
4885 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004886 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004887 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004888
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004889 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004890
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004892 status = PSA_ERROR_BAD_STATE;
4893 goto exit;
4894 }
4895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004897 status = PSA_ERROR_BAD_STATE;
4898 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004899 }
4900
Paul Elliotte193ea82021-10-01 13:00:16 +01004901 /* For CCM, this size may not be correct according to the PSA
4902 * specification. The PSA Crypto 1.0.1 specification states:
4903 *
4904 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4905 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4906 *
4907 * However this restriction that L has to be the smallest integer is not
4908 * applied in practice, and it is not implementable here since the
4909 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4911 operation->alg);
4912 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004913 status = PSA_ERROR_BUFFER_TOO_SMALL;
4914 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004915 }
4916
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 status = psa_generate_random(local_nonce, required_nonce_size);
4918 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004919 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004921
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004923
Paul Elliott39dc6b82021-05-11 19:16:09 +01004924exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 if (status == PSA_SUCCESS) {
4926 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004927 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 } else {
4929 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004930 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004931
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004933}
4934
4935/* Set the nonce for a multipart authenticated encryption or decryption
4936 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004937psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4938 const uint8_t *nonce,
4939 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004940{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004941 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4942
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004944 status = PSA_ERROR_BAD_STATE;
4945 goto exit;
4946 }
4947
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004949 status = PSA_ERROR_BAD_STATE;
4950 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004951 }
4952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4954 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004955 status = PSA_ERROR_INVALID_ARGUMENT;
4956 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004957 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004958
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4960 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004961
Paul Elliott39dc6b82021-05-11 19:16:09 +01004962exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004964 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 } else {
4966 psa_aead_abort(operation);
4967 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004968
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004970}
4971
4972/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004973psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4974 size_t ad_length,
4975 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004976{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004977 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4978
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004980 status = PSA_ERROR_BAD_STATE;
4981 goto exit;
4982 }
4983
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 if (operation->lengths_set || operation->ad_started ||
4985 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004986 status = PSA_ERROR_BAD_STATE;
4987 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004988 }
4989
Gilles Peskine449bd832023-01-11 14:50:10 +01004990 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004991#if defined(PSA_WANT_ALG_GCM)
4992 case PSA_ALG_GCM:
4993 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004994 * bits. Without the guard this code will generate warnings on 32bit
4995 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004996#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 if (((uint64_t) ad_length) >> 61 != 0 ||
4998 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004999 status = PSA_ERROR_INVALID_ARGUMENT;
5000 goto exit;
5001 }
Paul Elliott325d3742021-09-27 17:56:28 +01005002#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005003 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005004#endif /* PSA_WANT_ALG_GCM */
5005#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005006 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005007 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005008 status = PSA_ERROR_INVALID_ARGUMENT;
5009 goto exit;
5010 }
5011 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005012#endif /* PSA_WANT_ALG_CCM */
5013#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005014 case PSA_ALG_CHACHA20_POLY1305:
5015 /* No length restrictions for ChaChaPoly. */
5016 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005017#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005018 default:
5019 break;
5020 }
Paul Elliott325d3742021-09-27 17:56:28 +01005021
Gilles Peskine449bd832023-01-11 14:50:10 +01005022 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5023 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005024
Paul Elliott39dc6b82021-05-11 19:16:09 +01005025exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005027 operation->ad_remaining = ad_length;
5028 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005029 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 } else {
5031 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005032 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005033
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005035}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005036
5037/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005038psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5039 const uint8_t *input,
5040 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005041{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005042 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5043
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005045 status = PSA_ERROR_BAD_STATE;
5046 goto exit;
5047 }
5048
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005050 status = PSA_ERROR_BAD_STATE;
5051 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005052 }
5053
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 if (operation->lengths_set) {
5055 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005056 status = PSA_ERROR_INVALID_ARGUMENT;
5057 goto exit;
5058 }
5059
5060 operation->ad_remaining -= input_length;
5061 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005062#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005064 status = PSA_ERROR_BAD_STATE;
5065 goto exit;
5066 }
5067#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005068
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 status = psa_driver_wrapper_aead_update_ad(operation, input,
5070 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005071
Paul Elliott39dc6b82021-05-11 19:16:09 +01005072exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005074 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 } else {
5076 psa_aead_abort(operation);
5077 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005078
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005080}
5081
5082/* Encrypt or decrypt a message fragment in an active multipart AEAD
5083 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005084psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5085 const uint8_t *input,
5086 size_t input_length,
5087 uint8_t *output,
5088 size_t output_size,
5089 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005090{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005091 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005092
5093 *output_length = 0;
5094
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005096 status = PSA_ERROR_BAD_STATE;
5097 goto exit;
5098 }
5099
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005101 status = PSA_ERROR_BAD_STATE;
5102 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005103 }
5104
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005106 /* Additional data length was supplied, but not all the additional
5107 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005109 status = PSA_ERROR_INVALID_ARGUMENT;
5110 goto exit;
5111 }
5112
5113 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005115 status = PSA_ERROR_INVALID_ARGUMENT;
5116 goto exit;
5117 }
5118
5119 operation->body_remaining -= input_length;
5120 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005121#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005123 status = PSA_ERROR_BAD_STATE;
5124 goto exit;
5125 }
5126#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005127
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5129 output, output_size,
5130 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005131
Paul Elliott39dc6b82021-05-11 19:16:09 +01005132exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005134 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 } else {
5136 psa_aead_abort(operation);
5137 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005138
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005140}
5141
Gilles Peskine449bd832023-01-11 14:50:10 +01005142static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005143{
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 if (operation->id == 0 || !operation->nonce_set) {
5145 return PSA_ERROR_BAD_STATE;
5146 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005147
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5149 operation->body_remaining != 0)) {
5150 return PSA_ERROR_INVALID_ARGUMENT;
5151 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005152
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005154}
5155
Paul Elliott302ff6b2021-04-20 18:10:30 +01005156/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005157psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5158 uint8_t *ciphertext,
5159 size_t ciphertext_size,
5160 size_t *ciphertext_length,
5161 uint8_t *tag,
5162 size_t tag_size,
5163 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005164{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005165 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5166
Paul Elliott302ff6b2021-04-20 18:10:30 +01005167 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005168 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005169
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 status = psa_aead_final_checks(operation);
5171 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005172 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005174
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005176 status = PSA_ERROR_BAD_STATE;
5177 goto exit;
5178 }
5179
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5181 ciphertext_size,
5182 ciphertext_length,
5183 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005184
Paul Elliott39dc6b82021-05-11 19:16:09 +01005185exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005186
5187
Paul Elliottf47b0952021-05-21 18:02:33 +01005188 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005189 * the zero tag size, make sure the tag is set to something implausible.
5190 * Even if the operation succeeds, make sure we clear the rest of the
5191 * buffer to prevent potential leakage of anything previously placed in
5192 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005193 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005194
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005196
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005198}
5199
5200/* Finish authenticating and decrypting a message in a multipart AEAD
5201 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005202psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5203 uint8_t *plaintext,
5204 size_t plaintext_size,
5205 size_t *plaintext_length,
5206 const uint8_t *tag,
5207 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005208{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005209 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5210
Paul Elliott302ff6b2021-04-20 18:10:30 +01005211 *plaintext_length = 0;
5212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 status = psa_aead_final_checks(operation);
5214 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005215 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005216 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005217
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005219 status = PSA_ERROR_BAD_STATE;
5220 goto exit;
5221 }
5222
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5224 plaintext_size,
5225 plaintext_length,
5226 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005227
5228exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005230
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005232}
5233
5234/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005235psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005236{
5237 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5238
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005240 /* The object has (apparently) been initialized but it is not (yet)
5241 * in use. It's ok to call abort on such an object, and there's
5242 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005244 }
5245
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005247
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005249
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005251}
5252
Gilles Peskinee59236f2018-01-27 23:32:46 +01005253/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005254/* Generators */
5255/****************************************************************/
5256
Przemek Stekiel69c46792022-06-10 12:59:51 +02005257#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005258 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005259 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305260 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305261 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005262#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005263#endif /* At least one builtin KDF */
5264
Przemek Stekiel69c46792022-06-10 12:59:51 +02005265#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005266 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5267 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5268static psa_status_t psa_key_derivation_start_hmac(
5269 psa_mac_operation_t *operation,
5270 psa_algorithm_t hash_alg,
5271 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005273{
5274 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5275 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5277 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5278 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005279
Steven Cooreman72f736a2021-05-07 14:14:37 +02005280 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005282
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 status = psa_driver_wrapper_mac_sign_setup(operation,
5284 &attributes,
5285 hmac_key, hmac_key_length,
5286 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005287
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 psa_reset_key_attributes(&attributes);
5289 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005290}
5291#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005292
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005293#define HKDF_STATE_INIT 0 /* no input yet */
5294#define HKDF_STATE_STARTED 1 /* got salt */
5295#define HKDF_STATE_KEYED 2 /* got key */
5296#define HKDF_STATE_OUTPUT 3 /* output started */
5297
Gilles Peskinecbe66502019-05-16 16:59:18 +02005298static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005300{
Gilles Peskine449bd832023-01-11 14:50:10 +01005301 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5302 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5303 } else {
5304 return operation->alg;
5305 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005306}
5307
Gilles Peskine449bd832023-01-11 14:50:10 +01005308psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005309{
5310 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5312 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005313 /* The object has (apparently) been initialized but it is not
5314 * in use. It's ok to call abort on such an object, and there's
5315 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005317#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5319 mbedtls_free(operation->ctx.hkdf.info);
5320 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5321 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005322#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005323#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5324 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5326 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5327 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5328 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005329 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005331 }
5332
Gilles Peskine449bd832023-01-11 14:50:10 +01005333 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005334 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005336 }
5337
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005339 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005341 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005342#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005344 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005346 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005347#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005348 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005349
5350 /* We leave the fields Ai and output_block to be erased safely by the
5351 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005353#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5354 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005355#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5357 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5358 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5359 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005360#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305361#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305362 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305363 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005364 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305365 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305366 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305367
5368 status = PSA_SUCCESS;
5369 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305370#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005371 {
5372 status = PSA_ERROR_BAD_STATE;
5373 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 mbedtls_platform_zeroize(operation, sizeof(*operation));
5375 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005376}
5377
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005378psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005380{
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005382 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005384 }
5385
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005386 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005388}
5389
Gilles Peskine449bd832023-01-11 14:50:10 +01005390psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5391 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005392{
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 if (operation->alg == 0) {
5394 return PSA_ERROR_BAD_STATE;
5395 }
5396 if (capacity > operation->capacity) {
5397 return PSA_ERROR_INVALID_ARGUMENT;
5398 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005399 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005401}
5402
Przemek Stekiel69c46792022-06-10 12:59:51 +02005403#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005404/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005405static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5406 psa_algorithm_t kdf_alg,
5407 uint8_t *output,
5408 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005409{
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5411 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005412 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005413 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005414#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005416#else
5417 const uint8_t last_block = 0xff;
5418#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005419
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 if (hkdf->state < HKDF_STATE_KEYED ||
5421 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005422#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005424#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005425 )) {
5426 return PSA_ERROR_BAD_STATE;
5427 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005428 hkdf->state = HKDF_STATE_OUTPUT;
5429
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005431 /* Copy what remains of the current block */
5432 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005434 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 }
5436 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005437 output += n;
5438 output_length -= n;
5439 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005441 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005443 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005444 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005445 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005446 * object was corrupted or if this function is called directly
5447 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 if (hkdf->block_number == last_block) {
5449 return PSA_ERROR_BAD_STATE;
5450 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005451
5452 /* We need a new block */
5453 ++hkdf->block_number;
5454 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005455
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5457 hash_alg,
5458 hkdf->prk,
5459 hash_length);
5460 if (status != PSA_SUCCESS) {
5461 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005462 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005463
5464 if (hkdf->block_number != 1) {
5465 status = psa_mac_update(&hkdf->hmac,
5466 hkdf->output_block,
5467 hash_length);
5468 if (status != PSA_SUCCESS) {
5469 return status;
5470 }
5471 }
5472 status = psa_mac_update(&hkdf->hmac,
5473 hkdf->info,
5474 hkdf->info_length);
5475 if (status != PSA_SUCCESS) {
5476 return status;
5477 }
5478 status = psa_mac_update(&hkdf->hmac,
5479 &hkdf->block_number, 1);
5480 if (status != PSA_SUCCESS) {
5481 return status;
5482 }
5483 status = psa_mac_sign_finish(&hkdf->hmac,
5484 hkdf->output_block,
5485 sizeof(hkdf->output_block),
5486 &hmac_output_length);
5487 if (status != PSA_SUCCESS) {
5488 return status;
5489 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005490 }
5491
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005493}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005494#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005495
John Durkop07cc04a2020-11-16 22:08:34 -08005496#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5497 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005498static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5499 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005501{
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5503 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005504 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5505 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005506 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005507
Janos Follath7742fee2019-06-17 12:58:10 +01005508 /* We can't be wanting more output after block 0xff, otherwise
5509 * the capacity check in psa_key_derivation_output_bytes() would have
5510 * prevented this call. It could happen only if the operation
5511 * object was corrupted or if this function is called directly
5512 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 if (tls12_prf->block_number == 0xff) {
5514 return PSA_ERROR_CORRUPTION_DETECTED;
5515 }
Janos Follath7742fee2019-06-17 12:58:10 +01005516
5517 /* We need a new block */
5518 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005519 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005520
5521 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5522 *
5523 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5524 *
5525 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5526 * HMAC_hash(secret, A(2) + seed) +
5527 * HMAC_hash(secret, A(3) + seed) + ...
5528 *
5529 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005530 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005531 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005532 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005533 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005534 * is currently extracted as `output_block` and where i is
5535 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005536 */
5537
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 status = psa_key_derivation_start_hmac(&hmac,
5539 hash_alg,
5540 tls12_prf->secret,
5541 tls12_prf->secret_length);
5542 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005543 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005545
5546 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005548 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5549 * the variable seed and in this instance means it in the context of the
5550 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 status = psa_mac_update(&hmac,
5552 tls12_prf->label,
5553 tls12_prf->label_length);
5554 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005555 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 }
5557 status = psa_mac_update(&hmac,
5558 tls12_prf->seed,
5559 tls12_prf->seed_length);
5560 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005561 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005562 }
5563 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005564 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5566 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005567 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005569 }
5570
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 status = psa_mac_sign_finish(&hmac,
5572 tls12_prf->Ai, hash_length,
5573 &hmac_output_length);
5574 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005575 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 }
5577 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005578 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005579 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005580
5581 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 status = psa_key_derivation_start_hmac(&hmac,
5583 hash_alg,
5584 tls12_prf->secret,
5585 tls12_prf->secret_length);
5586 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005587 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 }
5589 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5590 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005591 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 }
5593 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5594 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005595 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 }
5597 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5598 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005599 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 }
5601 status = psa_mac_sign_finish(&hmac,
5602 tls12_prf->output_block, hash_length,
5603 &hmac_output_length);
5604 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005605 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005607
Janos Follath7742fee2019-06-17 12:58:10 +01005608
5609cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 cleanup_status = psa_mac_abort(&hmac);
5611 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005612 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005614
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005616}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005617
Janos Follath844eb0e2019-06-19 12:10:49 +01005618static psa_status_t psa_key_derivation_tls12_prf_read(
5619 psa_tls12_prf_key_derivation_t *tls12_prf,
5620 psa_algorithm_t alg,
5621 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005623{
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5625 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005626 psa_status_t status;
5627 uint8_t offset, length;
5628
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005630 case PSA_TLS12_PRF_STATE_LABEL_SET:
5631 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5632 break;
5633 case PSA_TLS12_PRF_STATE_OUTPUT:
5634 break;
5635 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005637 }
5638
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005640 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005641 if (tls12_prf->left_in_block == 0) {
5642 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5643 alg);
5644 if (status != PSA_SUCCESS) {
5645 return status;
5646 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005647
5648 continue;
5649 }
5650
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005652 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005653 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005654 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005656
5657 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005659 output += length;
5660 output_length -= length;
5661 tls12_prf->left_in_block -= length;
5662 }
5663
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005665}
John Durkop07cc04a2020-11-16 22:08:34 -08005666#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5667 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005668
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005669#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5670static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5671 psa_tls12_ecjpake_to_pms_t *ecjpake,
5672 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005674{
5675 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005676 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005677
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 if (output_length != 32) {
5679 return PSA_ERROR_INVALID_ARGUMENT;
5680 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005681
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5683 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5684 &output_size);
5685 if (status != PSA_SUCCESS) {
5686 return status;
5687 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005688
Gilles Peskine449bd832023-01-11 14:50:10 +01005689 if (output_size != output_length) {
5690 return PSA_ERROR_GENERIC_ERROR;
5691 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005692
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005694}
5695#endif
5696
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305697#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305698static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5699 psa_pbkdf2_key_derivation_t *pbkdf2,
5700 psa_algorithm_t prf_alg,
5701 uint8_t prf_output_length,
5702 psa_key_attributes_t *attributes)
5703{
5704 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305705 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305706 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305707 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305708 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305709 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305710 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305711
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305712 mac_operation.is_sign = 1;
5713 mac_operation.mac_size = prf_output_length;
5714 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305715
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305716 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5717 attributes,
5718 pbkdf2->password,
5719 pbkdf2->password_length,
5720 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305721 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305722 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305723 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305724 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5725 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305726 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305727 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305728 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305729 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305730 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305731 }
5732 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5733 &mac_output_length);
5734 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305735 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305736 }
5737
5738 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305739 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305740 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305741 }
5742
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305743 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305744
5745 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305746 /* We are passing prf_output_length as mac_size because the driver
5747 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305748 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305749 status = psa_driver_wrapper_mac_compute(attributes,
5750 pbkdf2->password,
5751 pbkdf2->password_length,
5752 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305753 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305754 &mac_output_length);
5755 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305756 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305757 }
5758
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305759 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305760 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305761
5762cleanup:
5763 /* Zeroise buffers to clear sensitive data from memory. */
5764 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5765 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305766}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305767
5768static psa_status_t psa_key_derivation_pbkdf2_read(
5769 psa_pbkdf2_key_derivation_t *pbkdf2,
5770 psa_algorithm_t kdf_alg,
5771 uint8_t *output,
5772 size_t output_length)
5773{
5774 psa_status_t status;
5775 psa_algorithm_t prf_alg;
5776 uint8_t prf_output_length;
5777 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5778 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5779 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5780
5781 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5782 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5783 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5784 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305785 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5786 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305787 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305788 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305789 } else {
5790 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305791 }
5792
5793 switch (pbkdf2->state) {
5794 case PSA_PBKDF2_STATE_PASSWORD_SET:
5795 /* Initially we need a new block so bytes_used is equal to block size*/
5796 pbkdf2->bytes_used = prf_output_length;
5797 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5798 break;
5799 case PSA_PBKDF2_STATE_OUTPUT:
5800 break;
5801 default:
5802 return PSA_ERROR_BAD_STATE;
5803 }
5804
5805 while (output_length != 0) {
5806 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5807 if (n > output_length) {
5808 n = (uint8_t) output_length;
5809 }
5810 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5811 output += n;
5812 output_length -= n;
5813 pbkdf2->bytes_used += n;
5814
5815 if (output_length == 0) {
5816 break;
5817 }
5818
5819 /* We need a new block */
5820 pbkdf2->bytes_used = 0;
5821 pbkdf2->block_number++;
5822
5823 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5824 prf_output_length,
5825 &attributes);
5826 if (status != PSA_SUCCESS) {
5827 return status;
5828 }
5829 }
5830
5831 return PSA_SUCCESS;
5832}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305833#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305834
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005835psa_status_t psa_key_derivation_output_bytes(
5836 psa_key_derivation_operation_t *operation,
5837 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005839{
5840 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005842
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005844 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005846 }
5847
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005849 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005850 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005851 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005852 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005853 goto exit;
5854 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005856 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005857 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005858 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5859 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005860 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005861 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005863 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005864 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005865
Przemek Stekiel69c46792022-06-10 12:59:51 +02005866#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5868 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5869 output, output_length);
5870 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005871#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005872#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5873 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5875 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5876 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5877 kdf_alg, output,
5878 output_length);
5879 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005880#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5881 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005882#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005883 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005884 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5886 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005887#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305888#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305889 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305890 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5891 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305892 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305893#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005894
Gilles Peskineeab56e42018-07-12 17:12:33 +02005895 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005896 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005898 }
5899
5900exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005901 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005902 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005903 * This allows us to differentiate between exhausted operations and
5904 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5905 * operations. */
5906 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005907 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005908 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005910 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005911 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005912}
5913
David Brown7807bf72021-02-09 16:28:23 -07005914#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005915static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005916{
Gilles Peskine449bd832023-01-11 14:50:10 +01005917 if (data_size >= 8) {
5918 mbedtls_des_key_set_parity(data);
5919 }
5920 if (data_size >= 16) {
5921 mbedtls_des_key_set_parity(data + 8);
5922 }
5923 if (data_size >= 24) {
5924 mbedtls_des_key_set_parity(data + 16);
5925 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005926}
David Brown7807bf72021-02-09 16:28:23 -07005927#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005928
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005929/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005930 * ECC keys on a Weierstrass elliptic curve require the generation
5931 * of a private key which is an integer
5932 * in the range [1, N - 1], where N is the boundary of the private key domain:
5933 * N is the prime p for Diffie-Hellman, or the order of the
5934 * curve’s base point for ECC.
5935 *
5936 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5937 * This function generates the private key using the following process:
5938 *
5939 * 1. Draw a byte string of length ceiling(m/8) bytes.
5940 * 2. If m is not a multiple of 8, set the most significant
5941 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5942 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5943 * 4. If k > N - 2, discard the result and return to step 1.
5944 * 5. Output k + 1 as the private key.
5945 *
5946 * This method allows compliance to NIST standards, specifically the methods titled
5947 * Key-Pair Generation by Testing Candidates in the following publications:
5948 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5949 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5950 * Diffie-Hellman keys.
5951 *
5952 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5953 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5954 *
5955 * Note: Function allocates memory for *data buffer, so given *data should be
5956 * always NULL.
5957 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005958#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5959#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005960static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005961 psa_key_slot_t *slot,
5962 size_t bits,
5963 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005964 uint8_t **data
5965 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005966{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005967 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005968 mbedtls_mpi k;
5969 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005970 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005971 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005972 size_t m;
5973 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005974
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 mbedtls_mpi_init(&k);
5976 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005977
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005978 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005980 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005981 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005982
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005984 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005985 goto cleanup;
5986 }
5987
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005988 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005990
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005992
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005993 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005994 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005995 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005996
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005997 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005998
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005999 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006000 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006001
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006002 /* Note: This function is always called with *data == NULL and it
6003 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 *data = mbedtls_calloc(1, m_bytes);
6005 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006006 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006007 goto cleanup;
6008 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006009
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006011 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006013 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006015
6016 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006018 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006019 * (8 * ceiling(m/8) - m) bits of the first byte in
6020 * the string to zero.
6021 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006023 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006024 }
6025
6026 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 * big-endian byte string.
6028 */
6029 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006030
6031 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 * Result of comparison is returned. When it indicates error
6033 * then this function is called again.
6034 */
6035 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006036 }
6037
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006038 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6040 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006041cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 if (ret != 0) {
6043 status = mbedtls_to_psa_error(ret);
6044 }
6045 if (status != PSA_SUCCESS) {
6046 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006047 *data = NULL;
6048 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 mbedtls_mpi_free(&k);
6050 mbedtls_mpi_free(&diff_N_2);
6051 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006052}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006053
6054/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6055 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6056 *
6057 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6058 * draw a 32-byte string and process it as specified in
6059 * Elliptic Curves for Security [RFC7748] §5.
6060 *
6061 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6062 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6063 *
6064 * Note: Function allocates memory for *data buffer, so given *data should be
6065 * always NULL.
6066 */
6067
6068static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6069 size_t bits,
6070 psa_key_derivation_operation_t *operation,
6071 uint8_t **data
6072 )
6073{
6074 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006075 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006076
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006078 case 255:
6079 output_length = 32;
6080 break;
6081 case 448:
6082 output_length = 56;
6083 break;
6084 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006086 break;
6087 }
6088
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006090
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 if (*data == NULL) {
6092 return PSA_ERROR_INSUFFICIENT_MEMORY;
6093 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006094
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006096
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006098 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006100
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006102 case 255:
6103 (*data)[0] &= 248;
6104 (*data)[31] &= 127;
6105 (*data)[31] |= 64;
6106 break;
6107 case 448:
6108 (*data)[0] &= 252;
6109 (*data)[55] |= 128;
6110 break;
6111 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006113 break;
6114 }
6115
6116 return status;
6117}
Valerio Setti86587ab2023-06-27 13:09:30 +02006118#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6119static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6120 psa_key_slot_t *slot, size_t bits,
6121 psa_key_derivation_operation_t *operation, uint8_t **data)
6122{
6123 (void) slot;
6124 (void) bits;
6125 (void) operation;
6126 (void) data;
6127 return PSA_ERROR_NOT_SUPPORTED;
6128}
6129
6130static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6131 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6132{
6133 (void) bits;
6134 (void) operation;
6135 (void) data;
6136 return PSA_ERROR_NOT_SUPPORTED;
6137}
6138#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6139#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006140
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006141static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006142 psa_key_slot_t *slot,
6143 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006145{
6146 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306148 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006149 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006150 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006151
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6153 return PSA_ERROR_INVALID_ARGUMENT;
6154 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006155
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006156#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006157 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6159 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6160 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006161 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6163 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006164 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 }
6166 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006167 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6169 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006170 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006172 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006173 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006174#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006175 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 if (key_type_is_raw_bytes(slot->attr.type)) {
6177 if (bits % 8 != 0) {
6178 return PSA_ERROR_INVALID_ARGUMENT;
6179 }
6180 data = mbedtls_calloc(1, bytes);
6181 if (data == NULL) {
6182 return PSA_ERROR_INSUFFICIENT_MEMORY;
6183 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006184
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 status = psa_key_derivation_output_bytes(operation, data, bytes);
6186 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006187 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 }
David Brown12ca5032021-02-11 11:02:00 -07006189#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6191 psa_des_set_key_parity(data, bytes);
6192 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006193#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 } else {
6195 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006196 }
Ronald Crondd04d422020-11-28 15:14:42 +01006197
Ronald Cronbf33c932020-11-28 18:06:53 +01006198 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006199 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006200 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006201 };
6202
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6204 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6205 &storage_size);
6206 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306207 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 }
Archanad8a83dc2021-06-14 10:04:16 +05306209 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 status = psa_allocate_buffer_to_slot(slot, storage_size);
6211 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306212 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 }
Archanad8a83dc2021-06-14 10:04:16 +05306214
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 status = psa_driver_wrapper_import_key(&attributes,
6216 data, bytes,
6217 slot->key.data,
6218 slot->key.bytes,
6219 &slot->key.bytes, &bits);
6220 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006221 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006223
6224exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006225 mbedtls_free(data);
6226 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006227}
6228
Gilles Peskine449bd832023-01-11 14:50:10 +01006229psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6230 psa_key_derivation_operation_t *operation,
6231 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006232{
6233 psa_status_t status;
6234 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006235 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006236
Ronald Cron81709fc2020-11-14 12:10:32 +01006237 *key = MBEDTLS_SVC_KEY_ID_INIT;
6238
Gilles Peskine0f84d622019-09-12 19:03:13 +02006239 /* Reject any attempt to create a zero-length key so that we don't
6240 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 if (psa_get_key_bits(attributes) == 0) {
6242 return PSA_ERROR_INVALID_ARGUMENT;
6243 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006244
Gilles Peskine449bd832023-01-11 14:50:10 +01006245 if (operation->alg == PSA_ALG_NONE) {
6246 return PSA_ERROR_BAD_STATE;
6247 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006248
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 if (!operation->can_output_key) {
6250 return PSA_ERROR_NOT_PERMITTED;
6251 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006252
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6254 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006255#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006257 /* Deriving a key in a secure element is not implemented yet. */
6258 status = PSA_ERROR_NOT_SUPPORTED;
6259 }
6260#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 if (status == PSA_SUCCESS) {
6262 status = psa_generate_derived_key_internal(slot,
6263 attributes->core.bits,
6264 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006265 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 if (status == PSA_SUCCESS) {
6267 status = psa_finish_key_creation(slot, driver, key);
6268 }
6269 if (status != PSA_SUCCESS) {
6270 psa_fail_key_creation(slot, driver);
6271 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006272
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006274}
6275
Gilles Peskineeab56e42018-07-12 17:12:33 +02006276
6277
6278/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006279/* Key derivation */
6280/****************************************************************/
6281
Steven Cooreman932ffb72021-02-15 12:14:32 +01006282#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006283static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006284{
6285#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6287 return 1;
6288 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006289#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006290#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6292 return 1;
6293 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006294#endif
6295#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6297 return 1;
6298 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006299#endif
6300#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6302 return 1;
6303 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006304#endif
6305#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6307 return 1;
6308 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006309#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006310#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6312 return 1;
6313 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006314#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306315#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6316 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6317 return 1;
6318 }
6319#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306320#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6321 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6322 return 1;
6323 }
6324#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006326}
6327
Gilles Peskine449bd832023-01-11 14:50:10 +01006328static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006329{
6330 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 psa_status_t status = psa_hash_setup(&operation, alg);
6332 psa_hash_abort(&operation);
6333 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006334}
6335
Gilles Peskine969c5d62019-01-16 15:53:06 +01006336static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006337 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006339{
Janos Follath5fe19732019-06-20 15:09:30 +01006340 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6341 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006343
Gilles Peskine969c5d62019-01-16 15:53:06 +01006344 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 if (!is_kdf_alg_supported(kdf_alg)) {
6346 return PSA_ERROR_NOT_SUPPORTED;
6347 }
John Durkop07cc04a2020-11-16 22:08:34 -08006348
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006349 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306350 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6352 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306353 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6354 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6355 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306356 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306357 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 if (hash_size == 0) {
6359 return PSA_ERROR_NOT_SUPPORTED;
6360 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006361
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006362 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6363 * we might fail later, which is somewhat unfriendly and potentially
6364 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006365 psa_status_t status = psa_hash_try_support(hash_alg);
6366 if (status != PSA_SUCCESS) {
6367 return status;
6368 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006369 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006370
Gilles Peskine449bd832023-01-11 14:50:10 +01006371 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6372 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6373 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6374 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006375 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006376#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006377 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6379 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006380 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006382#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6383 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 operation->capacity = 255 * hash_size;
6385 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006386}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006387
Gilles Peskine449bd832023-01-11 14:50:10 +01006388static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006389{
6390#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 if (alg == PSA_ALG_ECDH) {
6392 return PSA_SUCCESS;
6393 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006394#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006395#if defined(PSA_WANT_ALG_FFDH)
6396 if (alg == PSA_ALG_FFDH) {
6397 return PSA_SUCCESS;
6398 }
6399#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006400 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006401 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006402}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006403
6404static int psa_key_derivation_allows_free_form_secret_input(
6405 psa_algorithm_t kdf_alg)
6406{
6407#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6408 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6409 return 0;
6410 }
6411#endif
6412 (void) kdf_alg;
6413 return 1;
6414}
John Durkop07cc04a2020-11-16 22:08:34 -08006415#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006416
Gilles Peskine449bd832023-01-11 14:50:10 +01006417psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6418 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006419{
6420 psa_status_t status;
6421
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 if (operation->alg != 0) {
6423 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006424 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6427 return PSA_ERROR_INVALID_ARGUMENT;
6428 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6429#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6430 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6431 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6432 status = psa_key_agreement_try_support(ka_alg);
6433 if (status != PSA_SUCCESS) {
6434 return status;
6435 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006436 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6437 return PSA_ERROR_INVALID_ARGUMENT;
6438 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006439 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6440#else
6441 return PSA_ERROR_NOT_SUPPORTED;
6442#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6443 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6444#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6445 status = psa_key_derivation_setup_kdf(operation, alg);
6446#else
6447 return PSA_ERROR_NOT_SUPPORTED;
6448#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6449 } else {
6450 return PSA_ERROR_INVALID_ARGUMENT;
6451 }
6452
6453 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006454 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 }
6456 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006457}
6458
Przemek Stekiel69c46792022-06-10 12:59:51 +02006459#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006460static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6461 psa_algorithm_t kdf_alg,
6462 psa_key_derivation_step_t step,
6463 const uint8_t *data,
6464 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006465{
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006467 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006469 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006470#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6472 return PSA_ERROR_INVALID_ARGUMENT;
6473 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006474#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 if (hkdf->state != HKDF_STATE_INIT) {
6476 return PSA_ERROR_BAD_STATE;
6477 } else {
6478 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6479 hash_alg,
6480 data, data_length);
6481 if (status != PSA_SUCCESS) {
6482 return status;
6483 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006484 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006485 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006486 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006487 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006488#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006490 /* We shouldn't be in different state as HKDF_EXPAND only allows
6491 * two inputs: SECRET (this case) and INFO which does not modify
6492 * the state. It could happen only if the hkdf
6493 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 if (hkdf->state != HKDF_STATE_INIT) {
6495 return PSA_ERROR_BAD_STATE;
6496 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006497
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006498 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006499 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6500 return PSA_ERROR_INVALID_ARGUMENT;
6501 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006502
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 memcpy(hkdf->prk, data, data_length);
6504 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006505#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006506 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006507 /* HKDF: If no salt was provided, use an empty salt.
6508 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006510#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6512 return PSA_ERROR_BAD_STATE;
6513 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006514#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6516 hash_alg,
6517 NULL, 0);
6518 if (status != PSA_SUCCESS) {
6519 return status;
6520 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006521 hkdf->state = HKDF_STATE_STARTED;
6522 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 if (hkdf->state != HKDF_STATE_STARTED) {
6524 return PSA_ERROR_BAD_STATE;
6525 }
6526 status = psa_mac_update(&hkdf->hmac,
6527 data, data_length);
6528 if (status != PSA_SUCCESS) {
6529 return status;
6530 }
6531 status = psa_mac_sign_finish(&hkdf->hmac,
6532 hkdf->prk,
6533 sizeof(hkdf->prk),
6534 &data_length);
6535 if (status != PSA_SUCCESS) {
6536 return status;
6537 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006538 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006539
Gilles Peskine2b522db2019-04-12 15:11:49 +02006540 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006541 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006542#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006544 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006546 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006548#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006549 {
6550 /* Block 0 is empty, and the next block will be
6551 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006553 }
6554
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006556 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006557#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6559 return PSA_ERROR_INVALID_ARGUMENT;
6560 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006561#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006562#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6564 hkdf->state == HKDF_STATE_INIT) {
6565 return PSA_ERROR_BAD_STATE;
6566 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006567#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 if (hkdf->state == HKDF_STATE_OUTPUT) {
6569 return PSA_ERROR_BAD_STATE;
6570 }
6571 if (hkdf->info_set) {
6572 return PSA_ERROR_BAD_STATE;
6573 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006574 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 if (data_length != 0) {
6576 hkdf->info = mbedtls_calloc(1, data_length);
6577 if (hkdf->info == NULL) {
6578 return PSA_ERROR_INSUFFICIENT_MEMORY;
6579 }
6580 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006581 }
6582 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006583 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006584 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006586 }
6587}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006588#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006589
John Durkop07cc04a2020-11-16 22:08:34 -08006590#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6591 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006592static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6593 const uint8_t *data,
6594 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006595{
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6597 return PSA_ERROR_BAD_STATE;
6598 }
Janos Follathf08e2652019-06-13 09:05:41 +01006599
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 if (data_length != 0) {
6601 prf->seed = mbedtls_calloc(1, data_length);
6602 if (prf->seed == NULL) {
6603 return PSA_ERROR_INSUFFICIENT_MEMORY;
6604 }
Janos Follathf08e2652019-06-13 09:05:41 +01006605
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006607 prf->seed_length = data_length;
6608 }
Janos Follathf08e2652019-06-13 09:05:41 +01006609
Gilles Peskine43f958b2020-12-13 14:55:14 +01006610 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006611
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006613}
6614
Gilles Peskine449bd832023-01-11 14:50:10 +01006615static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6616 const uint8_t *data,
6617 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006618{
Gilles Peskine449bd832023-01-11 14:50:10 +01006619 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6620 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6621 return PSA_ERROR_BAD_STATE;
6622 }
Janos Follath81550542019-06-13 14:26:34 +01006623
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 if (data_length != 0) {
6625 prf->secret = mbedtls_calloc(1, data_length);
6626 if (prf->secret == NULL) {
6627 return PSA_ERROR_INSUFFICIENT_MEMORY;
6628 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006629
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006631 prf->secret_length = data_length;
6632 }
Janos Follath81550542019-06-13 14:26:34 +01006633
Gilles Peskine43f958b2020-12-13 14:55:14 +01006634 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006635
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006637}
6638
Gilles Peskine449bd832023-01-11 14:50:10 +01006639static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6640 const uint8_t *data,
6641 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006642{
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6644 return PSA_ERROR_BAD_STATE;
6645 }
Janos Follath63028dd2019-06-13 09:15:47 +01006646
Gilles Peskine449bd832023-01-11 14:50:10 +01006647 if (data_length != 0) {
6648 prf->label = mbedtls_calloc(1, data_length);
6649 if (prf->label == NULL) {
6650 return PSA_ERROR_INSUFFICIENT_MEMORY;
6651 }
Janos Follath63028dd2019-06-13 09:15:47 +01006652
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006654 prf->label_length = data_length;
6655 }
Janos Follath63028dd2019-06-13 09:15:47 +01006656
Gilles Peskine43f958b2020-12-13 14:55:14 +01006657 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006658
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006660}
6661
Gilles Peskine449bd832023-01-11 14:50:10 +01006662static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6663 psa_key_derivation_step_t step,
6664 const uint8_t *data,
6665 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006666{
Gilles Peskine449bd832023-01-11 14:50:10 +01006667 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006668 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006669 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006670 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006671 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006672 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006673 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006674 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006676 }
6677}
John Durkop07cc04a2020-11-16 22:08:34 -08006678#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6679 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6680
6681#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6682static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6683 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006684 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006686{
6687 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006688 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6689 4 + data_length + prf->other_secret_length :
6690 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006691
Gilles Peskine449bd832023-01-11 14:50:10 +01006692 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6693 return PSA_ERROR_INVALID_ARGUMENT;
6694 }
John Durkop07cc04a2020-11-16 22:08:34 -08006695
Gilles Peskine449bd832023-01-11 14:50:10 +01006696 uint8_t *pms = mbedtls_calloc(1, pms_len);
6697 if (pms == NULL) {
6698 return PSA_ERROR_INSUFFICIENT_MEMORY;
6699 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006700 uint8_t *cur = pms;
6701
6702 /* pure-PSK:
6703 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006704 *
6705 * The premaster secret is formed as follows: if the PSK is N octets
6706 * long, concatenate a uint16 with the value N, N zero octets, a second
6707 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006708 *
6709 * mixed-PSK:
6710 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6711 * follows: concatenate a uint16 with the length of the other secret,
6712 * the other secret itself, uint16 with the length of PSK, and the
6713 * PSK itself.
6714 * For details please check:
6715 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6716 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6717 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006718 */
6719
Gilles Peskine449bd832023-01-11 14:50:10 +01006720 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6721 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6722 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6723 if (prf->other_secret_length != 0) {
6724 memcpy(cur, prf->other_secret, prf->other_secret_length);
6725 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006726 cur += prf->other_secret_length;
6727 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 } else {
6729 *cur++ = MBEDTLS_BYTE_1(data_length);
6730 *cur++ = MBEDTLS_BYTE_0(data_length);
6731 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006732 cur += data_length;
6733 }
6734
Gilles Peskine449bd832023-01-11 14:50:10 +01006735 *cur++ = MBEDTLS_BYTE_1(data_length);
6736 *cur++ = MBEDTLS_BYTE_0(data_length);
6737 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006738 cur += data_length;
6739
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006740 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006741
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006742 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006744}
Janos Follath6660f0e2019-06-17 08:44:03 +01006745
Przemek Stekiele47201b2022-04-19 13:53:28 +02006746static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6747 psa_tls12_prf_key_derivation_t *prf,
6748 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006750{
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6752 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006753 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006754
6755 if (data_length != 0) {
6756 prf->other_secret = mbedtls_calloc(1, data_length);
6757 if (prf->other_secret == NULL) {
6758 return PSA_ERROR_INSUFFICIENT_MEMORY;
6759 }
6760
6761 memcpy(prf->other_secret, data, data_length);
6762 prf->other_secret_length = data_length;
6763 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006764 prf->other_secret_length = 0;
6765 }
6766
6767 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6768
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006770}
6771
Janos Follath6660f0e2019-06-17 08:44:03 +01006772static psa_status_t psa_tls12_prf_psk_to_ms_input(
6773 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006774 psa_key_derivation_step_t step,
6775 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006777{
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006779 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 return psa_tls12_prf_psk_to_ms_set_key(prf,
6781 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006782 break;
6783 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6785 data,
6786 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006787 break;
6788 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006790 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006791
Przemek Stekiele47201b2022-04-19 13:53:28 +02006792 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006793}
John Durkop07cc04a2020-11-16 22:08:34 -08006794#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006795
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006796#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6797static psa_status_t psa_tls12_ecjpake_to_pms_input(
6798 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006799 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006800 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006802{
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6804 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6805 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006806 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006807
6808 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 if (data[0] != 0x04) {
6810 return PSA_ERROR_INVALID_ARGUMENT;
6811 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006812
6813 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006815
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006817}
6818#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306819
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306820#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306821static psa_status_t psa_pbkdf2_set_input_cost(
6822 psa_pbkdf2_key_derivation_t *pbkdf2,
6823 psa_key_derivation_step_t step,
6824 uint64_t data)
6825{
6826 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6827 return PSA_ERROR_INVALID_ARGUMENT;
6828 }
6829
6830 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6831 return PSA_ERROR_BAD_STATE;
6832 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306833
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306834 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306835 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306836 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306837
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306838 if (data == 0) {
6839 return PSA_ERROR_INVALID_ARGUMENT;
6840 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306841
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306842 pbkdf2->input_cost = data;
6843 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6844
6845 return PSA_SUCCESS;
6846}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306847
6848static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6849 const uint8_t *data,
6850 size_t data_length)
6851{
Gilles Peskineead17662023-08-20 22:02:51 +02006852 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6853 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6854 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6855 /* Appending to existing salt. No state change. */
6856 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306857 return PSA_ERROR_BAD_STATE;
6858 }
6859
Gilles Peskineca57d782023-07-20 19:08:06 +02006860 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006861 /* Appending an empty string, nothing to do. */
6862 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306863 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306864
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306865 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6866 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306867 return PSA_ERROR_INSUFFICIENT_MEMORY;
6868 }
6869
Gilles Peskineead17662023-08-20 22:02:51 +02006870 if (pbkdf2->salt_length != 0) {
6871 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6872 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306873 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306874 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306875 mbedtls_free(pbkdf2->salt);
6876 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306877 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306878 return PSA_SUCCESS;
6879}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306880
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306881#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306882static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306883 const uint8_t *input,
6884 size_t input_len,
6885 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306886 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306887{
6888 psa_status_t status = PSA_SUCCESS;
6889 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6890 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306891 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306892 } else {
6893 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306894 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306895 }
6896 return status;
6897}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306898#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306899
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306900#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306901static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6902 size_t input_len,
6903 uint8_t *output,
6904 size_t *output_len)
6905{
6906 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306907 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306908 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306909 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306910 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6911 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6912 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306913 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306914 * mac_size as the driver function sets mac_output_length = mac_size
6915 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306916 status = psa_driver_wrapper_mac_compute(&attributes,
6917 zeros, sizeof(zeros),
6918 PSA_ALG_CMAC, input, input_len,
6919 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306920 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6921 128U,
6922 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306923 output_len);
6924 } else {
6925 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306926 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306927 }
6928 return status;
6929}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306930#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306931
6932static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306933 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306934 const uint8_t *data,
6935 size_t data_length)
6936{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306937 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306938 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6939 return PSA_ERROR_BAD_STATE;
6940 }
6941
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306942#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306943 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6944 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6945 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6946 pbkdf2->password,
6947 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306948 } else
6949#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6950#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6951 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306952 status = psa_pbkdf2_cmac_set_password(data, data_length,
6953 pbkdf2->password,
6954 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306955 } else
6956#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6957 {
6958 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306959 }
6960
6961 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6962
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306963 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306964}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306965
6966static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306967 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306968 psa_key_derivation_step_t step,
6969 const uint8_t *data,
6970 size_t data_length)
6971{
6972 switch (step) {
6973 case PSA_KEY_DERIVATION_INPUT_SALT:
6974 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6975 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306976 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306977 default:
6978 return PSA_ERROR_INVALID_ARGUMENT;
6979 }
6980}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306981#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306982
Gilles Peskineb8965192019-09-24 16:21:10 +02006983/** Check whether the given key type is acceptable for the given
6984 * input step of a key derivation.
6985 *
6986 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6987 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6988 * Both secret and non-secret inputs can alternatively have the type
6989 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6990 * that the input was passed as a buffer rather than via a key object.
6991 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006992static int psa_key_derivation_check_input_type(
6993 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006995{
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006997 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 if (key_type == PSA_KEY_TYPE_DERIVE) {
6999 return PSA_SUCCESS;
7000 }
7001 if (key_type == PSA_KEY_TYPE_NONE) {
7002 return PSA_SUCCESS;
7003 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007004 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007005 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 if (key_type == PSA_KEY_TYPE_DERIVE) {
7007 return PSA_SUCCESS;
7008 }
7009 if (key_type == PSA_KEY_TYPE_NONE) {
7010 return PSA_SUCCESS;
7011 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007012 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007013 case PSA_KEY_DERIVATION_INPUT_LABEL:
7014 case PSA_KEY_DERIVATION_INPUT_SALT:
7015 case PSA_KEY_DERIVATION_INPUT_INFO:
7016 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7018 return PSA_SUCCESS;
7019 }
7020 if (key_type == PSA_KEY_TYPE_NONE) {
7021 return PSA_SUCCESS;
7022 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007023 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307024 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7025 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7026 return PSA_SUCCESS;
7027 }
7028 if (key_type == PSA_KEY_TYPE_DERIVE) {
7029 return PSA_SUCCESS;
7030 }
7031 if (key_type == PSA_KEY_TYPE_NONE) {
7032 return PSA_SUCCESS;
7033 }
7034 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007035 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007037}
7038
Janos Follathb80a94e2019-06-12 15:54:46 +01007039static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007040 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007041 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007042 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007043 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007044 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007045{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007046 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007048
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 status = psa_key_derivation_check_input_type(step, key_type);
7050 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007051 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007053
Przemek Stekiel69c46792022-06-10 12:59:51 +02007054#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7056 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7057 step, data, data_length);
7058 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007059#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007060#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7062 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7063 step, data, data_length);
7064 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007065#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7066#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007067 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7068 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7069 step, data, data_length);
7070 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007071#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007072#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007073 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007074 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7076 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007077#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307078#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307079 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307080 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7081 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307082 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307083#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007084 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007085 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007086 (void) data;
7087 (void) data_length;
7088 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007090 }
7091
Gilles Peskine224b0d62019-09-23 18:13:17 +02007092exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 if (status != PSA_SUCCESS) {
7094 psa_key_derivation_abort(operation);
7095 }
7096 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007097}
7098
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307099static psa_status_t psa_key_derivation_input_integer_internal(
7100 psa_key_derivation_operation_t *operation,
7101 psa_key_derivation_step_t step,
7102 uint64_t value)
7103{
7104 psa_status_t status;
7105 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7106
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307107#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307108 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307109 status = psa_pbkdf2_set_input_cost(
7110 &operation->ctx.pbkdf2, step, value);
7111 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307112#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307113 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307114 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307115 (void) value;
7116 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307117 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307118 }
7119
7120 if (status != PSA_SUCCESS) {
7121 psa_key_derivation_abort(operation);
7122 }
7123 return status;
7124}
7125
Janos Follath51f4a0f2019-06-14 11:35:55 +01007126psa_status_t psa_key_derivation_input_bytes(
7127 psa_key_derivation_operation_t *operation,
7128 psa_key_derivation_step_t step,
7129 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007131{
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 return psa_key_derivation_input_internal(operation, step,
7133 PSA_KEY_TYPE_NONE,
7134 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007135}
7136
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307137psa_status_t psa_key_derivation_input_integer(
7138 psa_key_derivation_operation_t *operation,
7139 psa_key_derivation_step_t step,
7140 uint64_t value)
7141{
7142 return psa_key_derivation_input_integer_internal(operation, step, value);
7143}
7144
Janos Follath51f4a0f2019-06-14 11:35:55 +01007145psa_status_t psa_key_derivation_input_key(
7146 psa_key_derivation_operation_t *operation,
7147 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007149{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007150 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007151 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007152 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007153
Ronald Cron5c522922020-11-14 16:35:34 +01007154 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7156 if (status != PSA_SUCCESS) {
7157 psa_key_derivation_abort(operation);
7158 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007159 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007160
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307161 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7162 * permission to output to a key object. */
7163 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7164 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007165 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007167
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 status = psa_key_derivation_input_internal(operation,
7169 step, slot->attr.type,
7170 slot->key.data,
7171 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007172
Ryan Everett1b70a072024-01-04 10:32:49 +00007173 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007174
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007176}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007177
7178
7179
7180/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007181/* Key agreement */
7182/****************************************************************/
7183
Gilles Peskine449bd832023-01-11 14:50:10 +01007184psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7185 const uint8_t *key_buffer,
7186 size_t key_buffer_size,
7187 psa_algorithm_t alg,
7188 const uint8_t *peer_key,
7189 size_t peer_key_length,
7190 uint8_t *shared_secret,
7191 size_t shared_secret_size,
7192 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007193{
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007195#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007196 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7198 key_buffer_size, alg,
7199 peer_key, peer_key_length,
7200 shared_secret,
7201 shared_secret_size,
7202 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007203#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007204
7205#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7206 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007207 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007208 peer_key,
7209 peer_key_length,
7210 key_buffer,
7211 key_buffer_size,
7212 shared_secret,
7213 shared_secret_size,
7214 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007215#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7216
Gilles Peskine01d718c2018-09-18 12:01:02 +02007217 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007218 (void) attributes;
7219 (void) key_buffer;
7220 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007221 (void) peer_key;
7222 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007223 (void) shared_secret;
7224 (void) shared_secret_size;
7225 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007227 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007228}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007229
Aditya Deshpande17845b82022-10-13 17:21:01 +01007230/** Internal function for raw key agreement
7231 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007232 * to the driver's implementation if a driver is present.
7233 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007234 * (psa_key_agreement_raw_builtin).
7235 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007236static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7237 psa_key_slot_t *private_key,
7238 const uint8_t *peer_key,
7239 size_t peer_key_length,
7240 uint8_t *shared_secret,
7241 size_t shared_secret_size,
7242 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007243{
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7245 return PSA_ERROR_NOT_SUPPORTED;
7246 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007247
7248 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007250 };
7251
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 return psa_driver_wrapper_key_agreement(&attributes,
7253 private_key->key.data,
7254 private_key->key.bytes, alg,
7255 peer_key, peer_key_length,
7256 shared_secret,
7257 shared_secret_size,
7258 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007259}
7260
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007261/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007262 * to potentially free embedded data structures and wipe confidential data.
7263 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007264static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7265 psa_key_derivation_step_t step,
7266 psa_key_slot_t *private_key,
7267 const uint8_t *peer_key,
7268 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007269{
7270 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007271 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007272 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007274
7275 /* Step 1: run the secret agreement algorithm to generate the shared
7276 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 status = psa_key_agreement_raw_internal(ka_alg,
7278 private_key,
7279 peer_key, peer_key_length,
7280 shared_secret,
7281 sizeof(shared_secret),
7282 &shared_secret_length);
7283 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007284 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007286
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007287 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007288 * the shared secret. A shared secret is permitted wherever a key
7289 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 status = psa_key_derivation_input_internal(operation, step,
7291 PSA_KEY_TYPE_DERIVE,
7292 shared_secret,
7293 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007294exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7296 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007297}
7298
Gilles Peskine449bd832023-01-11 14:50:10 +01007299psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7300 psa_key_derivation_step_t step,
7301 mbedtls_svc_key_id_t private_key,
7302 const uint8_t *peer_key,
7303 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007304{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007305 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007306 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007307 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007308
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7310 return PSA_ERROR_INVALID_ARGUMENT;
7311 }
Ronald Cron5c522922020-11-14 16:35:34 +01007312 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007313 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7314 if (status != PSA_SUCCESS) {
7315 return status;
7316 }
7317 status = psa_key_agreement_internal(operation, step,
7318 slot,
7319 peer_key, peer_key_length);
7320 if (status != PSA_SUCCESS) {
7321 psa_key_derivation_abort(operation);
7322 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007323 /* If a private key has been added as SECRET, we allow the derived
7324 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007326 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007328 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007329
Ryan Everett1b70a072024-01-04 10:32:49 +00007330 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007331
Gilles Peskine449bd832023-01-11 14:50:10 +01007332 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007333}
7334
Gilles Peskine449bd832023-01-11 14:50:10 +01007335psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7336 mbedtls_svc_key_id_t private_key,
7337 const uint8_t *peer_key,
7338 size_t peer_key_length,
7339 uint8_t *output,
7340 size_t output_size,
7341 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007342{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007343 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007344 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007345 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007346 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007347
Gilles Peskine449bd832023-01-11 14:50:10 +01007348 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007349 status = PSA_ERROR_INVALID_ARGUMENT;
7350 goto exit;
7351 }
Ronald Cron5c522922020-11-14 16:35:34 +01007352 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7354 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007355 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007357
Gilles Peskine3e561302022-04-14 00:17:15 +02007358 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7359 * for the output size. The PSA specification only guarantees that this
7360 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7361 * but it might be nice to allow smaller buffers if the output fits.
7362 * At the time of writing this comment, with only ECDH implemented,
7363 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7364 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7365 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007366 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007367 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7368 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007369 status = PSA_ERROR_BUFFER_TOO_SMALL;
7370 goto exit;
7371 }
7372
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 status = psa_key_agreement_raw_internal(alg, slot,
7374 peer_key, peer_key_length,
7375 output, output_size,
7376 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007377
7378exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007380 /* If an error happens and is not handled properly, the output
7381 * may be used as a key to protect sensitive data. Arrange for such
7382 * a key to be random, which is likely to result in decryption or
7383 * verification errors. This is better than filling the buffer with
7384 * some constant data such as zeros, which would result in the data
7385 * being protected with a reproducible, easily knowable key.
7386 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007388 *output_length = output_size;
7389 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007390
Ryan Everett1b70a072024-01-04 10:32:49 +00007391 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007392
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007394}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007395
7396
Gilles Peskine30524eb2020-11-13 17:02:26 +01007397
Gilles Peskine86a440b2018-11-12 18:39:40 +01007398/****************************************************************/
7399/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007400/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007401
Gilles Peskine672a7712023-04-28 21:00:28 +02007402#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7403#include "entropy_poll.h"
7404#endif
7405
Gilles Peskine30524eb2020-11-13 17:02:26 +01007406/** Initialize the PSA random generator.
7407 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007408static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007409{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007410#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007412#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7413
Gilles Peskine30524eb2020-11-13 17:02:26 +01007414 /* Set default configuration if
7415 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007417 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 }
7419 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007420 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007422
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007424#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7425 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7426 /* The PSA entropy injection feature depends on using NV seed as an entropy
7427 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 mbedtls_entropy_add_source(&rng->entropy,
7429 mbedtls_nv_seed_poll, NULL,
7430 MBEDTLS_ENTROPY_BLOCK_SIZE,
7431 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007432#endif
7433
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007435#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007436}
7437
7438/** Deinitialize the PSA random generator.
7439 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007440static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007441{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007442#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007443 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007444#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007445 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7446 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007447#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007448}
7449
7450/** Seed the PSA random generator.
7451 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007452static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007453{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007454#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7455 /* Do nothing: the external RNG seeds itself. */
7456 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007458#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007459 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7461 drbg_seed, sizeof(drbg_seed) - 1);
7462 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007463#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007464}
7465
Gilles Peskine449bd832023-01-11 14:50:10 +01007466psa_status_t psa_generate_random(uint8_t *output,
7467 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007468{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007469 GUARD_MODULE_INITIALIZED;
7470
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007471#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7472
7473 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7475 output, output_size,
7476 &output_length);
7477 if (status != PSA_SUCCESS) {
7478 return status;
7479 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007480 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007481 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 if (output_length != output_size) {
7483 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7484 }
7485 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007486
7487#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007490 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7492 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7493 output_size);
7494 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7495 output, request_size);
7496 if (ret != 0) {
7497 return mbedtls_to_psa_error(ret);
7498 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007499 output_size -= request_size;
7500 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007501 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007503#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007504}
7505
Gilles Peskine8814fc42020-12-14 15:33:44 +01007506/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007507 *
7508 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7509 * `psa_generate_random(...)`. The state parameter is ignored since the
7510 * PSA API doesn't support passing an explicit state.
7511 *
7512 * In the non-external case, psa_generate_random() calls an
7513 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7514 * and semantics as mbedtls_psa_get_random(). As an optimization,
7515 * instead of doing this back-and-forth between the PSA API and the
7516 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7517 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007518 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007519#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7520int mbedtls_psa_get_random(void *p_rng,
7521 unsigned char *output,
7522 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007523{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007524 /* This function takes a pointer to the RNG state because that's what
7525 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7526 * its own state internally and doesn't let the caller access that state.
7527 * So we just ignore the state parameter, and in practice we'll pass
7528 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007529 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 psa_status_t status = psa_generate_random(output, output_size);
7531 if (status == PSA_SUCCESS) {
7532 return 0;
7533 } else {
7534 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7535 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007536}
7537#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7538
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007539#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007540psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7541 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007542{
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 if (global_data.initialized) {
7544 return PSA_ERROR_NOT_PERMITTED;
7545 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007546
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7548 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7549 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7550 return PSA_ERROR_INVALID_ARGUMENT;
7551 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007552
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007554}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007555#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007556
Ronald Cron3772afe2021-02-08 16:10:05 +01007557/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007558 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007559 * \param type The key type
7560 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007561 *
7562 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007563 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007564 * \retval #PSA_ERROR_INVALID_ARGUMENT
7565 * The size in bits of the key is not valid.
7566 * \retval #PSA_ERROR_NOT_SUPPORTED
7567 * The type and/or the size in bits of the key or the combination of
7568 * the two is not supported.
7569 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007570static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007572{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007573 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007574
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 if (key_type_is_raw_bytes(type)) {
7576 status = psa_validate_unstructured_key_bit_size(type, bits);
7577 if (status != PSA_SUCCESS) {
7578 return status;
7579 }
7580 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007581#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7583 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7584 return PSA_ERROR_NOT_SUPPORTED;
7585 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007586 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007587 return PSA_ERROR_NOT_SUPPORTED;
7588 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007589
Ronald Cron01b2aba2020-10-05 09:42:02 +02007590 /* Accept only byte-aligned keys, for the same reasons as
7591 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 if (bits % 8 != 0) {
7593 return PSA_ERROR_NOT_SUPPORTED;
7594 }
7595 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007596#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007597
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007598#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007600 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 return PSA_SUCCESS;
7602 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007603#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007604
Valerio Settia55f0422023-07-10 15:34:41 +02007605#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007606 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007607 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007608 return PSA_ERROR_NOT_SUPPORTED;
7609 }
7610 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007611#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007612 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007614 }
7615
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007617}
7618
Ronald Cron55ed0592020-10-05 10:30:40 +02007619psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007620 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007622{
7623 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007624 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007625
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 if ((attributes->domain_parameters == NULL) &&
7627 (attributes->domain_parameters_size != 0)) {
7628 return PSA_ERROR_INVALID_ARGUMENT;
7629 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 if (key_type_is_raw_bytes(type)) {
7632 status = psa_generate_random(key_buffer, key_buffer_size);
7633 if (status != PSA_SUCCESS) {
7634 return status;
7635 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007636
David Brown12ca5032021-02-11 11:02:00 -07007637#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 if (type == PSA_KEY_TYPE_DES) {
7639 psa_des_set_key_parity(key_buffer, key_buffer_size);
7640 }
David Brown8107e312021-02-12 08:08:46 -07007641#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007643
Valerio Setti76df8c12023-07-11 14:11:28 +02007644#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7646 return mbedtls_psa_rsa_generate_key(attributes,
7647 key_buffer,
7648 key_buffer_size,
7649 key_buffer_length);
7650 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007651#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007652
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007653#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7655 return mbedtls_psa_ecp_generate_key(attributes,
7656 key_buffer,
7657 key_buffer_size,
7658 key_buffer_length);
7659 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007660#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007661
Valerio Settia55f0422023-07-10 15:34:41 +02007662#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007663 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7664 return mbedtls_psa_ffdh_generate_key(attributes,
7665 key_buffer,
7666 key_buffer_size,
7667 key_buffer_length);
7668 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007669#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007670 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 (void) key_buffer_length;
7672 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007673 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007674
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007676}
Darryl Green0c6575a2018-11-07 16:05:30 +00007677
Gilles Peskine449bd832023-01-11 14:50:10 +01007678psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7679 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007680{
7681 psa_status_t status;
7682 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007683 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007684 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007685
Ronald Cron81709fc2020-11-14 12:10:32 +01007686 *key = MBEDTLS_SVC_KEY_ID_INIT;
7687
Gilles Peskine0f84d622019-09-12 19:03:13 +02007688 /* Reject any attempt to create a zero-length key so that we don't
7689 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007690 if (psa_get_key_bits(attributes) == 0) {
7691 return PSA_ERROR_INVALID_ARGUMENT;
7692 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007693
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007694 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7696 return PSA_ERROR_INVALID_ARGUMENT;
7697 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007698
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7700 &slot, &driver);
7701 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007702 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 }
Gilles Peskine11792082019-08-06 18:36:36 +02007704
Ronald Cron977c2472020-10-13 08:32:21 +02007705 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307706 * storage ( thus not in the case of generating a key in a secure element
7707 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7708 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 if (slot->key.data == NULL) {
7710 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7711 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007712 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007713 attributes->core.type, attributes->core.bits);
7714 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007715 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007717
7718 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 attributes->core.type,
7720 attributes->core.bits);
7721 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007722 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 attributes, &key_buffer_size);
7724 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007725 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007726 }
Ronald Cron977c2472020-10-13 08:32:21 +02007727 }
Ronald Cron977c2472020-10-13 08:32:21 +02007728
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7730 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007731 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007732 }
Ronald Cron977c2472020-10-13 08:32:21 +02007733 }
7734
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 status = psa_driver_wrapper_generate_key(attributes,
7736 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007737
Gilles Peskine449bd832023-01-11 14:50:10 +01007738 if (status != PSA_SUCCESS) {
7739 psa_remove_key_data_from_memory(slot);
7740 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007741
Gilles Peskine11792082019-08-06 18:36:36 +02007742exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 if (status == PSA_SUCCESS) {
7744 status = psa_finish_key_creation(slot, driver, key);
7745 }
7746 if (status != PSA_SUCCESS) {
7747 psa_fail_key_creation(slot, driver);
7748 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007749
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007751}
7752
Gilles Peskinee59236f2018-01-27 23:32:46 +01007753/****************************************************************/
7754/* Module setup */
7755/****************************************************************/
7756
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007757#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007758psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007759 void (* entropy_init)(mbedtls_entropy_context *ctx),
7760 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007761{
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7763 return PSA_ERROR_BAD_STATE;
7764 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007765 global_data.rng.entropy_init = entropy_init;
7766 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007768}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007769#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007770
Gilles Peskine449bd832023-01-11 14:50:10 +01007771void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007772{
Gilles Peskine449bd832023-01-11 14:50:10 +01007773 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007774 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7775 mbedtls_psa_random_free(&global_data.rng);
7776 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007777 /* Wipe all remaining data, including configuration.
7778 * In particular, this sets all state indicator to the value
7779 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007780 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007781
7782 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007784}
7785
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007786#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7787/** Recover a transaction that was interrupted by a power failure.
7788 *
7789 * This function is called during initialization, before psa_crypto_init()
7790 * returns. If this function returns a failure status, the initialization
7791 * fails.
7792 */
7793static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007795{
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007797 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7798 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 /* TODO - fall through to the failure case until this
7800 * is implemented.
7801 * https://github.com/ARMmbed/mbed-crypto/issues/218
7802 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007803 default:
7804 /* We found an unsupported transaction in the storage.
7805 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007807 }
7808}
7809#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7810
Gilles Peskine449bd832023-01-11 14:50:10 +01007811psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007812{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007813 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007814
Gilles Peskinec6b69072018-11-20 21:42:52 +01007815 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 if (global_data.initialized != 0) {
7817 return PSA_SUCCESS;
7818 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007819
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007820 /* Init drivers */
7821 status = psa_driver_wrapper_init();
7822 if (status != PSA_SUCCESS) {
7823 goto exit;
7824 }
7825 global_data.drivers_initialized = 1;
7826
Valerio Setti402cfba2023-11-13 10:24:32 +01007827 status = psa_initialize_key_slots();
7828 if (status != PSA_SUCCESS) {
7829 goto exit;
7830 }
7831
Gilles Peskine30524eb2020-11-13 17:02:26 +01007832 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007834 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007835 status = mbedtls_psa_random_seed(&global_data.rng);
7836 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007837 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007839 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007840
Gilles Peskine4b734222019-07-24 15:56:31 +02007841#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 status = psa_crypto_load_transaction();
7843 if (status == PSA_SUCCESS) {
7844 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7845 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007846 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007847 }
7848 status = psa_crypto_stop_transaction();
7849 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007850 /* There's no transaction to complete. It's all good. */
7851 status = PSA_SUCCESS;
7852 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007853#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007854
Gilles Peskinec6b69072018-11-20 21:42:52 +01007855 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007856 global_data.initialized = 1;
7857
7858exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007859 if (status != PSA_SUCCESS) {
7860 mbedtls_psa_crypto_free();
7861 }
7862 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007863}
7864
Yanray Wangffc3c482023-07-11 12:01:04 +08007865#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007866psa_status_t psa_crypto_driver_pake_get_password_len(
7867 const psa_crypto_driver_pake_inputs_t *inputs,
7868 size_t *password_len)
7869{
7870 if (inputs->password_len == 0) {
7871 return PSA_ERROR_BAD_STATE;
7872 }
7873
7874 *password_len = inputs->password_len;
7875
7876 return PSA_SUCCESS;
7877}
7878
7879psa_status_t psa_crypto_driver_pake_get_password(
7880 const psa_crypto_driver_pake_inputs_t *inputs,
7881 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7882{
7883 if (inputs->password_len == 0) {
7884 return PSA_ERROR_BAD_STATE;
7885 }
7886
7887 if (buffer_size < inputs->password_len) {
7888 return PSA_ERROR_BUFFER_TOO_SMALL;
7889 }
7890
7891 memcpy(buffer, inputs->password, inputs->password_len);
7892 *buffer_length = inputs->password_len;
7893
7894 return PSA_SUCCESS;
7895}
7896
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007897psa_status_t psa_crypto_driver_pake_get_user_len(
7898 const psa_crypto_driver_pake_inputs_t *inputs,
7899 size_t *user_len)
7900{
7901 if (inputs->user_len == 0) {
7902 return PSA_ERROR_BAD_STATE;
7903 }
7904
7905 *user_len = inputs->user_len;
7906
7907 return PSA_SUCCESS;
7908}
7909
7910psa_status_t psa_crypto_driver_pake_get_user(
7911 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007912 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007913{
7914 if (inputs->user_len == 0) {
7915 return PSA_ERROR_BAD_STATE;
7916 }
7917
Przemek Stekielc0e62502023-03-14 11:49:36 +01007918 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007919 return PSA_ERROR_BUFFER_TOO_SMALL;
7920 }
7921
Przemek Stekielc0e62502023-03-14 11:49:36 +01007922 memcpy(user_id, inputs->user, inputs->user_len);
7923 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007924
7925 return PSA_SUCCESS;
7926}
7927
7928psa_status_t psa_crypto_driver_pake_get_peer_len(
7929 const psa_crypto_driver_pake_inputs_t *inputs,
7930 size_t *peer_len)
7931{
7932 if (inputs->peer_len == 0) {
7933 return PSA_ERROR_BAD_STATE;
7934 }
7935
7936 *peer_len = inputs->peer_len;
7937
7938 return PSA_SUCCESS;
7939}
7940
7941psa_status_t psa_crypto_driver_pake_get_peer(
7942 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007943 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007944{
7945 if (inputs->peer_len == 0) {
7946 return PSA_ERROR_BAD_STATE;
7947 }
7948
Przemek Stekielc0e62502023-03-14 11:49:36 +01007949 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007950 return PSA_ERROR_BUFFER_TOO_SMALL;
7951 }
7952
Przemek Stekielc0e62502023-03-14 11:49:36 +01007953 memcpy(peer_id, inputs->peer, inputs->peer_len);
7954 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007955
7956 return PSA_SUCCESS;
7957}
7958
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007959psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7960 const psa_crypto_driver_pake_inputs_t *inputs,
7961 psa_pake_cipher_suite_t *cipher_suite)
7962{
7963 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7964 return PSA_ERROR_BAD_STATE;
7965 }
7966
7967 *cipher_suite = inputs->cipher_suite;
7968
7969 return PSA_SUCCESS;
7970}
7971
Neil Armstronga7d08c32022-06-01 18:21:20 +02007972psa_status_t psa_pake_setup(
7973 psa_pake_operation_t *operation,
7974 const psa_pake_cipher_suite_t *cipher_suite)
7975{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007976 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007977
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007978 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007979 status = PSA_ERROR_BAD_STATE;
7980 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007981 }
7982
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007983 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007984 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007985 status = PSA_ERROR_INVALID_ARGUMENT;
7986 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007987 }
7988
Przemek Stekiel51eac532022-12-07 11:04:51 +01007989 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7990
Przemek Stekiele12ed362022-12-21 12:54:46 +01007991 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007992 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7993 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007994 operation->data.inputs.cipher_suite = *cipher_suite;
7995
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007996#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007997 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007998 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007999 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008000
David Horstmann16f01512023-06-14 17:21:07 +01008001 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008002 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008003 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008004#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008005 {
8006 status = PSA_ERROR_NOT_SUPPORTED;
8007 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008008 }
8009
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008010 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8011
Przemek Stekiel51eac532022-12-07 11:04:51 +01008012 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008013exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008014 psa_pake_abort(operation);
8015 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008016}
8017
8018psa_status_t psa_pake_set_password_key(
8019 psa_pake_operation_t *operation,
8020 mbedtls_svc_key_id_t password)
8021{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008022 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008023 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8024 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008025 psa_key_attributes_t attributes;
8026 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008027
Przemek Stekiel51eac532022-12-07 11:04:51 +01008028 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008029 status = PSA_ERROR_BAD_STATE;
8030 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008031 }
8032
Przemek Stekiel6c764412022-11-22 14:05:12 +01008033 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8034 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008035 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008036 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008037 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008038 }
8039
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008040 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008041 .core = slot->attr
8042 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008043
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008044 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008045
Przemek Stekiel51eac532022-12-07 11:04:51 +01008046 if (type != PSA_KEY_TYPE_PASSWORD &&
8047 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8048 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008049 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008050 }
8051
Przemek Stekiel51eac532022-12-07 11:04:51 +01008052 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8053 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008054 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008055 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008056 }
8057
8058 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8059 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008060 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008061exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008062 if (status != PSA_SUCCESS) {
8063 psa_pake_abort(operation);
8064 }
Ryan Everett1b70a072024-01-04 10:32:49 +00008065 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008066 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008067}
8068
8069psa_status_t psa_pake_set_user(
8070 psa_pake_operation_t *operation,
8071 const uint8_t *user_id,
8072 size_t user_id_len)
8073{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008074 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008075
8076 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008077 status = PSA_ERROR_BAD_STATE;
8078 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008079 }
8080
Przemek Stekiel51eac532022-12-07 11:04:51 +01008081 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008082 status = PSA_ERROR_INVALID_ARGUMENT;
8083 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008084 }
8085
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008086 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008087 status = PSA_ERROR_BAD_STATE;
8088 goto exit;
8089 }
8090
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008091 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8092 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008093 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8094 goto exit;
8095 }
8096
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008097 memcpy(operation->data.inputs.user, user_id, user_id_len);
8098 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008099
8100 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008101exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008102 psa_pake_abort(operation);
8103 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008104}
8105
8106psa_status_t psa_pake_set_peer(
8107 psa_pake_operation_t *operation,
8108 const uint8_t *peer_id,
8109 size_t peer_id_len)
8110{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008111 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008112
8113 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008114 status = PSA_ERROR_BAD_STATE;
8115 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008116 }
8117
Przemek Stekiel51eac532022-12-07 11:04:51 +01008118 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008119 status = PSA_ERROR_INVALID_ARGUMENT;
8120 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008121 }
8122
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008123 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008124 status = PSA_ERROR_BAD_STATE;
8125 goto exit;
8126 }
8127
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008128 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8129 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008130 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8131 goto exit;
8132 }
8133
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008134 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8135 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008136
8137 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008138exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008139 psa_pake_abort(operation);
8140 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008141}
8142
8143psa_status_t psa_pake_set_role(
8144 psa_pake_operation_t *operation,
8145 psa_pake_role_t role)
8146{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008147 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008148
Przemek Stekiel51eac532022-12-07 11:04:51 +01008149 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008150 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008151 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008152 }
8153
Przemek Stekiel09104b82023-03-06 14:11:51 +01008154 switch (operation->alg) {
8155#if defined(PSA_WANT_ALG_JPAKE)
8156 case PSA_ALG_JPAKE:
8157 if (role == PSA_PAKE_ROLE_NONE) {
8158 return PSA_SUCCESS;
8159 }
8160 status = PSA_ERROR_INVALID_ARGUMENT;
8161 break;
8162#endif
8163 default:
8164 (void) role;
8165 status = PSA_ERROR_NOT_SUPPORTED;
8166 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008167 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008168exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008169 psa_pake_abort(operation);
8170 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008171}
8172
David Horstmanne7f21e62023-05-12 18:17:21 +01008173/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008174#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008175static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008176 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008177{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008178 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008179 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008180 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008181
David Horstmann024e5c52023-06-14 15:48:21 +01008182 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008183 is_x1 = (stage->outputs < 1);
8184 } else {
8185 is_x1 = (stage->inputs < 1);
8186 }
8187
David Horstmann74a3d8c2023-06-14 18:28:19 +01008188 key_share_step = is_x1 ?
8189 PSA_JPAKE_X1_STEP_KEY_SHARE :
8190 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008191 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008192 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8193 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8194 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8195 } else {
8196 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008197 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008198 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008199}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008200#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008201
Przemek Stekiel2797d372022-12-22 11:19:22 +01008202static psa_status_t psa_pake_complete_inputs(
8203 psa_pake_operation_t *operation)
8204{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008205 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008206 /* Create copy of the inputs on stack as inputs share memory
8207 with the driver context which will be setup by the driver. */
8208 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008209
Przemek Stekielfde11282023-03-13 16:06:09 +01008210 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008211 return PSA_ERROR_BAD_STATE;
8212 }
8213
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008214 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008215 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8216 return PSA_ERROR_BAD_STATE;
8217 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008218 }
8219
Przemek Stekiel18620a32023-01-17 16:34:52 +01008220 /* Clear driver context */
8221 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8222
8223 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008224
8225 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008226 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008227
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008228 /* User and peer are translated to role. */
8229 mbedtls_free(inputs.user);
8230 mbedtls_free(inputs.peer);
8231
Przemek Stekiel2797d372022-12-22 11:19:22 +01008232 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008233#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008234 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008235 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008236 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008237#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008238 {
8239 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008240 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008241 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008242 return status;
8243}
8244
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008245#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008246static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008247 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008248 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008249 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008250{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008251 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8252 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8253 step != PSA_PAKE_STEP_ZK_PROOF) {
8254 return PSA_ERROR_INVALID_ARGUMENT;
8255 }
8256
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008257 psa_jpake_computation_stage_t *computation_stage =
8258 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008259
David Horstmann5da95602023-06-08 15:37:12 +01008260 if (computation_stage->round != PSA_JPAKE_FIRST &&
8261 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008262 return PSA_ERROR_BAD_STATE;
8263 }
8264
David Horstmanne7f21e62023-05-12 18:17:21 +01008265 /* Check that the step we are given is the one we were expecting */
8266 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008267 return PSA_ERROR_BAD_STATE;
8268 }
8269
David Horstmanne7f21e62023-05-12 18:17:21 +01008270 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8271 computation_stage->inputs == 0 &&
8272 computation_stage->outputs == 0) {
8273 /* Start of the round, so function decides whether we are inputting
8274 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008275 computation_stage->io_mode = io_mode;
8276 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008277 /* Middle of the round so the mode we are in must match the function
8278 * called by the user */
8279 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008280 }
8281
8282 return PSA_SUCCESS;
8283}
8284
David Horstmanne7f21e62023-05-12 18:17:21 +01008285static psa_status_t psa_jpake_epilogue(
8286 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008287 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008288{
David Horstmanne7f21e62023-05-12 18:17:21 +01008289 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008290 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008291
David Horstmanne7f21e62023-05-12 18:17:21 +01008292 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8293 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008294 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008295 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008296 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008297 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008298 }
8299 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008300 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008301 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008302 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008303 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008304 }
8305 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008306 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8307 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008308 /* End of a round, move to the next round */
8309 stage->inputs = 0;
8310 stage->outputs = 0;
8311 stage->round++;
8312 }
8313 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008314 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008315 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008316 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008317 return PSA_SUCCESS;
8318}
David Horstmanne7f21e62023-05-12 18:17:21 +01008319
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008320#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008321
Neil Armstronga7d08c32022-06-01 18:21:20 +02008322psa_status_t psa_pake_output(
8323 psa_pake_operation_t *operation,
8324 psa_pake_step_t step,
8325 uint8_t *output,
8326 size_t output_size,
8327 size_t *output_length)
8328{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008329 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008330 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008331 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008332
8333 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008334 status = psa_pake_complete_inputs(operation);
8335 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008336 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008337 }
8338 }
8339
8340 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008341 status = PSA_ERROR_BAD_STATE;
8342 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008343 }
8344
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008345 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008346 status = PSA_ERROR_INVALID_ARGUMENT;
8347 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008348 }
8349
Przemek Stekiele12ed362022-12-21 12:54:46 +01008350 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008351#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008352 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008353 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008354 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008355 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008356 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008357 driver_step = convert_jpake_computation_stage_to_driver_step(
8358 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008359 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008360#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008361 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008362 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008363 status = PSA_ERROR_NOT_SUPPORTED;
8364 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008365 }
8366
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008367 status = psa_driver_wrapper_pake_output(operation, driver_step,
8368 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008369
8370 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008371 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008372 }
8373
8374 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008375#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008376 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008377 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008378 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008379 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008380 }
8381 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008382#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008383 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008384 status = PSA_ERROR_NOT_SUPPORTED;
8385 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008386 }
8387
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008388 return PSA_SUCCESS;
8389exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008390 psa_pake_abort(operation);
8391 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008392}
8393
8394psa_status_t psa_pake_input(
8395 psa_pake_operation_t *operation,
8396 psa_pake_step_t step,
8397 const uint8_t *input,
8398 size_t input_length)
8399{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008400 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008401 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008402 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8403 operation->primitive,
8404 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008405
8406 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008407 status = psa_pake_complete_inputs(operation);
8408 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008409 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008410 }
8411 }
8412
8413 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008414 status = PSA_ERROR_BAD_STATE;
8415 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008416 }
8417
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008418 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008419 status = PSA_ERROR_INVALID_ARGUMENT;
8420 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008421 }
8422
Przemek Stekiele12ed362022-12-21 12:54:46 +01008423 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008424#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008425 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008426 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008427 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008428 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008429 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008430 driver_step = convert_jpake_computation_stage_to_driver_step(
8431 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008432 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008433#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008434 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008435 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008436 status = PSA_ERROR_NOT_SUPPORTED;
8437 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008438 }
8439
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008440 status = psa_driver_wrapper_pake_input(operation, driver_step,
8441 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008442
8443 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008444 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008445 }
8446
8447 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008448#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008449 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008450 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008451 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008452 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008453 }
8454 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008455#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008456 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008457 status = PSA_ERROR_NOT_SUPPORTED;
8458 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008459 }
8460
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008461 return PSA_SUCCESS;
8462exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008463 psa_pake_abort(operation);
8464 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008465}
8466
8467psa_status_t psa_pake_get_implicit_key(
8468 psa_pake_operation_t *operation,
8469 psa_key_derivation_operation_t *output)
8470{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008471 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008472 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008473 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008474 size_t shared_key_len = 0;
8475
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008476 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008477 status = PSA_ERROR_BAD_STATE;
8478 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008479 }
8480
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008481#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008482 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008483 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008484 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008485 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008486 status = PSA_ERROR_BAD_STATE;
8487 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008488 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008489 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008490#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008491 {
8492 status = PSA_ERROR_NOT_SUPPORTED;
8493 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008494 }
8495
Przemek Stekiel0c781802022-11-29 14:53:13 +01008496 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8497 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008498 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008499 &shared_key_len);
8500
8501 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008502 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008503 }
8504
8505 status = psa_key_derivation_input_bytes(output,
8506 PSA_KEY_DERIVATION_INPUT_SECRET,
8507 shared_key,
8508 shared_key_len);
8509
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008510 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008511exit:
8512 abort_status = psa_pake_abort(operation);
8513 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008514}
8515
8516psa_status_t psa_pake_abort(
8517 psa_pake_operation_t *operation)
8518{
Przemek Stekield69dca92023-01-31 19:59:20 +01008519 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008520
Przemek Stekield69dca92023-01-31 19:59:20 +01008521 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008522 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008523 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008524
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008525 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8526 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008527 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008528 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008529 }
8530 if (operation->data.inputs.user != NULL) {
8531 mbedtls_free(operation->data.inputs.user);
8532 }
8533 if (operation->data.inputs.peer != NULL) {
8534 mbedtls_free(operation->data.inputs.peer);
8535 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008536 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008537 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008538
Przemek Stekield69dca92023-01-31 19:59:20 +01008539 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008540}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008541#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008542
David Horstmann00d7a042023-12-07 18:39:17 +00008543/* Memory copying test hooks. These are called before input copy, after input
8544 * copy, before output copy and after output copy, respectively.
8545 * They are used by memory-poisoning tests to temporarily unpoison buffers
8546 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008547#if defined(MBEDTLS_TEST_HOOKS)
8548void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8549void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8550void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8551void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8552#endif
David Horstmannfde97392023-10-30 20:29:43 +00008553
David Horstmann1b7279a2023-11-15 15:18:30 +00008554/** Copy from an input buffer to a local copy.
8555 *
8556 * \param[in] input Pointer to input buffer.
8557 * \param[in] input_len Length of the input buffer.
8558 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8559 * \param[out] input_copy_len Length of the local copy buffer.
8560 * \return #PSA_SUCCESS, if the buffer was successfully
8561 * copied.
8562 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8563 * copy is too small to hold contents of the
8564 * input buffer.
8565 */
8566MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008567psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8568 uint8_t *input_copy, size_t input_copy_len)
8569{
8570 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008571 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008572 }
8573
David Horstmann372b8bb2023-11-24 16:21:04 +00008574#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008575 if (psa_input_pre_copy_hook != NULL) {
8576 psa_input_pre_copy_hook(input, input_len);
8577 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008578#endif
8579
David Horstmann777e7412023-11-15 17:33:47 +00008580 if (input_len > 0) {
8581 memcpy(input_copy, input, input_len);
8582 }
David Horstmannfde97392023-10-30 20:29:43 +00008583
David Horstmann372b8bb2023-11-24 16:21:04 +00008584#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008585 if (psa_input_post_copy_hook != NULL) {
8586 psa_input_post_copy_hook(input, input_len);
8587 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008588#endif
8589
David Horstmannfde97392023-10-30 20:29:43 +00008590 return PSA_SUCCESS;
8591}
8592
David Horstmann1b7279a2023-11-15 15:18:30 +00008593/** Copy from a local output buffer into a user-supplied one.
8594 *
8595 * \param[in] output_copy Pointer to a local buffer containing the output.
8596 * \param[in] output_copy_len Length of the local buffer.
8597 * \param[out] output Pointer to user-supplied output buffer.
8598 * \param[out] output_len Length of the user-supplied output buffer.
8599 * \return #PSA_SUCCESS, if the buffer was successfully
8600 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008601 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008602 * user-supplied output buffer is too small to
8603 * hold the contents of the local buffer.
8604 */
8605MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008606psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8607 uint8_t *output, size_t output_len)
8608{
8609 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008610 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008611 }
David Horstmann777e7412023-11-15 17:33:47 +00008612
David Horstmann372b8bb2023-11-24 16:21:04 +00008613#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008614 if (psa_output_pre_copy_hook != NULL) {
8615 psa_output_pre_copy_hook(output, output_len);
8616 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008617#endif
8618
David Horstmann777e7412023-11-15 17:33:47 +00008619 if (output_copy_len > 0) {
8620 memcpy(output, output_copy, output_copy_len);
8621 }
8622
David Horstmann372b8bb2023-11-24 16:21:04 +00008623#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008624 if (psa_output_post_copy_hook != NULL) {
8625 psa_output_post_copy_hook(output, output_len);
8626 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008627#endif
8628
David Horstmann8978f5c2023-10-30 20:37:12 +00008629 return PSA_SUCCESS;
8630}
8631
David Horstmannf1734052023-11-20 17:15:32 +00008632psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8633 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008634{
8635 psa_status_t status;
8636
David Horstmann9db14482023-11-23 15:50:37 +00008637 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008638
David Horstmannc5cc1c32023-11-15 18:11:26 +00008639 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008640 return PSA_SUCCESS;
8641 }
8642
David Horstmannf1734052023-11-20 17:15:32 +00008643 local_input->buffer = mbedtls_calloc(input_len, 1);
8644 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008645 /* Since we dealt with the zero-length case above, we know that
8646 * a NULL return value means a failure of allocation. */
8647 return PSA_ERROR_INSUFFICIENT_MEMORY;
8648 }
David Horstmannf1734052023-11-20 17:15:32 +00008649 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008650
David Horstmannf1734052023-11-20 17:15:32 +00008651 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008652
8653 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008654 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008655 if (status != PSA_SUCCESS) {
8656 goto error;
8657 }
8658
8659 return PSA_SUCCESS;
8660
8661error:
David Horstmannf1734052023-11-20 17:15:32 +00008662 mbedtls_free(local_input->buffer);
8663 local_input->buffer = NULL;
8664 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008665 return status;
8666}
8667
David Horstmannf1734052023-11-20 17:15:32 +00008668void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008669{
David Horstmannf1734052023-11-20 17:15:32 +00008670 mbedtls_free(local_input->buffer);
8671 local_input->buffer = NULL;
8672 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008673}
8674
David Horstmann89875a42023-11-20 12:54:09 +00008675psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8676 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008677{
David Horstmann9db14482023-11-23 15:50:37 +00008678 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008679
David Horstmannc5cc1c32023-11-15 18:11:26 +00008680 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008681 return PSA_SUCCESS;
8682 }
David Horstmann89875a42023-11-20 12:54:09 +00008683 local_output->buffer = mbedtls_calloc(output_len, 1);
8684 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008685 /* Since we dealt with the zero-length case above, we know that
8686 * a NULL return value means a failure of allocation. */
8687 return PSA_ERROR_INSUFFICIENT_MEMORY;
8688 }
David Horstmann89875a42023-11-20 12:54:09 +00008689 local_output->length = output_len;
8690 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008691
8692 return PSA_SUCCESS;
8693}
8694
Gabor Mezei1882c512024-01-24 13:07:17 +01008695psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8696 psa_crypto_local_output_t *local_output)
8697{
8698 psa_status_t status;
8699 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8700
8701 if (output_len == 0) {
8702 return PSA_SUCCESS;
8703 }
8704 local_output->buffer = mbedtls_calloc(output_len, 1);
8705 if (local_output->buffer == NULL) {
8706 /* Since we dealt with the zero-length case above, we know that
8707 * a NULL return value means a failure of allocation. */
8708 return PSA_ERROR_INSUFFICIENT_MEMORY;
8709 }
8710 local_output->length = output_len;
8711 local_output->original = output;
8712
8713 status = psa_crypto_copy_input(output, output_len,
8714 local_output->buffer, local_output->length);
8715 if (status != PSA_SUCCESS) {
8716 goto error;
8717 }
8718
8719 return PSA_SUCCESS;
8720
8721error:
8722 mbedtls_free(local_output->buffer);
8723 local_output->buffer = NULL;
8724 local_output->length = 0;
8725 return status;
8726}
8727
David Horstmann89875a42023-11-20 12:54:09 +00008728psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008729{
David Horstmannc335a4e2023-11-15 15:57:32 +00008730 psa_status_t status;
8731
David Horstmann89875a42023-11-20 12:54:09 +00008732 if (local_output->buffer == NULL) {
8733 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008734 return PSA_SUCCESS;
8735 }
David Horstmann89875a42023-11-20 12:54:09 +00008736 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008737 /* We have an internal copy but nothing to copy back to. */
8738 return PSA_ERROR_CORRUPTION_DETECTED;
8739 }
8740
David Horstmann89875a42023-11-20 12:54:09 +00008741 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8742 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008743 if (status != PSA_SUCCESS) {
8744 return status;
8745 }
David Horstmann9467ea32023-11-08 17:44:18 +00008746
David Horstmann89875a42023-11-20 12:54:09 +00008747 mbedtls_free(local_output->buffer);
8748 local_output->buffer = NULL;
8749 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008750
8751 return PSA_SUCCESS;
8752}
8753
Gilles Peskinee59236f2018-01-27 23:32:46 +01008754#endif /* MBEDTLS_PSA_CRYPTO_C */