blob: 70500aab3d0234be92085136776eed2836c978ea [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
David Horstmann62a56d92023-12-14 18:12:47 +0000189/* Free the local output copy allocated previously by LOCAL_OUTPUT_ALLOC()
David Horstmann3e72db42023-12-08 14:08:18 +0000190 * after first copying back its contents to the original buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000191 *
David Horstmann3e72db42023-12-08 14:08:18 +0000192 * Assumptions:
David Horstmann3e72db42023-12-08 14:08:18 +0000193 * - psa_status_t status exists
David Horstmann62a56d92023-12-14 18:12:47 +0000194 * - output_copy is the name of the output copy pointer set by LOCAL_OUTPUT_ALLOC()
195 * - output is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000196 */
David Horstmann62a56d92023-12-14 18:12:47 +0000197#define LOCAL_OUTPUT_FREE(output, output_copy) \
198 output_copy = NULL; \
David Horstmann5a945f52023-12-13 14:09:08 +0000199 do { \
200 psa_status_t local_output_status; \
David Horstmann36df4b22023-12-13 15:55:25 +0000201 local_output_status = psa_crypto_local_output_free(&LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmann5a945f52023-12-13 14:09:08 +0000202 if (local_output_status != PSA_SUCCESS) { \
203 /* Since this error case is an internal error, it's more serious than \
204 * any existing error code and so it's fine to overwrite the existing \
205 * status. */ \
206 status = local_output_status; \
207 } \
208 } while (0)
David Horstmann513101b2023-11-29 17:24:08 +0000209#else /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmann62a56d92023-12-14 18:12:47 +0000210#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
211 const uint8_t *input_copy_name = NULL;
212#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
213 input_copy = input;
214#define LOCAL_INPUT_FREE(input, input_copy) \
215 input_copy = NULL;
216#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
217 uint8_t *output_copy_name = NULL;
218#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
219 output_copy = output;
220#define LOCAL_OUTPUT_FREE(output, output_copy) \
221 output_copy = NULL;
David Horstmann513101b2023-11-29 17:24:08 +0000222#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000223
224
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100225int psa_can_do_hash(psa_algorithm_t hash_alg)
226{
227 (void) hash_alg;
228 return global_data.drivers_initialized;
229}
Valerio Settic6f004f2023-12-12 11:27:36 +0100230
Valerio Setti1fff4f22023-12-28 14:19:34 +0100231int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg)
Valerio Settic6f004f2023-12-12 11:27:36 +0100232{
Valerio Setti1fff4f22023-12-28 14:19:34 +0100233 (void) key_type;
Valerio Settic6f004f2023-12-12 11:27:36 +0100234 (void) cipher_alg;
235 return global_data.drivers_initialized;
236}
237
238
Valerio Settia55f0422023-07-10 15:34:41 +0200239#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200240 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200241 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200242static int psa_is_dh_key_size_valid(size_t bits)
243{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200244 if (bits != 2048 && bits != 3072 && bits != 4096 &&
245 bits != 6144 && bits != 8192) {
246 return 0;
247 }
248
249 return 1;
250}
Valerio Settia55f0422023-07-10 15:34:41 +0200251#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200252 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200253 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100254
Gilles Peskine449bd832023-01-11 14:50:10 +0100255psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100256{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100257 /* Mbed TLS error codes can combine a high-level error code and a
258 * low-level error code. The low-level error usually reflects the
259 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100260 int low_level_ret = -(-ret & 0x007f);
261 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100262 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100264
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100265#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100266 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
267 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100269 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
270 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100271#endif
272
273#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200274 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
275 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
276 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
277 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
278 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200280 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200282 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100284#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200285
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100286#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000287 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100288 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100290#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100291
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100292#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100293 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100295 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100297#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100298
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100299#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200300 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100302#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200303
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100304#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200305 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200307 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100309#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200310
Dave Rodgman509b5672023-08-16 19:26:23 +0100311#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100312 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100313 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100314 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100316 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100317 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100318 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100320 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100322 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100326#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100327
Gilles Peskine449bd832023-01-11 14:50:10 +0100328#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
329 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100330 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
331 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100332 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100334 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
335 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100336 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100337 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100339#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100340
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100341#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100342 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100344#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100345
Gilles Peskinee59236f2018-01-27 23:32:46 +0100346 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
347 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
348 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100350
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100351#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100352 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200354 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100356 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100358#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100359
Gilles Peskine82e57d12020-11-13 21:31:17 +0100360#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100362 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
363 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100364 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100366 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
367 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100369 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100371#endif
372
Dave Rodgmandea266f2023-08-31 11:52:43 +0100373#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100374 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100375 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100376 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100378 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100380#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100381 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100383#endif
384#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100385
Dave Rodgman509b5672023-08-16 19:26:23 +0100386#if defined(MBEDTLS_BIGNUM_C)
387#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100388 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100389 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100390#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100391 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100393 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100394 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100395 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100396 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100397 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100399 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100401 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100403 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100405#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100406
Dave Rodgman509b5672023-08-16 19:26:23 +0100407#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100408 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100410 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
411 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100412 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100413#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
414 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100415 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100417#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100418 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
419 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100421 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100423 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
424 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100425 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100426 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100428 case MBEDTLS_ERR_PK_INVALID_ALG:
429 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
430 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100432 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200434 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100436#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100437
Gilles Peskineff2d2002019-05-06 15:26:23 +0200438 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200440 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200442
Dave Rodgman509b5672023-08-16 19:26:23 +0100443#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100444 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100446 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100448 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100450 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100451 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100452 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
453 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100454 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100455 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100457 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100459 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100461#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200462
Dave Rodgman1dab4452023-09-01 09:59:51 +0100463#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300464 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300465 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100466 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300467 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300469 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300471 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
472 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300474 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100476 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100478
Dave Rodgman509b5672023-08-16 19:26:23 +0100479#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000480 case MBEDTLS_ERR_ECP_IN_PROGRESS:
481 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100482#endif
483#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000484
Janos Follatha13b9052019-11-22 12:48:59 +0000485 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300487
Gilles Peskinee59236f2018-01-27 23:32:46 +0100488 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100490 }
491}
492
Paul Elliottdc42ca82023-02-24 18:11:59 +0000493/**
494 * \brief For output buffers which contain "tags"
495 * (outputs that may be checked for validity like
496 * hashes, MACs and signatures), fill the unused
497 * part of the output buffer (the whole buffer on
498 * error, the trailing part on success) with
499 * something that isn't a valid tag (barring an
500 * attack on the tag and deliberately-crafted
501 * input), in case the caller doesn't check the
502 * return status properly.
503 *
504 * \param output_buffer Pointer to buffer to wipe. May not be NULL
505 * unless \p output_buffer_size is zero.
506 * \param status Status of function called to generate
507 * output_buffer originally
508 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
509 * could be NULL.
510 * \param output_buffer_length Length of data written to output_buffer, must be
511 * less than \p output_buffer_size
512 */
513static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000514 size_t output_buffer_size, size_t output_buffer_length)
515{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000516 size_t offset = 0;
517
518 if (output_buffer_size == 0) {
519 /* If output_buffer_size is 0 then we have nothing to do. We must not
520 call memset because output_buffer may be NULL in this case */
521 return;
522 }
523
524 if (status == PSA_SUCCESS) {
525 offset = output_buffer_length;
526 }
527
528 memset(output_buffer + offset, '!', output_buffer_size - offset);
529}
530
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200531
Gilles Peskine449bd832023-01-11 14:50:10 +0100532psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
533 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200534{
535 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100536 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200537 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200538 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200539 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200540 case PSA_KEY_TYPE_PASSWORD:
541 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200542 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100543#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200544 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 if (bits != 128 && bits != 192 && bits != 256) {
546 return PSA_ERROR_INVALID_ARGUMENT;
547 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200548 break;
549#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200550#if defined(PSA_WANT_KEY_TYPE_ARIA)
551 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 if (bits != 128 && bits != 192 && bits != 256) {
553 return PSA_ERROR_INVALID_ARGUMENT;
554 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200555 break;
556#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100557#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200558 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 if (bits != 128 && bits != 192 && bits != 256) {
560 return PSA_ERROR_INVALID_ARGUMENT;
561 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200562 break;
563#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100564#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200565 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100566 if (bits != 64 && bits != 128 && bits != 192) {
567 return PSA_ERROR_INVALID_ARGUMENT;
568 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200569 break;
570#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100571#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200572 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 if (bits != 256) {
574 return PSA_ERROR_INVALID_ARGUMENT;
575 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200576 break;
577#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200578 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200580 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 if (bits % 8 != 0) {
582 return PSA_ERROR_INVALID_ARGUMENT;
583 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200584
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200586}
587
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100588/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100589 *
Steven Cooremancd640932021-03-08 12:00:27 +0100590 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
591 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100592 *
593 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100594 * \param[in] key_type The key type of the key to be used with the
595 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100596 *
597 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100598 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100599 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100600 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100601 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100602MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100603 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100605{
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 if (PSA_ALG_IS_HMAC(algorithm)) {
607 if (key_type == PSA_KEY_TYPE_HMAC) {
608 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100609 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100610 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100611
Gilles Peskine449bd832023-01-11 14:50:10 +0100612 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
613 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
614 * key. */
615 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
616 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
617 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
618 * the block length (larger than 1) for block ciphers. */
619 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
620 return PSA_SUCCESS;
621 }
622 }
623 }
624
625 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100626}
627
Gilles Peskine449bd832023-01-11 14:50:10 +0100628psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
629 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200630{
Gilles Peskine449bd832023-01-11 14:50:10 +0100631 if (slot->key.data != NULL) {
632 return PSA_ERROR_ALREADY_EXISTS;
633 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200634
Gilles Peskine449bd832023-01-11 14:50:10 +0100635 slot->key.data = mbedtls_calloc(1, buffer_length);
636 if (slot->key.data == NULL) {
637 return PSA_ERROR_INSUFFICIENT_MEMORY;
638 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200639
Ronald Cronea0f8a62020-11-25 17:52:23 +0100640 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100641 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200642}
643
Gilles Peskine449bd832023-01-11 14:50:10 +0100644psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
645 const uint8_t *data,
646 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200647{
Gilles Peskine449bd832023-01-11 14:50:10 +0100648 psa_status_t status = psa_allocate_buffer_to_slot(slot,
649 data_length);
650 if (status != PSA_SUCCESS) {
651 return status;
652 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200653
Gilles Peskine449bd832023-01-11 14:50:10 +0100654 memcpy(slot->key.data, data, data_length);
655 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200656}
657
Ronald Crona0fe59f2020-11-29 11:14:53 +0100658psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100659 const psa_key_attributes_t *attributes,
660 const uint8_t *data, size_t data_length,
661 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100662 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100663{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100664 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
665 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100666
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200667 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100668 if (data_length == 0) {
669 return PSA_ERROR_NOT_SUPPORTED;
670 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200671
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 if (key_type_is_raw_bytes(type)) {
673 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200674
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
676 *bits);
677 if (status != PSA_SUCCESS) {
678 return status;
679 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200680
Ronald Crondd04d422020-11-28 15:14:42 +0100681 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100683 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200685
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return PSA_SUCCESS;
687 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200688#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200689 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100690 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200691 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100692 return PSA_ERROR_INVALID_ARGUMENT;
693 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200694 return mbedtls_psa_ffdh_import_key(attributes,
695 data, data_length,
696 key_buffer, key_buffer_size,
697 key_buffer_length,
698 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100699 }
Valerio Settia55f0422023-07-10 15:34:41 +0200700#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200701 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200702#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
704 if (PSA_KEY_TYPE_IS_ECC(type)) {
705 return mbedtls_psa_ecp_import_key(attributes,
706 data, data_length,
707 key_buffer, key_buffer_size,
708 key_buffer_length,
709 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100710 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200711#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800712 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200713#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
714 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
716 if (PSA_KEY_TYPE_IS_RSA(type)) {
717 return mbedtls_psa_rsa_import_key(attributes,
718 data, data_length,
719 key_buffer, key_buffer_size,
720 key_buffer_length,
721 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200722 }
Valerio Settife478902023-07-25 12:27:19 +0200723#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
724 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800725 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100726 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100727
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100729}
730
Gilles Peskinef603c712019-01-19 13:40:11 +0100731/** Calculate the intersection of two algorithm usage policies.
732 *
733 * Return 0 (which allows no operation) on incompatibility.
734 */
735static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100736 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100737 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100738 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100739{
Gilles Peskine549ea862019-05-22 11:45:59 +0200740 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 if (alg1 == alg2) {
742 return alg1;
743 }
Steven Cooreman03488022021-02-18 12:07:20 +0100744 /* If the policies are from the same hash-and-sign family, check
745 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100746 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
747 PSA_ALG_IS_SIGN_HASH(alg2) &&
748 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
749 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
750 return alg2;
751 }
752 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
753 return alg1;
754 }
Steven Cooreman03488022021-02-18 12:07:20 +0100755 }
756 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100757 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100758 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
760 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
761 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
762 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
763 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100764 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100765
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100766 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100767 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
768 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
769 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
770 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100771 }
772 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100773 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
774 (alg1_len <= alg2_len)) {
775 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100776 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
778 (alg2_len <= alg1_len)) {
779 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100780 }
781 }
782 /* If the policies are from the same MAC family, check whether one
783 * of them is a minimum-MAC-length policy. Calculate the most
784 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
786 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
787 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100788 /* Validate the combination of key type and algorithm. Since the base
789 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
791 return 0;
792 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100793
Steven Cooreman31a876d2021-03-03 20:47:40 +0100794 /* Get the (exact or at-least) output lengths for both sides of the
795 * requested intersection. None of the currently supported algorithms
796 * have an output length dependent on the actual key size, so setting it
797 * to a bogus value of 0 is currently OK.
798 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100799 * Note that for at-least-this-length wildcard algorithms, the output
800 * length is set to the shortest allowed length, which allows us to
801 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
803 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100804 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100805
Steven Cooremana1d83222021-02-25 10:20:29 +0100806 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
808 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
809 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100810 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100811
812 /* If only one is an at-least-this-length policy, the intersection would
813 * be the other (fixed-length) policy as long as said fixed length is
814 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100815 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
816 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100817 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
819 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100820 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100821
Steven Cooremancd640932021-03-08 12:00:27 +0100822 /* If none of them are wildcards, check whether they define the same tag
823 * length. This is still possible here when one is default-length and
824 * the other specific-length. Ensure to always return the
825 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100826 if (alg1_len == alg2_len) {
827 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
828 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100829 }
830 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100831 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100832}
833
Gilles Peskine449bd832023-01-11 14:50:10 +0100834static int psa_key_algorithm_permits(psa_key_type_t key_type,
835 psa_algorithm_t policy_alg,
836 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200837{
Gilles Peskine549ea862019-05-22 11:45:59 +0200838 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100839 if (requested_alg == policy_alg) {
840 return 1;
841 }
Steven Cooreman03488022021-02-18 12:07:20 +0100842 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
843 * and requested_alg is the same hash-and-sign family with any hash,
844 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
846 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
847 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
848 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100849 }
850 /* If policy_alg is a wildcard AEAD algorithm of the same base as
851 * the requested algorithm, check the requested tag length to be
852 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100853 if (PSA_ALG_IS_AEAD(policy_alg) &&
854 PSA_ALG_IS_AEAD(requested_alg) &&
855 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
856 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
857 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
858 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
859 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100860 }
Steven Cooremancd640932021-03-08 12:00:27 +0100861 /* If policy_alg is a MAC algorithm of the same base as the requested
862 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100863 if (PSA_ALG_IS_MAC(policy_alg) &&
864 PSA_ALG_IS_MAC(requested_alg) &&
865 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
866 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100867 /* Validate the combination of key type and algorithm. Since the policy
868 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100869 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
870 return 0;
871 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100872
Steven Cooreman31a876d2021-03-03 20:47:40 +0100873 /* Get both the requested output length for the algorithm which is to be
874 * verified, and the default output length for the base algorithm.
875 * Note that none of the currently supported algorithms have an output
876 * length dependent on actual key size, so setting it to a bogus value
877 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100878 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100879 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100880 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100881 key_type, 0,
882 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100883
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100884 /* If the policy is default-length, only allow an algorithm with
885 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100886 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
887 return requested_output_length == default_output_length;
888 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100889
890 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100891 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
893 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
894 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100895 }
896
Steven Cooremancd640932021-03-08 12:00:27 +0100897 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
898 * check for the requested MAC length to be equal to or longer than the
899 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100900 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
901 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
902 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100903 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200904 }
Steven Cooremance48e852020-10-05 16:02:45 +0200905 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200906 * a key derivation with that key agreement should also be allowed. This
907 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
909 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
910 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
911 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200912 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100913 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100914 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200915}
916
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100917/** Test whether a policy permits an algorithm.
918 *
919 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100920 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100921 * \note This function requires providing the key type for which the policy is
922 * being validated, since some algorithm policy definitions (e.g. MAC)
923 * have different properties depending on what kind of cipher it is
924 * combined with.
925 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100926 * \retval PSA_SUCCESS When \p alg is a specific algorithm
927 * allowed by the \p policy.
928 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
929 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
930 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100931 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100932static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
933 psa_key_type_t key_type,
934 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100935{
Steven Cooremand788fab2021-02-25 11:29:17 +0100936 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 if (alg == 0) {
938 return PSA_ERROR_INVALID_ARGUMENT;
939 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100940
Steven Cooreman7e39f052021-02-23 14:18:32 +0100941 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 if (PSA_ALG_IS_WILDCARD(alg)) {
943 return PSA_ERROR_INVALID_ARGUMENT;
944 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100945
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
947 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
948 return PSA_SUCCESS;
949 } else {
950 return PSA_ERROR_NOT_PERMITTED;
951 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100952}
953
Gilles Peskinef603c712019-01-19 13:40:11 +0100954/** Restrict a key policy based on a constraint.
955 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100956 * \note This function requires providing the key type for which the policy is
957 * being restricted, since some algorithm policy definitions (e.g. MAC)
958 * have different properties depending on what kind of cipher it is
959 * combined with.
960 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100961 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100962 * \param[in,out] policy The policy to restrict.
963 * \param[in] constraint The policy constraint to apply.
964 *
965 * \retval #PSA_SUCCESS
966 * \c *policy contains the intersection of the original value of
967 * \c *policy and \c *constraint.
968 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100969 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100970 * \c *policy is unchanged.
971 */
972static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100973 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100974 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100976{
977 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100978 psa_key_policy_algorithm_intersection(key_type, policy->alg,
979 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200980 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
982 constraint->alg2);
983 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
984 return PSA_ERROR_INVALID_ARGUMENT;
985 }
986 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
987 return PSA_ERROR_INVALID_ARGUMENT;
988 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100989 policy->usage &= constraint->usage;
990 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200991 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100993}
994
Przemek Stekiel061f6942022-11-30 10:51:35 +0100995/** Get the description of a key given its identifier and policy constraints
996 * and lock it.
997 *
998 * The key must have allow all the usage flags set in \p usage. If \p alg is
999 * nonzero, the key must allow operations with this algorithm. If \p alg is
1000 * zero, the algorithm is not checked.
1001 *
1002 * In case of a persistent key, the function loads the description of the key
1003 * into a key slot if not already done.
1004 *
Ryan Everett098c6652024-01-03 13:03:36 +00001005 * On success, the returned key slot has been registered for reading.
1006 * It is the responsibility of the caller to call psa_unregister_read(slot)
1007 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +01001008 */
1009static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001010 mbedtls_svc_key_id_t key,
1011 psa_key_slot_t **p_slot,
1012 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001014{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001015 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001016 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001017
Gilles Peskine449bd832023-01-11 14:50:10 +01001018 status = psa_get_and_lock_key_slot(key, p_slot);
1019 if (status != PSA_SUCCESS) {
1020 return status;
1021 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001022 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001023
1024 /* Enforce that usage policy for the key slot contains all the flags
1025 * required by the usage parameter. There is one exception: public
1026 * keys can always be exported, so we treat public key objects as
1027 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001029 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001031
Gilles Peskine449bd832023-01-11 14:50:10 +01001032 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001033 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001034 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001035 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001036
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001037 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001038 if (alg != 0) {
1039 status = psa_key_policy_permits(&slot->attr.policy,
1040 slot->attr.type,
1041 alg);
1042 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001043 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001045 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001046
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001048
1049error:
1050 *p_slot = NULL;
Ryan Everett098c6652024-01-03 13:03:36 +00001051 psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001052
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001054}
Darryl Green940d72c2018-07-13 13:18:51 +01001055
Ronald Cron5c522922020-11-14 16:35:34 +01001056/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001057 *
1058 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001059 * available, as opposed to a key in a secure element and/or to be used
1060 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001061 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001062 * This is a temporary function that may be used instead of
1063 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1064 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001065 *
Ryan Everett098c6652024-01-03 13:03:36 +00001066 * On success, the returned key slot has been registered for reading.
1067 * It is the responsibility of the caller to call psa_unregister_read(slot)
1068 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001069 */
Ronald Cron5c522922020-11-14 16:35:34 +01001070static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1071 mbedtls_svc_key_id_t key,
1072 psa_key_slot_t **p_slot,
1073 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001075{
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1077 usage, alg);
1078 if (status != PSA_SUCCESS) {
1079 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001080 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001081
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everett098c6652024-01-03 13:03:36 +00001083 psa_unregister_read(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 *p_slot = NULL;
1085 return PSA_ERROR_NOT_SUPPORTED;
1086 }
1087
1088 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001089}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001090
Gilles Peskine449bd832023-01-11 14:50:10 +01001091psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001092{
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001094 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001096
Ronald Cronea0f8a62020-11-25 17:52:23 +01001097 slot->key.data = NULL;
1098 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001099
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001101}
1102
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001103/** Completely wipe a slot in memory, including its policy.
1104 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001105psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001106{
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 /*
1110 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001111 * do our best to report an unexpected amount of registered readers or
1112 * an unexpected state.
1113 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1114 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1116 * function is called as part of the execution of a test suite, the
1117 * execution of the test suite is stopped in error if the assertion fails.
1118 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001119 switch (slot->state) {
1120 case PSA_SLOT_FULL:
1121 /* In this state psa_wipe_key_slot() must only be called if the
1122 * caller is the last reader. */
1123 case PSA_SLOT_PENDING_DELETION:
1124 /* In this state psa_wipe_key_slot() must only be called if the
1125 * caller is the last reader. */
1126 if (slot->registered_readers != 1) {
1127 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1128 status = PSA_ERROR_CORRUPTION_DETECTED;
1129 }
1130 break;
1131 case PSA_SLOT_FILLING:
1132 /* In this state registered_readers must be 0. */
1133 if (slot->registered_readers != 0) {
1134 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1135 status = PSA_ERROR_CORRUPTION_DETECTED;
1136 }
1137 break;
1138 case PSA_SLOT_EMPTY:
1139 /* The slot is already empty, it cannot be wiped. */
1140 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1141 status = PSA_ERROR_CORRUPTION_DETECTED;
1142 break;
1143 default:
1144 /* The slot's state is invalid. */
1145 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001146 }
1147
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001148 /* Multipart operations may still be using the key. This is safe
1149 * because all multipart operation objects are independent from
1150 * the key slot: if they need to access the key after the setup
1151 * phase, they have a copy of the key. Note that this means that
1152 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001153 /* At this point, key material and other type-specific content has
1154 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001155 * zeroize because the metadata is not particularly sensitive.
1156 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 memset(slot, 0, sizeof(*slot));
1158 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001159}
1160
Gilles Peskine449bd832023-01-11 14:50:10 +01001161psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001162{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001163 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001164 psa_status_t status; /* status of the last operation */
1165 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001166#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1167 psa_se_drv_table_entry_t *driver;
1168#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001169
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 if (mbedtls_svc_key_id_is_null(key)) {
1171 return PSA_SUCCESS;
1172 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001173
Ronald Cronf2911112020-10-29 17:51:10 +01001174 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001175 * Get the description of the key in a key slot, and register to read it.
1176 * In the case of a persistent key, this will load the key description
1177 * from persistent memory if not done yet.
1178 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001179 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001180 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 status = psa_get_and_lock_key_slot(key, &slot);
1182 if (status != PSA_SUCCESS) {
1183 return status;
1184 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001185
Ryan Everett7ed542e2024-01-17 11:39:09 +00001186 /* Set the key slot containing the key description's state to
1187 * PENDING_DELETION. This stops new operations from registering
1188 * to read the slot. Current readers can safely continue to access
1189 * the key within the slot; the last registered reader will
1190 * automatically wipe the slot when they call psa_unregister_read().
1191 * If the key is persistent, we can now delete the copy of the key
1192 * from memory. If the key is opaque, we require the driver to
1193 * deal with the deletion. */
Ryan Everettc70ce572024-01-03 16:04:33 +00001194 slot->state = PSA_SLOT_PENDING_DELETION;
Ronald Cronf2911112020-10-29 17:51:10 +01001195
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001197 /* Refuse the destruction of a read-only key (which may or may not work
1198 * if we attempt it, depending on whether the key is merely read-only
1199 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001200 * Just do the best we can, which is to wipe the copy in memory
1201 * (done in this function's cleanup code). */
1202 overall_status = PSA_ERROR_NOT_PERMITTED;
1203 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001204 }
1205
Gilles Peskine354f7672019-07-12 23:46:38 +02001206#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1208 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001209 /* For a key in a secure element, we need to do three things:
1210 * remove the key file in internal storage, destroy the
1211 * key inside the secure element, and update the driver's
1212 * persistent data. Start a transaction that will encompass these
1213 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001215 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001217 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001218 status = psa_crypto_save_transaction();
1219 if (status != PSA_SUCCESS) {
1220 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001221 /* We should still try to destroy the key in the secure
1222 * element and the key metadata in storage. This is especially
1223 * important if the error is that the storage is full.
1224 * But how to do it exactly without risking an inconsistent
1225 * state after a reset?
1226 * https://github.com/ARMmbed/mbed-crypto/issues/215
1227 */
1228 overall_status = status;
1229 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001230 }
1231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 status = psa_destroy_se_key(driver,
1233 psa_key_slot_get_slot_number(slot));
1234 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001235 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001237 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001238#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1239
Darryl Greend49a4992018-06-18 17:27:26 +01001240#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001242 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001243 * The slot will still hold a copy of the key until the last reader
1244 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 status = psa_destroy_persistent_key(slot->attr.id);
1246 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001247 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001249
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001250 /* TODO: other slots may have a copy of the same key. We should
1251 * invalidate them.
1252 * https://github.com/ARMmbed/mbed-crypto/issues/214
1253 */
Darryl Greend49a4992018-06-18 17:27:26 +01001254 }
1255#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001256
Gilles Peskinefc762652019-07-22 19:30:34 +02001257#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001258 if (driver != NULL) {
1259 status = psa_save_se_persistent_data(driver);
1260 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001261 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001262 }
1263 status = psa_crypto_stop_transaction();
1264 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001265 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001267 }
1268#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1269
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001270exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001271 /* Unregister from reading the slot. If we are the last active reader
1272 * then this will wipe the slot. */
1273 status = psa_unregister_read(slot);
1274 /* Prioritize CORRUPTION_DETECTED from unregistering over
1275 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001277 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001278 }
1279 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001280}
1281
Valerio Settib2bcedb2023-07-10 11:24:00 +02001282#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001283 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001284static psa_status_t psa_get_rsa_public_exponent(
1285 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001287{
1288 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001289 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001290 uint8_t *buffer = NULL;
1291 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001293
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1295 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001296 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001297 }
1298 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001299 /* It's the default value, which is reported as an empty string,
1300 * so there's nothing to do. */
1301 goto exit;
1302 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001303
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 buflen = mbedtls_mpi_size(&mpi);
1305 buffer = mbedtls_calloc(1, buflen);
1306 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001307 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1308 goto exit;
1309 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001310 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1311 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001312 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001313 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001314 attributes->domain_parameters = buffer;
1315 attributes->domain_parameters_size = buflen;
1316
1317exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 mbedtls_mpi_free(&mpi);
1319 if (ret != 0) {
1320 mbedtls_free(buffer);
1321 }
1322 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001323}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001324#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001325 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001326
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001327/** Retrieve all the publicly-accessible attributes of a key.
1328 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001329psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1330 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001331{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001332 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001333 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001334 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001335
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001337
Gilles Peskine449bd832023-01-11 14:50:10 +01001338 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1339 if (status != PSA_SUCCESS) {
1340 return status;
1341 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001342
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001343 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1345 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001346
1347#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1349 psa_set_key_slot_number(attributes,
1350 psa_key_slot_get_slot_number(slot));
1351 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001352#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001353
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001355#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1356 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001357 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001358 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001359 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001360 /* TODO: This is a temporary situation where domain parameters are deprecated,
1361 * but we need it for namely generating an RSA key with a non-default exponent.
1362 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001365 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001366
Ronald Cron90857082020-11-25 14:58:33 +01001367 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 slot->attr.type,
1369 slot->key.data,
1370 slot->key.bytes,
1371 &rsa);
1372 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001373 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 status = psa_get_rsa_public_exponent(rsa,
1377 attributes);
1378 mbedtls_rsa_free(rsa);
1379 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001380 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001381 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001382#else
1383 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1384 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1385 attributes->domain_parameters = NULL;
1386 attributes->domain_parameters_size = SIZE_MAX;
1387 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001388#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1389 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001390 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001391 default:
1392 /* Nothing else to do. */
1393 break;
1394 }
1395
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 if (status != PSA_SUCCESS) {
1397 psa_reset_key_attributes(attributes);
1398 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001399
Ryan Everett1b70a072024-01-04 10:32:49 +00001400 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001401
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001403}
1404
Gilles Peskinec8000c02019-08-02 20:15:51 +02001405#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1406psa_status_t psa_get_key_slot_number(
1407 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001409{
Gilles Peskine449bd832023-01-11 14:50:10 +01001410 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001411 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 return PSA_SUCCESS;
1413 } else {
1414 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001415 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001416}
1417#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1420 size_t key_buffer_size,
1421 uint8_t *data,
1422 size_t data_size,
1423 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001424{
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 if (key_buffer_size > data_size) {
1426 return PSA_ERROR_BUFFER_TOO_SMALL;
1427 }
1428 memcpy(data, key_buffer, key_buffer_size);
1429 memset(data + key_buffer_size, 0,
1430 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001431 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001433}
1434
Ronald Cron7285cda2020-11-26 14:46:37 +01001435psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001436 const psa_key_attributes_t *attributes,
1437 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001439{
Ronald Crond18b5f82020-11-25 16:46:05 +01001440 psa_key_type_t type = attributes->core.type;
1441
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 if (key_type_is_raw_bytes(type) ||
1443 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001444 PSA_KEY_TYPE_IS_ECC(type) ||
1445 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 return psa_export_key_buffer_internal(
1447 key_buffer, key_buffer_size,
1448 data, data_size, data_length);
1449 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001450 /* This shouldn't happen in the reference implementation, but
1451 it is valid for a special-purpose implementation to omit
1452 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001454 }
1455}
1456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1458 uint8_t *data,
1459 size_t data_size,
1460 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001461{
1462 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1463 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1464 psa_key_slot_t *slot;
1465
Ronald Crone907e552021-01-18 13:22:38 +01001466 /* Reject a zero-length output buffer now, since this can never be a
1467 * valid key representation. This way we know that data must be a valid
1468 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001469 if (data_size == 0) {
1470 return PSA_ERROR_BUFFER_TOO_SMALL;
1471 }
Ronald Crone907e552021-01-18 13:22:38 +01001472
Ronald Cron9486f9d2020-11-26 13:36:23 +01001473 /* Set the key to empty now, so that even when there are errors, we always
1474 * set data_length to a value between 0 and data_size. On error, setting
1475 * the key to empty is a good choice because an empty key representation is
1476 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001477 *data_length = 0;
1478
Ronald Cron9486f9d2020-11-26 13:36:23 +01001479 /* Export requires the EXPORT flag. There is an exception for public keys,
1480 * which don't require any flag, but
1481 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1482 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1484 PSA_KEY_USAGE_EXPORT, 0);
1485 if (status != PSA_SUCCESS) {
1486 return status;
1487 }
mohammad160306e79202018-03-28 13:17:44 +03001488
Ronald Crond18b5f82020-11-25 16:46:05 +01001489 psa_key_attributes_t attributes = {
1490 .core = slot->attr
1491 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 status = psa_driver_wrapper_export_key(&attributes,
1493 slot->key.data, slot->key.bytes,
1494 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001495
Ryan Everett1b70a072024-01-04 10:32:49 +00001496 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001497
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001499}
1500
Ronald Cron7285cda2020-11-26 14:46:37 +01001501psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001502 const psa_key_attributes_t *attributes,
1503 const uint8_t *key_buffer,
1504 size_t key_buffer_size,
1505 uint8_t *data,
1506 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001508{
Ronald Crond18b5f82020-11-25 16:46:05 +01001509 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001510
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001511 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001512 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1513 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001514 /* Exporting public -> public */
1515 return psa_export_key_buffer_internal(
1516 key_buffer, key_buffer_size,
1517 data, data_size, data_length);
1518 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001519#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001520 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1521 return mbedtls_psa_rsa_export_public_key(attributes,
1522 key_buffer,
1523 key_buffer_size,
1524 data,
1525 data_size,
1526 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001527#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001528 /* We don't know how to convert a private RSA key to public. */
1529 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001530#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001531 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001532 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001533#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001534 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1535 return mbedtls_psa_ecp_export_public_key(attributes,
1536 key_buffer,
1537 key_buffer_size,
1538 data,
1539 data_size,
1540 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001541#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001542 /* We don't know how to convert a private ECC key to public */
1543 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001544#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001545 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001546 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001547#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001548 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001549 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001550 key_buffer,
1551 key_buffer_size,
1552 data, data_size,
1553 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001554#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001555 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001556#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001557 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001559 (void) key_buffer;
1560 (void) key_buffer_size;
1561 (void) data;
1562 (void) data_size;
1563 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001565 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001566}
Ronald Crond18b5f82020-11-25 16:46:05 +01001567
Gilles Peskine449bd832023-01-11 14:50:10 +01001568psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1569 uint8_t *data,
1570 size_t data_size,
1571 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001572{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001573 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001574 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001575 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001576 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001577
Ronald Crone907e552021-01-18 13:22:38 +01001578 /* Reject a zero-length output buffer now, since this can never be a
1579 * valid key representation. This way we know that data must be a valid
1580 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001581 if (data_size == 0) {
1582 return PSA_ERROR_BUFFER_TOO_SMALL;
1583 }
Ronald Crone907e552021-01-18 13:22:38 +01001584
Darryl Greendd8fb772018-11-07 16:00:44 +00001585 /* Set the key to empty now, so that even when there are errors, we always
1586 * set data_length to a value between 0 and data_size. On error, setting
1587 * the key to empty is a good choice because an empty key representation is
1588 * unlikely to be accepted anywhere. */
1589 *data_length = 0;
1590
1591 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1593 if (status != PSA_SUCCESS) {
1594 return status;
1595 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001596
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1598 status = PSA_ERROR_INVALID_ARGUMENT;
1599 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001600 }
1601
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001602 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001603 .core = slot->attr
1604 };
Ronald Cron67227982020-11-26 15:16:05 +01001605 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001606 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001608
1609exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001610 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001611
Gilles Peskine449bd832023-01-11 14:50:10 +01001612 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001613}
1614
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001615MBEDTLS_STATIC_ASSERT(
1616 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1617 "One or more key attribute flag is listed as both external-only and dual-use")
1618MBEDTLS_STATIC_ASSERT(
1619 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1620 "One or more key attribute flag is listed as both internal-only and dual-use")
1621MBEDTLS_STATIC_ASSERT(
1622 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1623 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001624
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001625/** Validate that a key policy is internally well-formed.
1626 *
1627 * This function only rejects invalid policies. It does not validate the
1628 * consistency of the policy with respect to other attributes of the key
1629 * such as the key type.
1630 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001631static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001632{
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1634 PSA_KEY_USAGE_COPY |
1635 PSA_KEY_USAGE_ENCRYPT |
1636 PSA_KEY_USAGE_DECRYPT |
1637 PSA_KEY_USAGE_SIGN_MESSAGE |
1638 PSA_KEY_USAGE_VERIFY_MESSAGE |
1639 PSA_KEY_USAGE_SIGN_HASH |
1640 PSA_KEY_USAGE_VERIFY_HASH |
1641 PSA_KEY_USAGE_VERIFY_DERIVATION |
1642 PSA_KEY_USAGE_DERIVE)) != 0) {
1643 return PSA_ERROR_INVALID_ARGUMENT;
1644 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001645
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001647}
1648
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001649/** Validate the internal consistency of key attributes.
1650 *
1651 * This function only rejects invalid attribute values. If does not
1652 * validate the consistency of the attributes with any key data that may
1653 * be involved in the creation of the key.
1654 *
1655 * Call this function early in the key creation process.
1656 *
1657 * \param[in] attributes Key attributes for the new key.
1658 * \param[out] p_drv On any return, the driver for the key, if any.
1659 * NULL for a transparent key.
1660 *
1661 */
1662static psa_status_t psa_validate_key_attributes(
1663 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001665{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001666 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1668 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001669
Gilles Peskine449bd832023-01-11 14:50:10 +01001670 status = psa_validate_key_location(lifetime, p_drv);
1671 if (status != PSA_SUCCESS) {
1672 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001673 }
1674
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 status = psa_validate_key_persistence(lifetime);
1676 if (status != PSA_SUCCESS) {
1677 return status;
1678 }
1679
1680 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1681 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1682 return PSA_ERROR_INVALID_ARGUMENT;
1683 }
1684 } else {
1685 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1686 return PSA_ERROR_INVALID_ARGUMENT;
1687 }
1688 }
1689
1690 status = psa_validate_key_policy(&attributes->core.policy);
1691 if (status != PSA_SUCCESS) {
1692 return status;
1693 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001694
1695 /* Refuse to create overly large keys.
1696 * Note that this doesn't trigger on import if the attributes don't
1697 * explicitly specify a size (so psa_get_key_bits returns 0), so
1698 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1700 return PSA_ERROR_NOT_SUPPORTED;
1701 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001702
Gilles Peskine91e8c332019-08-02 19:19:39 +02001703 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1705 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1706 return PSA_ERROR_INVALID_ARGUMENT;
1707 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001708
Gilles Peskine449bd832023-01-11 14:50:10 +01001709 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001710}
1711
Gilles Peskine4747d192019-04-17 15:05:45 +02001712/** Prepare a key slot to receive key material.
1713 *
1714 * This function allocates a key slot and sets its metadata.
1715 *
1716 * If this function fails, call psa_fail_key_creation().
1717 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001718 * This function is intended to be used as follows:
1719 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001720 * it with the specified attributes, and in case of a volatile key assign it
1721 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001722 * -# Populate the slot with the key material.
1723 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1724 * In case of failure at any step, stop the sequence and call
1725 * psa_fail_key_creation().
1726 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001727 * On success, the key slot's state is PSA_SLOT_FILLING.
1728 * It is the responsibility of the caller to change the slot's state to
1729 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001730 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001731 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001732 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001733 * \param[out] p_slot On success, a pointer to the prepared slot.
1734 * \param[out] p_drv On any return, the driver for the key, if any.
1735 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001736 *
1737 * \retval #PSA_SUCCESS
1738 * The key slot is ready to receive key material.
1739 * \return If this function fails, the key slot is an invalid state.
1740 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001741 */
1742static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001743 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001744 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001745 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001747{
1748 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001749 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001750 psa_key_slot_t *slot;
1751
Gilles Peskinedf179142019-07-15 22:02:14 +02001752 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001753 *p_drv = NULL;
1754
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 status = psa_validate_key_attributes(attributes, p_drv);
1756 if (status != PSA_SUCCESS) {
1757 return status;
1758 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001759
Ryan Everettb69118e2024-01-02 15:54:32 +00001760 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 if (status != PSA_SUCCESS) {
1762 return status;
1763 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001764 slot = *p_slot;
1765
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001766 /* We're storing the declared bit-size of the key. It's up to each
1767 * creation mechanism to verify that this information is correct.
1768 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001769 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001770 * is optional (import, copy). In case of a volatile key, assign it the
1771 * volatile key identifier associated to the slot returned to contain its
1772 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001773
1774 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001776#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1777 slot->attr.id = volatile_key_id;
1778#else
1779 slot->attr.id.key_id = volatile_key_id;
1780#endif
1781 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001782
Gilles Peskine91e8c332019-08-02 19:19:39 +02001783 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001784 * external-only flags, query `attributes`. Thanks to the check
1785 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001786 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001787 * may have set. */
1788 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001789
Gilles Peskinecbaff462019-07-12 23:46:04 +02001790#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001791 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001792 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001793 * create the key file in internal storage, create the
1794 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001795 * persistent data. This is done by starting a transaction that will
1796 * encompass these three actions.
1797 * For registering a volatile key, we just need to find an appropriate
1798 * slot number inside the SE. Since the key is designated volatile, creating
1799 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001800 /* The first thing to do is to find a slot number for the new key.
1801 * We save the slot number in persistent storage as part of the
1802 * transaction data. It will be needed to recover if the power
1803 * fails during the key creation process, to clean up on the secure
1804 * element side after restarting. Obtaining a slot number from the
1805 * secure element driver updates its persistent state, but we do not yet
1806 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001807 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001809 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1811 &slot_number);
1812 if (status != PSA_SUCCESS) {
1813 return status;
1814 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001815
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1817 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001818 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001819 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001820 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 status = psa_crypto_save_transaction();
1822 if (status != PSA_SUCCESS) {
1823 (void) psa_crypto_stop_transaction();
1824 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001825 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001826 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001827
1828 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001830 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001831
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001833 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001835 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001836#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1837
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001839}
Gilles Peskine4747d192019-04-17 15:05:45 +02001840
1841/** Finalize the creation of a key once its key material has been set.
1842 *
1843 * This entails writing the key to persistent storage.
1844 *
1845 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001846 * See the documentation of psa_start_key_creation() for the intended use
1847 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001848 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001849 * If the finalization succeeds, the function sets the key slot's state to
1850 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1851 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001852 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001853 * \param[in,out] slot Pointer to the slot with key material.
1854 * \param[in] driver The secure element driver for the key,
1855 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001856 * \param[out] key On success, identifier of the key. Note that the
1857 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001858 *
1859 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001860 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001861 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1862 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1863 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1864 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1865 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1866 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001867 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001868 * \return If this function fails, the key slot is an invalid state.
1869 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001870 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001871static psa_status_t psa_finish_key_creation(
1872 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001873 psa_se_drv_table_entry_t *driver,
1874 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001875{
1876 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001877 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001878 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001879
1880#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001882#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001883 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001884 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001885 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001887
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001888 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1889 sizeof(data.slot_number),
1890 "Slot number size does not match psa_se_key_data_storage_t");
1891
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1893 status = psa_save_persistent_key(&slot->attr,
1894 (uint8_t *) &data,
1895 sizeof(data));
1896 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001897#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1898 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001899 /* Key material is saved in export representation in the slot, so
1900 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 status = psa_save_persistent_key(&slot->attr,
1902 slot->key.data,
1903 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001904 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001905 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001906#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1907
Gilles Peskinecbaff462019-07-12 23:46:04 +02001908#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001909 /* Finish the transaction for a key creation. This does not
1910 * happen when registering an existing key. Detect this case
1911 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001912 * creation of a persistent key in a secure element requires a transaction,
1913 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 if (driver != NULL &&
1915 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1916 status = psa_save_se_persistent_data(driver);
1917 if (status != PSA_SUCCESS) {
1918 psa_destroy_persistent_key(slot->attr.id);
1919 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001920 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001921 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001922 }
1923#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1924
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001926 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001927 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1928 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001930 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001932 }
Ronald Cron50972942020-11-14 11:28:25 +01001933
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001935}
1936
1937/** Abort the creation of a key.
1938 *
1939 * You may call this function after calling psa_start_key_creation(),
1940 * or after psa_finish_key_creation() fails. In other circumstances, this
1941 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001942 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001943 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001944 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001945 * \param[in,out] slot Pointer to the slot with key material.
1946 * \param[in] driver The secure element driver for the key,
1947 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001948 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001949static void psa_fail_key_creation(psa_key_slot_t *slot,
1950 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001951{
Gilles Peskine011e4282019-06-26 18:34:38 +02001952 (void) driver;
1953
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001955 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001957
1958#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001959 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001960 * element, and the failure happened later (when saving metadata
1961 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001962 * element.
1963 * https://github.com/ARMmbed/mbed-crypto/issues/217
1964 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001965
Gilles Peskined7729582019-08-05 15:55:54 +02001966 /* Abort the ongoing transaction if any (there may not be one if
1967 * the creation process failed before starting one, or if the
1968 * key creation is a registration of a key in a secure element).
1969 * Earlier functions must already have done what it takes to undo any
1970 * partial creation. All that's left is to update the transaction data
1971 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001973#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1974
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001976}
1977
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001978/** Validate optional attributes during key creation.
1979 *
1980 * Some key attributes are optional during key creation. If they are
1981 * specified in the attributes structure, check that they are consistent
1982 * with the data in the slot.
1983 *
1984 * This function should be called near the end of key creation, after
1985 * the slot in memory is fully populated but before saving persistent data.
1986 */
1987static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001988 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001990{
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 if (attributes->core.type != 0) {
1992 if (attributes->core.type != slot->attr.type) {
1993 return PSA_ERROR_INVALID_ARGUMENT;
1994 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001995 }
1996
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001998#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1999 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2001 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002002 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002003 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002004 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002005
Ronald Cron90857082020-11-25 14:58:33 +01002006 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 slot->attr.type,
2008 slot->key.data,
2009 slot->key.bytes,
2010 &rsa);
2011 if (status != PSA_SUCCESS) {
2012 return status;
2013 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002014
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 mbedtls_mpi_init(&actual);
2016 mbedtls_mpi_init(&required);
2017 ret = mbedtls_rsa_export(rsa,
2018 NULL, NULL, NULL, NULL, &actual);
2019 mbedtls_rsa_free(rsa);
2020 mbedtls_free(rsa);
2021 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002022 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 }
2024 ret = mbedtls_mpi_read_binary(&required,
2025 attributes->domain_parameters,
2026 attributes->domain_parameters_size);
2027 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002028 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 }
2030 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002031 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002032 }
2033rsa_exit:
2034 mbedtls_mpi_free(&actual);
2035 mbedtls_mpi_free(&required);
2036 if (ret != 0) {
2037 return mbedtls_to_psa_error(ret);
2038 }
2039 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002040#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2041 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002042 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002043 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002045 }
2046 }
2047
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 if (attributes->core.bits != 0) {
2049 if (attributes->core.bits != slot->attr.bits) {
2050 return PSA_ERROR_INVALID_ARGUMENT;
2051 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002052 }
2053
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002055}
2056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
2058 const uint8_t *data,
2059 size_t data_length,
2060 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002061{
2062 psa_status_t status;
2063 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002064 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002065 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302066 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002067
Ronald Cron81709fc2020-11-14 12:10:32 +01002068 *key = MBEDTLS_SVC_KEY_ID_INIT;
2069
Gilles Peskine0f84d622019-09-12 19:03:13 +02002070 /* Reject zero-length symmetric keys (including raw data key objects).
2071 * This also rejects any key which might be encoded as an empty string,
2072 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 if (data_length == 0) {
2074 return PSA_ERROR_INVALID_ARGUMENT;
2075 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002076
Archana449608b2021-09-08 15:36:05 +05302077 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 if (data_length > SIZE_MAX / 8) {
2079 return PSA_ERROR_NOT_SUPPORTED;
2080 }
Archana6ed4bda2021-08-04 10:47:15 +05302081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2083 &slot, &driver);
2084 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002085 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002087
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002088 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302089 * storage ( thus not in the case of importing a key in a secure element
2090 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2091 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 if (slot->key.data == NULL) {
2093 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302094 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 attributes, data, data_length, &storage_size);
2096 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302097 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 }
Archanad8a83dc2021-06-14 10:04:16 +05302099 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 status = psa_allocate_buffer_to_slot(slot, storage_size);
2101 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002102 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002104 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002105
2106 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 status = psa_driver_wrapper_import_key(attributes,
2108 data, data_length,
2109 slot->key.data,
2110 slot->key.bytes,
2111 &slot->key.bytes, &bits);
2112 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002113 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002117 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002119 status = PSA_ERROR_INVALID_ARGUMENT;
2120 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002121 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002122
Archana6ed4bda2021-08-04 10:47:15 +05302123 /* Enforce a size limit, and in particular ensure that the bit
2124 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302126 status = PSA_ERROR_NOT_SUPPORTED;
2127 goto exit;
2128 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 status = psa_validate_optional_attributes(slot, attributes);
2130 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002131 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002133
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002135exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 if (status != PSA_SUCCESS) {
2137 psa_fail_key_creation(slot, driver);
2138 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002141}
2142
Gilles Peskined7729582019-08-05 15:55:54 +02002143#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2144psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002146{
2147 psa_status_t status;
2148 psa_key_slot_t *slot = NULL;
2149 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002150 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002151
2152 /* Leaving attributes unspecified is not currently supported.
2153 * It could make sense to query the key type and size from the
2154 * secure element, but not all secure elements support this
2155 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2157 return PSA_ERROR_NOT_SUPPORTED;
2158 }
2159 if (psa_get_key_bits(attributes) == 0) {
2160 return PSA_ERROR_NOT_SUPPORTED;
2161 }
Gilles Peskined7729582019-08-05 15:55:54 +02002162
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2164 &slot, &driver);
2165 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002166 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 }
Gilles Peskined7729582019-08-05 15:55:54 +02002168
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002170
2171exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 if (status != PSA_SUCCESS) {
2173 psa_fail_key_creation(slot, driver);
2174 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002175
Gilles Peskined7729582019-08-05 15:55:54 +02002176 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 psa_close_key(key);
2178 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002179}
2180#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2181
Gilles Peskine449bd832023-01-11 14:50:10 +01002182psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2183 const psa_key_attributes_t *specified_attributes,
2184 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002185{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002187 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002188 psa_key_slot_t *source_slot = NULL;
2189 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002190 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002191 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302192 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002193
Ronald Cron81709fc2020-11-14 12:10:32 +01002194 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2195
Archana8a180362021-07-05 02:18:48 +05302196 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2198 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002199 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 status = psa_validate_optional_attributes(source_slot,
2203 specified_attributes);
2204 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002205 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002207
Archana9d17bf42021-09-10 06:22:44 +05302208 /* The target key type and number of bits have been validated by
2209 * psa_validate_optional_attributes() to be either equal to zero or
2210 * equal to the ones of the source key. So it is safe to inherit
2211 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302212 * */
Archana9d17bf42021-09-10 06:22:44 +05302213 actual_attributes.core.bits = source_slot->attr.bits;
2214 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302215
2216
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 status = psa_restrict_key_policy(source_slot->attr.type,
2218 &actual_attributes.core.policy,
2219 &source_slot->attr.policy);
2220 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002221 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002223
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2225 &target_slot, &driver);
2226 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002227 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 }
2229 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2230 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302231 /*
Archana9d17bf42021-09-10 06:22:44 +05302232 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302233 * the source key would need to be exported as plaintext and re-imported
2234 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302235 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302236 * appropriate API invocations from the application, if needed.
2237 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002238 status = PSA_ERROR_NOT_SUPPORTED;
2239 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002240 }
Archana8a180362021-07-05 02:18:48 +05302241 /*
2242 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302243 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302244 * - For opaque keys this translates to an invocation of the drivers'
2245 * copy_key entry point through the dispatch layer.
2246 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2248 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2249 &storage_size);
2250 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302251 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 }
Archana374fe5b2021-09-08 15:50:28 +05302253
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2255 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302256 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 }
Archana374fe5b2021-09-08 15:50:28 +05302258
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 status = psa_driver_wrapper_copy_key(&actual_attributes,
2260 source_slot->key.data,
2261 source_slot->key.bytes,
2262 target_slot->key.data,
2263 target_slot->key.bytes,
2264 &target_slot->key.bytes);
2265 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302266 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 }
2268 } else {
2269 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302270 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 source_slot->key.bytes);
2272 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302273 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 }
Archana8a180362021-07-05 02:18:48 +05302275 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002277exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 if (status != PSA_SUCCESS) {
2279 psa_fail_key_creation(target_slot, driver);
2280 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002281
Ryan Everett1b70a072024-01-04 10:32:49 +00002282 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002285}
2286
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002287
2288
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002289/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002290/* Message digests */
2291/****************************************************************/
2292
Gilles Peskine449bd832023-01-11 14:50:10 +01002293psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002294{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002295 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 if (operation->id == 0) {
2297 return PSA_SUCCESS;
2298 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002299
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002301 operation->id = 0;
2302
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002304}
2305
Gilles Peskine449bd832023-01-11 14:50:10 +01002306psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2307 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002308{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002309 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002310
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002311 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002313 status = PSA_ERROR_BAD_STATE;
2314 goto exit;
2315 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002318 status = PSA_ERROR_INVALID_ARGUMENT;
2319 goto exit;
2320 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002321
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002322 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2323 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002325
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002327
2328exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 if (status != PSA_SUCCESS) {
2330 psa_hash_abort(operation);
2331 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002332
2333 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002334}
2335
Gilles Peskine449bd832023-01-11 14:50:10 +01002336psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2337 const uint8_t *input,
2338 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002339{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002340 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2341
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002343 status = PSA_ERROR_BAD_STATE;
2344 goto exit;
2345 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002346
Steven Cooremanc8288352021-03-04 14:02:19 +01002347 /* Don't require hash implementations to behave correctly on a
2348 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (input_length == 0) {
2350 return PSA_SUCCESS;
2351 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002352
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002354
2355exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 if (status != PSA_SUCCESS) {
2357 psa_hash_abort(operation);
2358 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002359
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002361}
2362
Gilles Peskine449bd832023-01-11 14:50:10 +01002363psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2364 uint8_t *hash,
2365 size_t hash_size,
2366 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002367{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002368 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 if (operation->id == 0) {
2370 return PSA_ERROR_BAD_STATE;
2371 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002372
Steven Cooreman1e582352021-02-18 17:24:37 +01002373 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 operation, hash, hash_size, hash_length);
2375 psa_hash_abort(operation);
2376 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002377}
2378
Gilles Peskine449bd832023-01-11 14:50:10 +01002379psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2380 const uint8_t *hash,
2381 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002382{
Ronald Cron69a63422021-10-18 09:47:58 +02002383 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002384 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002385 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 operation,
2387 actual_hash, sizeof(actual_hash),
2388 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002389
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002391 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002393
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002395 status = PSA_ERROR_INVALID_SIGNATURE;
2396 goto exit;
2397 }
2398
Dave Rodgman78701152023-08-29 14:20:18 +01002399 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002400 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002402
2403exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2405 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002406 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002408
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002410}
2411
Gilles Peskine449bd832023-01-11 14:50:10 +01002412psa_status_t psa_hash_compute(psa_algorithm_t alg,
2413 const uint8_t *input, size_t input_length,
2414 uint8_t *hash, size_t hash_size,
2415 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002416{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002417 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 if (!PSA_ALG_IS_HASH(alg)) {
2419 return PSA_ERROR_INVALID_ARGUMENT;
2420 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002421
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2423 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002424}
2425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426psa_status_t psa_hash_compare(psa_algorithm_t alg,
2427 const uint8_t *input, size_t input_length,
2428 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002429{
Ronald Cron69a63422021-10-18 09:47:58 +02002430 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002431 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002432
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 if (!PSA_ALG_IS_HASH(alg)) {
2434 return PSA_ERROR_INVALID_ARGUMENT;
2435 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002436
Steven Cooreman1e582352021-02-18 17:24:37 +01002437 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 alg, input, input_length,
2439 actual_hash, sizeof(actual_hash),
2440 &actual_hash_length);
2441 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002442 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 }
2444 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002445 status = PSA_ERROR_INVALID_SIGNATURE;
2446 goto exit;
2447 }
Dave Rodgman78701152023-08-29 14:20:18 +01002448 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002449 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002451
2452exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2454 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002455}
2456
Gilles Peskine449bd832023-01-11 14:50:10 +01002457psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2458 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002459{
Gilles Peskine449bd832023-01-11 14:50:10 +01002460 if (source_operation->id == 0 ||
2461 target_operation->id != 0) {
2462 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002463 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2466 target_operation);
2467 if (status != PSA_SUCCESS) {
2468 psa_hash_abort(target_operation);
2469 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002470
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002472}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002473
2474
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002475/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002476/* MAC */
2477/****************************************************************/
2478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002480{
Steven Cooremane6804192021-03-19 18:28:56 +01002481 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 if (operation->id == 0) {
2483 return PSA_SUCCESS;
2484 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002485
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002487 operation->mac_size = 0;
2488 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002489 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002490
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002492}
2493
Ronald Cron2dff3b22021-06-17 16:33:22 +02002494static psa_status_t psa_mac_finalize_alg_and_key_validation(
2495 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002496 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002498{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002499 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 psa_key_type_t key_type = psa_get_key_type(attributes);
2501 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002502
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 if (!PSA_ALG_IS_MAC(alg)) {
2504 return PSA_ERROR_INVALID_ARGUMENT;
2505 }
Steven Cooremane6804192021-03-19 18:28:56 +01002506
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002507 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 status = psa_mac_key_can_do(alg, key_type);
2509 if (status != PSA_SUCCESS) {
2510 return status;
2511 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002512
Steven Cooremand1a68f12021-05-10 11:13:41 +02002513 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002517 /* A very short MAC is too short for security since it can be
2518 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2519 * so we make this our minimum, even though 32 bits is still
2520 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002522 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2525 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002526 /* It's impossible to "truncate" to a larger length than the full length
2527 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002529 }
2530
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002532 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2533 * that is disabled in the compile-time configuration. The result can
2534 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2535 * configuration into account. In this case, force a return of
2536 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2537 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2538 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2539 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2540 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002542 }
2543
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002545}
2546
Gilles Peskine449bd832023-01-11 14:50:10 +01002547static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2548 mbedtls_svc_key_id_t key,
2549 psa_algorithm_t alg,
2550 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002551{
2552 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2553 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002554 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002555 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002556
2557 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002559 status = PSA_ERROR_BAD_STATE;
2560 goto exit;
2561 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002562
2563 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 key,
2565 &slot,
2566 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2567 alg);
2568 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002569 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002571
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002572 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002573 .core = slot->attr
2574 };
2575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2577 &operation->mac_size);
2578 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002579 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002581
2582 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002583 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (is_sign) {
2585 status = psa_driver_wrapper_mac_sign_setup(operation,
2586 &attributes,
2587 slot->key.data,
2588 slot->key.bytes,
2589 alg);
2590 } else {
2591 status = psa_driver_wrapper_mac_verify_setup(operation,
2592 &attributes,
2593 slot->key.data,
2594 slot->key.bytes,
2595 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002596 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002597
Gilles Peskinefbfac682018-07-08 20:51:54 +02002598exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 if (status != PSA_SUCCESS) {
2600 psa_mac_abort(operation);
2601 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002602
Ryan Everett1b70a072024-01-04 10:32:49 +00002603 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002606}
2607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2609 mbedtls_svc_key_id_t key,
2610 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002611{
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002613}
2614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2616 mbedtls_svc_key_id_t key,
2617 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002618{
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002620}
2621
Gilles Peskine449bd832023-01-11 14:50:10 +01002622psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2623 const uint8_t *input,
2624 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002625{
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 if (operation->id == 0) {
2627 return PSA_ERROR_BAD_STATE;
2628 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002629
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002630 /* Don't require hash implementations to behave correctly on a
2631 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 if (input_length == 0) {
2633 return PSA_SUCCESS;
2634 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2637 input, input_length);
2638 if (status != PSA_SUCCESS) {
2639 psa_mac_abort(operation);
2640 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002643}
2644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2646 uint8_t *mac,
2647 size_t mac_size,
2648 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002649{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002650 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2651 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002652
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002654 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002655 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002656 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002659 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002660 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002661 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002662
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002663 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2664 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002666 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002667 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002668 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002671 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002672 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002673 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 status = psa_driver_wrapper_mac_sign_finish(operation,
2676 mac, operation->mac_size,
2677 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002678
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002679exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002680 /* In case of success, set the potential excess room in the output buffer
2681 * to an invalid value, to avoid potentially leaking a longer MAC.
2682 * In case of error, set the output length and content to a safe default,
2683 * such that in case the caller misses an error check, the output would be
2684 * an unachievable MAC.
2685 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002687 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002688 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002689 }
mohammad16036df908f2018-04-02 08:34:15 -07002690
Paul Elliottdc42ca82023-02-24 18:11:59 +00002691 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002692
Gilles Peskine449bd832023-01-11 14:50:10 +01002693 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002694
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002696}
2697
Gilles Peskine449bd832023-01-11 14:50:10 +01002698psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2699 const uint8_t *mac,
2700 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002701{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002702 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2703 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002706 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002707 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002708 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002709
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002711 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002712 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002713 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002714
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002716 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002717 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002718 }
2719
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 status = psa_driver_wrapper_mac_verify_finish(operation,
2721 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002722
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002723exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002725
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002727}
2728
Gilles Peskine449bd832023-01-11 14:50:10 +01002729static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2730 psa_algorithm_t alg,
2731 const uint8_t *input,
2732 size_t input_length,
2733 uint8_t *mac,
2734 size_t mac_size,
2735 size_t *mac_length,
2736 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002737{
2738 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002739 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2740 psa_key_slot_t *slot;
2741 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002742 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002743
Ronald Cron51131b52021-06-17 17:17:20 +02002744 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 key,
2746 &slot,
2747 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2748 alg);
2749 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002750 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002752
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002753 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002754 .core = slot->attr
2755 };
2756
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2758 &operation_mac_size);
2759 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002760 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002762
Gilles Peskine449bd832023-01-11 14:50:10 +01002763 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002764 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002765 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002766 }
2767
2768 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 &attributes,
2770 slot->key.data, slot->key.bytes,
2771 alg,
2772 input, input_length,
2773 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002774
2775exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002776 /* In case of success, set the potential excess room in the output buffer
2777 * to an invalid value, to avoid potentially leaking a longer MAC.
2778 * In case of error, set the output length and content to a safe default,
2779 * such that in case the caller misses an error check, the output would be
2780 * an unachievable MAC.
2781 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002783 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002784 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002785 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002786
2787 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002788
Ryan Everett1b70a072024-01-04 10:32:49 +00002789 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002792}
2793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002795 psa_algorithm_t alg,
2796 const uint8_t *input,
2797 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 uint8_t *mac,
2799 size_t mac_size,
2800 size_t *mac_length)
2801{
2802 return psa_mac_compute_internal(key, alg,
2803 input, input_length,
2804 mac, mac_size, mac_length, 1);
2805}
2806
2807psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2808 psa_algorithm_t alg,
2809 const uint8_t *input,
2810 size_t input_length,
2811 const uint8_t *mac,
2812 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002813{
2814 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002815 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2816 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002817
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 status = psa_mac_compute_internal(key, alg,
2819 input, input_length,
2820 actual_mac, sizeof(actual_mac),
2821 &actual_mac_length, 0);
2822 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002823 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002825
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002827 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002828 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002829 }
Dave Rodgman78701152023-08-29 14:20:18 +01002830 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002831 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002832 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002833 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002834
2835exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002839}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002840
Gilles Peskinee59236f2018-01-27 23:32:46 +01002841/****************************************************************/
2842/* Asymmetric cryptography */
2843/****************************************************************/
2844
Gilles Peskine449bd832023-01-11 14:50:10 +01002845static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2846 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002847{
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 if (input_is_message) {
2849 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2850 return PSA_ERROR_INVALID_ARGUMENT;
2851 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002852
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2854 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2855 return PSA_ERROR_INVALID_ARGUMENT;
2856 }
2857 }
2858 } else {
2859 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2860 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002861 }
2862 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002865}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2868 int input_is_message,
2869 psa_algorithm_t alg,
2870 const uint8_t *input,
2871 size_t input_length,
2872 uint8_t *signature,
2873 size_t signature_size,
2874 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002875{
2876 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2877 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2878 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002879 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002880
2881 *signature_length = 0;
2882
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 status = psa_sign_verify_check_alg(input_is_message, alg);
2884 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002885 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002887
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002888 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002889 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002890 * buffer can in principle be empty since it doesn't actually have
2891 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 if (signature_size == 0) {
2893 return PSA_ERROR_BUFFER_TOO_SMALL;
2894 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002895
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002896 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 key, &slot,
2898 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2899 PSA_KEY_USAGE_SIGN_HASH,
2900 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002901
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002903 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002907 status = PSA_ERROR_INVALID_ARGUMENT;
2908 goto exit;
2909 }
2910
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002911 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002913 };
2914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002916 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002917 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002918 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 signature, signature_size, signature_length);
2920 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002921
2922 status = psa_driver_wrapper_sign_hash(
2923 &attributes, slot->key.data, slot->key.bytes,
2924 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002926 }
2927
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002928
2929exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002930 psa_wipe_tag_output_buffer(signature, status, signature_size,
2931 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002932
Ryan Everett1b70a072024-01-04 10:32:49 +00002933 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002936}
2937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2939 int input_is_message,
2940 psa_algorithm_t alg,
2941 const uint8_t *input,
2942 size_t input_length,
2943 const uint8_t *signature,
2944 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002945{
2946 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2947 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2948 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002949
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 status = psa_sign_verify_check_alg(input_is_message, alg);
2951 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002952 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002954
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002955 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 key, &slot,
2957 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2958 PSA_KEY_USAGE_VERIFY_HASH,
2959 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002960
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 if (status != PSA_SUCCESS) {
2962 return status;
2963 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002964
2965 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002967 };
2968
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002970 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002971 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002972 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 signature, signature_length);
2974 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002975 status = psa_driver_wrapper_verify_hash(
2976 &attributes, slot->key.data, slot->key.bytes,
2977 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002979 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002980
Ryan Everett1b70a072024-01-04 10:32:49 +00002981 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002984
2985}
2986
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002987psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002988 const psa_key_attributes_t *attributes,
2989 const uint8_t *key_buffer,
2990 size_t key_buffer_size,
2991 psa_algorithm_t alg,
2992 const uint8_t *input,
2993 size_t input_length,
2994 uint8_t *signature,
2995 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002997{
2998 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002999
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003001 size_t hash_length;
3002 uint8_t hash[PSA_HASH_MAX_SIZE];
3003
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003004 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 PSA_ALG_SIGN_GET_HASH(alg),
3006 input, input_length,
3007 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003008
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003010 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003012
3013 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 attributes, key_buffer, key_buffer_size,
3015 alg, hash, hash_length,
3016 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003017 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003020}
3021
Gilles Peskine449bd832023-01-11 14:50:10 +01003022psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3023 psa_algorithm_t alg,
3024 const uint8_t *input,
3025 size_t input_length,
3026 uint8_t *signature,
3027 size_t signature_size,
3028 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003029{
3030 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003031 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003033}
3034
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003035psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003036 const psa_key_attributes_t *attributes,
3037 const uint8_t *key_buffer,
3038 size_t key_buffer_size,
3039 psa_algorithm_t alg,
3040 const uint8_t *input,
3041 size_t input_length,
3042 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003044{
3045 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003046
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003048 size_t hash_length;
3049 uint8_t hash[PSA_HASH_MAX_SIZE];
3050
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003051 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 PSA_ALG_SIGN_GET_HASH(alg),
3053 input, input_length,
3054 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003055
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003057 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003059
3060 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 attributes, key_buffer, key_buffer_size,
3062 alg, hash, hash_length,
3063 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003064 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003065
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003067}
3068
Gilles Peskine449bd832023-01-11 14:50:10 +01003069psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3070 psa_algorithm_t alg,
3071 const uint8_t *input,
3072 size_t input_length,
3073 const uint8_t *signature,
3074 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003075{
3076 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003077 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003079}
3080
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003081psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003082 const psa_key_attributes_t *attributes,
3083 const uint8_t *key_buffer, size_t key_buffer_size,
3084 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003086{
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3088 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3089 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003090#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3092 return mbedtls_psa_rsa_sign_hash(
3093 attributes,
3094 key_buffer, key_buffer_size,
3095 alg, hash, hash_length,
3096 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003097#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3098 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 } else {
3100 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003101 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3103 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003104#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3106 return mbedtls_psa_ecdsa_sign_hash(
3107 attributes,
3108 key_buffer, key_buffer_size,
3109 alg, hash, hash_length,
3110 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003111#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3112 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 } else {
3114 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003115 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003116 }
Ronald Cron4501c982021-03-19 20:09:32 +01003117
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 (void) key_buffer;
3119 (void) key_buffer_size;
3120 (void) hash;
3121 (void) hash_length;
3122 (void) signature;
3123 (void) signature_size;
3124 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003125
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003127}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003128
Gilles Peskine449bd832023-01-11 14:50:10 +01003129psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3130 psa_algorithm_t alg,
3131 const uint8_t *hash,
3132 size_t hash_length,
3133 uint8_t *signature,
3134 size_t signature_size,
3135 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003136{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003137 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003138 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003140}
3141
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003142psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003143 const psa_key_attributes_t *attributes,
3144 const uint8_t *key_buffer, size_t key_buffer_size,
3145 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003147{
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3149 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3150 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003151#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3153 return mbedtls_psa_rsa_verify_hash(
3154 attributes,
3155 key_buffer, key_buffer_size,
3156 alg, hash, hash_length,
3157 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003158#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3159 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 } else {
3161 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003162 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003163 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3164 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003165#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003166 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3167 return mbedtls_psa_ecdsa_verify_hash(
3168 attributes,
3169 key_buffer, key_buffer_size,
3170 alg, hash, hash_length,
3171 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003172#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3173 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003174 } else {
3175 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003176 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003177 }
Ronald Cron4501c982021-03-19 20:09:32 +01003178
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 (void) key_buffer;
3180 (void) key_buffer_size;
3181 (void) hash;
3182 (void) hash_length;
3183 (void) signature;
3184 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003185
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003187}
3188
Gilles Peskine449bd832023-01-11 14:50:10 +01003189psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3190 psa_algorithm_t alg,
3191 const uint8_t *hash,
3192 size_t hash_length,
3193 const uint8_t *signature,
3194 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003195{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003196 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003197 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003199}
3200
Gilles Peskine449bd832023-01-11 14:50:10 +01003201psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3202 psa_algorithm_t alg,
3203 const uint8_t *input,
3204 size_t input_length,
3205 const uint8_t *salt,
3206 size_t salt_length,
3207 uint8_t *output,
3208 size_t output_size,
3209 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003210{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003211 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003212 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003213 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003214 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003215
Darryl Green5cc689a2018-07-24 15:34:10 +01003216 (void) input;
3217 (void) input_length;
3218 (void) salt;
3219 (void) output;
3220 (void) output_size;
3221
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003222 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003223
Gilles Peskine449bd832023-01-11 14:50:10 +01003224 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3225 return PSA_ERROR_INVALID_ARGUMENT;
3226 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003227
Valerio Setti5bb454a2024-01-15 10:43:16 +01003228 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003229 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3230 if (status != PSA_SUCCESS) {
3231 return status;
3232 }
3233 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3234 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003235 status = PSA_ERROR_INVALID_ARGUMENT;
3236 goto exit;
3237 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003238
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003239 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003241 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003242
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003243 status = psa_driver_wrapper_asymmetric_encrypt(
3244 &attributes, slot->key.data, slot->key.bytes,
3245 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003247exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003248 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003251}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003252
Gilles Peskine449bd832023-01-11 14:50:10 +01003253psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3254 psa_algorithm_t alg,
3255 const uint8_t *input,
3256 size_t input_length,
3257 const uint8_t *salt,
3258 size_t salt_length,
3259 uint8_t *output,
3260 size_t output_size,
3261 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003262{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003263 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003264 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003265 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003266 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003267
Darryl Green5cc689a2018-07-24 15:34:10 +01003268 (void) input;
3269 (void) input_length;
3270 (void) salt;
3271 (void) output;
3272 (void) output_size;
3273
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003274 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003275
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3277 return PSA_ERROR_INVALID_ARGUMENT;
3278 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003279
Valerio Setti5bb454a2024-01-15 10:43:16 +01003280 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003281 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3282 if (status != PSA_SUCCESS) {
3283 return status;
3284 }
3285 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003286 status = PSA_ERROR_INVALID_ARGUMENT;
3287 goto exit;
3288 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003289
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003290 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003292 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003293
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003294 status = psa_driver_wrapper_asymmetric_decrypt(
3295 &attributes, slot->key.data, slot->key.bytes,
3296 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003298
3299exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003300 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003301
Gilles Peskine449bd832023-01-11 14:50:10 +01003302 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003303}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003304
Paul Elliott9fe12f62022-11-30 19:16:02 +00003305/****************************************************************/
3306/* Asymmetric interruptible cryptography */
3307/****************************************************************/
3308
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003309static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3310
Paul Elliott9fe12f62022-11-30 19:16:02 +00003311void psa_interruptible_set_max_ops(uint32_t max_ops)
3312{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003313 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003314}
3315
3316uint32_t psa_interruptible_get_max_ops(void)
3317{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003318 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003319}
3320
Paul Elliott9fe12f62022-11-30 19:16:02 +00003321uint32_t psa_sign_hash_get_num_ops(
3322 const psa_sign_hash_interruptible_operation_t *operation)
3323{
Paul Elliott296ede92022-12-15 17:00:30 +00003324 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003325}
3326
3327uint32_t psa_verify_hash_get_num_ops(
3328 const psa_verify_hash_interruptible_operation_t *operation)
3329{
Paul Elliott296ede92022-12-15 17:00:30 +00003330 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003331}
3332
Paul Elliott59ad9452022-12-18 15:09:02 +00003333static psa_status_t psa_sign_hash_abort_internal(
3334 psa_sign_hash_interruptible_operation_t *operation)
3335{
3336 if (operation->id == 0) {
3337 /* The object has (apparently) been initialized but it is not (yet)
3338 * in use. It's ok to call abort on such an object, and there's
3339 * nothing to do. */
3340 return PSA_SUCCESS;
3341 }
3342
3343 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3344
3345 status = psa_driver_wrapper_sign_hash_abort(operation);
3346
3347 operation->id = 0;
3348
Paul Elliotte6145dc2023-02-07 12:51:21 +00003349 /* Do not clear either the error_occurred or num_ops elements here as they
3350 * only want to be cleared by the application calling abort, not by abort
3351 * being called at completion of an operation. */
3352
Paul Elliott59ad9452022-12-18 15:09:02 +00003353 return status;
3354}
3355
Paul Elliott9fe12f62022-11-30 19:16:02 +00003356psa_status_t psa_sign_hash_start(
3357 psa_sign_hash_interruptible_operation_t *operation,
3358 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3359 const uint8_t *hash, size_t hash_length)
3360{
3361 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3362 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3363 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003364 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003365
Paul Elliottc9774412023-02-06 15:14:07 +00003366 /* Check that start has not been previously called, or operation has not
3367 * previously errored. */
3368 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003369 return PSA_ERROR_BAD_STATE;
3370 }
3371
Paul Elliott9fe12f62022-11-30 19:16:02 +00003372 status = psa_sign_verify_check_alg(0, alg);
3373 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003374 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003375 return status;
3376 }
3377
3378 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3379 PSA_KEY_USAGE_SIGN_HASH,
3380 alg);
3381
3382 if (status != PSA_SUCCESS) {
3383 goto exit;
3384 }
3385
3386 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3387 status = PSA_ERROR_INVALID_ARGUMENT;
3388 goto exit;
3389 }
3390
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003391 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003392 .core = slot->attr
3393 };
3394
Paul Elliott296ede92022-12-15 17:00:30 +00003395 /* Ensure ops count gets reset, in case of operation re-use. */
3396 operation->num_ops = 0;
3397
Paul Elliott9fe12f62022-11-30 19:16:02 +00003398 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3399 slot->key.data,
3400 slot->key.bytes, alg,
3401 hash, hash_length);
3402exit:
3403
3404 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003405 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003406 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003407 }
3408
Ryan Everett1b70a072024-01-04 10:32:49 +00003409 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003410
Paul Elliottc9774412023-02-06 15:14:07 +00003411 if (unlock_status != PSA_SUCCESS) {
3412 operation->error_occurred = 1;
3413 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003414
Paul Elliottc9774412023-02-06 15:14:07 +00003415 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003416}
3417
3418
3419psa_status_t psa_sign_hash_complete(
3420 psa_sign_hash_interruptible_operation_t *operation,
3421 uint8_t *signature, size_t signature_size,
3422 size_t *signature_length)
3423{
3424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3425
3426 *signature_length = 0;
3427
Paul Elliottc9774412023-02-06 15:14:07 +00003428 /* Check that start has been called first, and that operation has not
3429 * previously errored. */
3430 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003431 status = PSA_ERROR_BAD_STATE;
3432 goto exit;
3433 }
3434
Paul Elliott096abc42023-02-03 18:33:23 +00003435 /* Immediately reject a zero-length signature buffer. This guarantees that
3436 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003437 if (signature_size == 0) {
3438 status = PSA_ERROR_BUFFER_TOO_SMALL;
3439 goto exit;
3440 }
3441
3442 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3443 signature_size,
3444 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003445
Paul Elliott296ede92022-12-15 17:00:30 +00003446 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003447 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003448
Paul Elliottebe225c2023-02-10 14:32:53 +00003449exit:
3450
Paul Elliott59200a22023-02-21 15:07:40 +00003451 psa_wipe_tag_output_buffer(signature, status, signature_size,
3452 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003453
Paul Elliott53bb3122023-02-10 14:22:22 +00003454 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003455 if (status != PSA_SUCCESS) {
3456 operation->error_occurred = 1;
3457 }
3458
Paul Elliott59ad9452022-12-18 15:09:02 +00003459 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003460 }
3461
3462 return status;
3463}
3464
3465psa_status_t psa_sign_hash_abort(
3466 psa_sign_hash_interruptible_operation_t *operation)
3467{
Paul Elliott59ad9452022-12-18 15:09:02 +00003468 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3469
3470 status = psa_sign_hash_abort_internal(operation);
3471
3472 /* We clear the number of ops done here, so that it is not cleared when
3473 * the operation fails or succeeds, only on manual abort. */
3474 operation->num_ops = 0;
3475
Paul Elliottc9774412023-02-06 15:14:07 +00003476 /* Likewise, failure state. */
3477 operation->error_occurred = 0;
3478
Paul Elliott59ad9452022-12-18 15:09:02 +00003479 return status;
3480}
3481
3482static psa_status_t psa_verify_hash_abort_internal(
3483 psa_verify_hash_interruptible_operation_t *operation)
3484{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003485 if (operation->id == 0) {
3486 /* The object has (apparently) been initialized but it is not (yet)
3487 * in use. It's ok to call abort on such an object, and there's
3488 * nothing to do. */
3489 return PSA_SUCCESS;
3490 }
3491
Paul Elliott59ad9452022-12-18 15:09:02 +00003492 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3493
3494 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003495
3496 operation->id = 0;
3497
Paul Elliotte6145dc2023-02-07 12:51:21 +00003498 /* Do not clear either the error_occurred or num_ops elements here as they
3499 * only want to be cleared by the application calling abort, not by abort
3500 * being called at completion of an operation. */
3501
Paul Elliott59ad9452022-12-18 15:09:02 +00003502 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003503}
3504
3505psa_status_t psa_verify_hash_start(
3506 psa_verify_hash_interruptible_operation_t *operation,
3507 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3508 const uint8_t *hash, size_t hash_length,
3509 const uint8_t *signature, size_t signature_length)
3510{
3511 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3512 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3513 psa_key_slot_t *slot;
3514
Paul Elliottc9774412023-02-06 15:14:07 +00003515 /* Check that start has not been previously called, or operation has not
3516 * previously errored. */
3517 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003518 return PSA_ERROR_BAD_STATE;
3519 }
3520
3521 status = psa_sign_verify_check_alg(0, alg);
3522 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003523 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003524 return status;
3525 }
3526
3527 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3528 PSA_KEY_USAGE_VERIFY_HASH,
3529 alg);
3530
3531 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003532 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003533 return status;
3534 }
3535
3536 psa_key_attributes_t attributes = {
3537 .core = slot->attr
3538 };
3539
Paul Elliott296ede92022-12-15 17:00:30 +00003540 /* Ensure ops count gets reset, in case of operation re-use. */
3541 operation->num_ops = 0;
3542
Paul Elliott9fe12f62022-11-30 19:16:02 +00003543 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3544 slot->key.data,
3545 slot->key.bytes,
3546 alg, hash, hash_length,
3547 signature, signature_length);
3548
3549 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003550 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003551 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003552 }
3553
Ryan Everett1b70a072024-01-04 10:32:49 +00003554 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003555
Paul Elliottc9774412023-02-06 15:14:07 +00003556 if (unlock_status != PSA_SUCCESS) {
3557 operation->error_occurred = 1;
3558 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003559
Paul Elliottc9774412023-02-06 15:14:07 +00003560 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003561}
3562
3563psa_status_t psa_verify_hash_complete(
3564 psa_verify_hash_interruptible_operation_t *operation)
3565{
3566 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3567
Paul Elliottc9774412023-02-06 15:14:07 +00003568 /* Check that start has been called first, and that operation has not
3569 * previously errored. */
3570 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003571 status = PSA_ERROR_BAD_STATE;
3572 goto exit;
3573 }
3574
3575 status = psa_driver_wrapper_verify_hash_complete(operation);
3576
Paul Elliott296ede92022-12-15 17:00:30 +00003577 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003578 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003579 operation);
3580
Paul Elliottebe225c2023-02-10 14:32:53 +00003581exit:
3582
Paul Elliott9fe12f62022-11-30 19:16:02 +00003583 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003584 if (status != PSA_SUCCESS) {
3585 operation->error_occurred = 1;
3586 }
3587
Paul Elliott59ad9452022-12-18 15:09:02 +00003588 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003589 }
3590
3591 return status;
3592}
3593
3594psa_status_t psa_verify_hash_abort(
3595 psa_verify_hash_interruptible_operation_t *operation)
3596{
Paul Elliott59ad9452022-12-18 15:09:02 +00003597 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003598
Paul Elliott59ad9452022-12-18 15:09:02 +00003599 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003600
Paul Elliott59ad9452022-12-18 15:09:02 +00003601 /* We clear the number of ops done here, so that it is not cleared when
3602 * the operation fails or succeeds, only on manual abort. */
3603 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003604
Paul Elliottc9774412023-02-06 15:14:07 +00003605 /* Likewise, failure state. */
3606 operation->error_occurred = 0;
3607
Paul Elliott59ad9452022-12-18 15:09:02 +00003608 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003609}
3610
Paul Elliott588f8ed2022-12-02 18:10:26 +00003611/****************************************************************/
3612/* Asymmetric interruptible cryptography internal */
3613/* implementations */
3614/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003615
Paul Elliott588f8ed2022-12-02 18:10:26 +00003616void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3617{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003618
Paul Elliott588f8ed2022-12-02 18:10:26 +00003619#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3620 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3621 defined(MBEDTLS_ECP_RESTARTABLE)
3622
3623 /* Internal implementation uses zero to indicate infinite number max ops,
3624 * therefore avoid this value, and set to minimum possible. */
3625 if (max_ops == 0) {
3626 max_ops = 1;
3627 }
3628
Paul Elliott588f8ed2022-12-02 18:10:26 +00003629 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003630#else
3631 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003632#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3633 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3634 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3635}
3636
Paul Elliott588f8ed2022-12-02 18:10:26 +00003637uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003638 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003639{
3640#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3641 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3642 defined(MBEDTLS_ECP_RESTARTABLE)
3643
Paul Elliott93d9ca82023-02-15 18:14:21 +00003644 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003645#else
3646 (void) operation;
3647 return 0;
3648#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3649 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3650 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3651}
3652
3653uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003654 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003655{
3656 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3657 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3658 defined(MBEDTLS_ECP_RESTARTABLE)
3659
Paul Elliott93d9ca82023-02-15 18:14:21 +00003660 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003661#else
3662 (void) operation;
3663 return 0;
3664#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3665 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3666 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3667}
3668
3669psa_status_t mbedtls_psa_sign_hash_start(
3670 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3671 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3672 size_t key_buffer_size, psa_algorithm_t alg,
3673 const uint8_t *hash, size_t hash_length)
3674{
3675 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003676 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003677
Paul Elliott068fe072023-01-16 13:59:15 +00003678 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3679 return PSA_ERROR_NOT_SUPPORTED;
3680 }
3681
3682 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003683 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003684 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003685
3686#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003687 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3688 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003689
Paul Elliotta1c94092023-02-15 16:38:04 +00003690 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3691
Paul Elliott93d9ca82023-02-15 18:14:21 +00003692 /* Ensure num_ops is zero'ed in case of context re-use. */
3693 operation->num_ops = 0;
3694
Paul Elliott068fe072023-01-16 13:59:15 +00003695 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3696 attributes->core.bits,
3697 key_buffer,
3698 key_buffer_size,
3699 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003700
Paul Elliott068fe072023-01-16 13:59:15 +00003701 if (status != PSA_SUCCESS) {
3702 return status;
3703 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003704
Paul Elliott1bc59df2023-02-05 13:41:57 +00003705 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003706 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003707
Paul Elliott068fe072023-01-16 13:59:15 +00003708 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003709 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003710 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003711
Paul Elliott0290a762023-02-09 14:30:24 +00003712 /* We only need to store the same length of hash as the private key size
3713 * here, it would be truncated by the internal implementation anyway. */
3714 required_hash_length = (hash_length < operation->coordinate_bytes ?
3715 hash_length : operation->coordinate_bytes);
3716
Paul Elliottba70ad42023-02-15 18:23:53 +00003717 if (required_hash_length > sizeof(operation->hash)) {
3718 /* Shouldn't happen, but better safe than sorry. */
3719 return PSA_ERROR_CORRUPTION_DETECTED;
3720 }
3721
Paul Elliott0290a762023-02-09 14:30:24 +00003722 memcpy(operation->hash, hash, required_hash_length);
3723 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003724
3725 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003726
3727#else
Paul Elliott068fe072023-01-16 13:59:15 +00003728 (void) operation;
3729 (void) key_buffer;
3730 (void) key_buffer_size;
3731 (void) alg;
3732 (void) hash;
3733 (void) hash_length;
3734 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003735 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003736
Paul Elliott068fe072023-01-16 13:59:15 +00003737 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003738#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3739 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3740 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003741}
3742
3743psa_status_t mbedtls_psa_sign_hash_complete(
3744 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3745 uint8_t *signature, size_t signature_size,
3746 size_t *signature_length)
3747{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003748#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3749 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3750 defined(MBEDTLS_ECP_RESTARTABLE)
3751
Paul Elliotta1c94092023-02-15 16:38:04 +00003752 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003753 mbedtls_mpi r;
3754 mbedtls_mpi s;
3755
Paul Elliott46845252023-02-03 14:59:11 +00003756 mbedtls_mpi_init(&r);
3757 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003758
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003759 /* Ensure max_ops is set to the current value (or default). */
3760 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3761
Paul Elliotta1c94092023-02-15 16:38:04 +00003762 if (signature_size < 2 * operation->coordinate_bytes) {
3763 status = PSA_ERROR_BUFFER_TOO_SMALL;
3764 goto exit;
3765 }
3766
Paul Elliott588f8ed2022-12-02 18:10:26 +00003767 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003768
Paul Elliott588f8ed2022-12-02 18:10:26 +00003769#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3770 status = mbedtls_to_psa_error(
3771 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003772 &r,
3773 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003774 &operation->ctx->d,
3775 operation->hash,
3776 operation->hash_length,
3777 operation->md_alg,
3778 mbedtls_psa_get_random,
3779 MBEDTLS_PSA_RANDOM_STATE,
3780 &operation->restart_ctx));
3781#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003782 status = PSA_ERROR_NOT_SUPPORTED;
3783 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003784#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3785 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003786 status = mbedtls_to_psa_error(
3787 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003788 &r,
3789 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003790 &operation->ctx->d,
3791 operation->hash,
3792 operation->hash_length,
3793 mbedtls_psa_get_random,
3794 MBEDTLS_PSA_RANDOM_STATE,
3795 mbedtls_psa_get_random,
3796 MBEDTLS_PSA_RANDOM_STATE,
3797 &operation->restart_ctx));
3798 }
3799
Paul Elliottf8e5b562023-02-19 18:43:45 +00003800 /* Hide the fact that the restart context only holds a delta of number of
3801 * ops done during the last operation, not an absolute value. */
3802 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3803
Paul Elliott724bd252023-02-08 12:35:08 +00003804 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003805 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003806 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003807 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003808 operation->coordinate_bytes)
3809 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003810
3811 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003812 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003813 }
3814
3815 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003816 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003817 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003818 operation->coordinate_bytes,
3819 operation->coordinate_bytes)
3820 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003821
3822 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003823 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003824 }
3825
Paul Elliott1bc59df2023-02-05 13:41:57 +00003826 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003827
Paul Elliott724bd252023-02-08 12:35:08 +00003828 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003829 }
Paul Elliott724bd252023-02-08 12:35:08 +00003830
3831exit:
3832
3833 mbedtls_mpi_free(&r);
3834 mbedtls_mpi_free(&s);
3835 return status;
3836
Paul Elliott588f8ed2022-12-02 18:10:26 +00003837 #else
3838
3839 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003840 (void) signature;
3841 (void) signature_size;
3842 (void) signature_length;
3843
3844 return PSA_ERROR_NOT_SUPPORTED;
3845
3846#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3847 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3848 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3849}
3850
3851psa_status_t mbedtls_psa_sign_hash_abort(
3852 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3853{
3854
3855#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3856 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3857 defined(MBEDTLS_ECP_RESTARTABLE)
3858
3859 if (operation->ctx) {
3860 mbedtls_ecdsa_free(operation->ctx);
3861 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003862 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003863 }
3864
3865 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3866
Paul Elliott93d9ca82023-02-15 18:14:21 +00003867 operation->num_ops = 0;
3868
Paul Elliott588f8ed2022-12-02 18:10:26 +00003869 return PSA_SUCCESS;
3870
3871#else
3872
3873 (void) operation;
3874
3875 return PSA_ERROR_NOT_SUPPORTED;
3876
3877#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3878 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3879 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3880}
3881
3882psa_status_t mbedtls_psa_verify_hash_start(
3883 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3884 const psa_key_attributes_t *attributes,
3885 const uint8_t *key_buffer, size_t key_buffer_size,
3886 psa_algorithm_t alg,
3887 const uint8_t *hash, size_t hash_length,
3888 const uint8_t *signature, size_t signature_length)
3889{
3890 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003891 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003892 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003893
Paul Elliott068fe072023-01-16 13:59:15 +00003894 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3895 return PSA_ERROR_NOT_SUPPORTED;
3896 }
3897
3898 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003899 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003900 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003901
3902#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003903 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3904 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003905
Paul Elliotta1c94092023-02-15 16:38:04 +00003906 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3907 mbedtls_mpi_init(&operation->r);
3908 mbedtls_mpi_init(&operation->s);
3909
Paul Elliott93d9ca82023-02-15 18:14:21 +00003910 /* Ensure num_ops is zero'ed in case of context re-use. */
3911 operation->num_ops = 0;
3912
Paul Elliott068fe072023-01-16 13:59:15 +00003913 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3914 attributes->core.bits,
3915 key_buffer,
3916 key_buffer_size,
3917 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003918
Paul Elliott068fe072023-01-16 13:59:15 +00003919 if (status != PSA_SUCCESS) {
3920 return status;
3921 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003922
Paul Elliottc569fc22023-02-10 13:02:54 +00003923 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003924
Paul Elliott1bc59df2023-02-05 13:41:57 +00003925 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003926 return PSA_ERROR_INVALID_SIGNATURE;
3927 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003928
Paul Elliott068fe072023-01-16 13:59:15 +00003929 status = mbedtls_to_psa_error(
3930 mbedtls_mpi_read_binary(&operation->r,
3931 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003932 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003933
Paul Elliott068fe072023-01-16 13:59:15 +00003934 if (status != PSA_SUCCESS) {
3935 return status;
3936 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003937
Paul Elliott068fe072023-01-16 13:59:15 +00003938 status = mbedtls_to_psa_error(
3939 mbedtls_mpi_read_binary(&operation->s,
3940 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003941 coordinate_bytes,
3942 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003943
Paul Elliott068fe072023-01-16 13:59:15 +00003944 if (status != PSA_SUCCESS) {
3945 return status;
3946 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003947
Paul Elliott2c9843f2023-02-15 17:32:42 +00003948 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003949
Paul Elliott2c9843f2023-02-15 17:32:42 +00003950 if (status != PSA_SUCCESS) {
3951 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003952 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003953
Paul Elliott0290a762023-02-09 14:30:24 +00003954 /* We only need to store the same length of hash as the private key size
3955 * here, it would be truncated by the internal implementation anyway. */
3956 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3957 coordinate_bytes);
3958
Paul Elliottba70ad42023-02-15 18:23:53 +00003959 if (required_hash_length > sizeof(operation->hash)) {
3960 /* Shouldn't happen, but better safe than sorry. */
3961 return PSA_ERROR_CORRUPTION_DETECTED;
3962 }
3963
Paul Elliott0290a762023-02-09 14:30:24 +00003964 memcpy(operation->hash, hash, required_hash_length);
3965 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003966
3967 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003968#else
Paul Elliott068fe072023-01-16 13:59:15 +00003969 (void) operation;
3970 (void) key_buffer;
3971 (void) key_buffer_size;
3972 (void) alg;
3973 (void) hash;
3974 (void) hash_length;
3975 (void) signature;
3976 (void) signature_length;
3977 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003978 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003979 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003980
Paul Elliott068fe072023-01-16 13:59:15 +00003981 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003982#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3983 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3984 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003985}
3986
3987psa_status_t mbedtls_psa_verify_hash_complete(
3988 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3989{
3990
3991#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3992 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3993 defined(MBEDTLS_ECP_RESTARTABLE)
3994
Paul Elliottf8e5b562023-02-19 18:43:45 +00003995 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3996
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003997 /* Ensure max_ops is set to the current value (or default). */
3998 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3999
Paul Elliottf8e5b562023-02-19 18:43:45 +00004000 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004001 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4002 operation->hash,
4003 operation->hash_length,
4004 &operation->ctx->Q,
4005 &operation->r,
4006 &operation->s,
4007 &operation->restart_ctx));
4008
Paul Elliottf8e5b562023-02-19 18:43:45 +00004009 /* Hide the fact that the restart context only holds a delta of number of
4010 * ops done during the last operation, not an absolute value. */
4011 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4012
4013 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004014#else
4015 (void) operation;
4016
4017 return PSA_ERROR_NOT_SUPPORTED;
4018
4019#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4020 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4021 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4022}
4023
4024psa_status_t mbedtls_psa_verify_hash_abort(
4025 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4026{
4027
4028#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4029 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4030 defined(MBEDTLS_ECP_RESTARTABLE)
4031
4032 if (operation->ctx) {
4033 mbedtls_ecdsa_free(operation->ctx);
4034 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004035 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004036 }
4037
4038 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4039
Paul Elliott93d9ca82023-02-15 18:14:21 +00004040 operation->num_ops = 0;
4041
Paul Elliott588f8ed2022-12-02 18:10:26 +00004042 mbedtls_mpi_free(&operation->r);
4043 mbedtls_mpi_free(&operation->s);
4044
4045 return PSA_SUCCESS;
4046
4047#else
4048 (void) operation;
4049
4050 return PSA_ERROR_NOT_SUPPORTED;
4051
4052#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4053 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4054 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4055}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004056
mohammad1603503973b2018-03-12 15:59:30 +02004057/****************************************************************/
4058/* Symmetric cryptography */
4059/****************************************************************/
4060
Gilles Peskine449bd832023-01-11 14:50:10 +01004061static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4062 mbedtls_svc_key_id_t key,
4063 psa_algorithm_t alg,
4064 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004065{
4066 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4067 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004068 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4070 PSA_KEY_USAGE_ENCRYPT :
4071 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004072 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004073
4074 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004076 status = PSA_ERROR_BAD_STATE;
4077 goto exit;
4078 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004079
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004081 status = PSA_ERROR_INVALID_ARGUMENT;
4082 goto exit;
4083 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004084
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4086 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004087 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004088 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004089
Ronald Cron49fafa92021-03-10 08:34:23 +01004090 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004091 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004092 * so we only set it (in the driver wrapper) after resources have been
4093 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004094 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004095 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004096 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004098 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 }
4100 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004101
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004102 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004104 };
4105
Ronald Cronab99ac22020-10-01 16:38:28 +02004106 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004107 if (cipher_operation == MBEDTLS_ENCRYPT) {
4108 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4109 &attributes,
4110 slot->key.data,
4111 slot->key.bytes,
4112 alg);
4113 } else {
4114 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4115 &attributes,
4116 slot->key.data,
4117 slot->key.bytes,
4118 alg);
4119 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004120
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004121exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 if (status != PSA_SUCCESS) {
4123 psa_cipher_abort(operation);
4124 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004125
Ryan Everett1b70a072024-01-04 10:32:49 +00004126 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004127
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004129}
4130
Gilles Peskine449bd832023-01-11 14:50:10 +01004131psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4132 mbedtls_svc_key_id_t key,
4133 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004134{
Gilles Peskine449bd832023-01-11 14:50:10 +01004135 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004136}
4137
Gilles Peskine449bd832023-01-11 14:50:10 +01004138psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4139 mbedtls_svc_key_id_t key,
4140 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004141{
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004143}
4144
Gilles Peskine449bd832023-01-11 14:50:10 +01004145psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4146 uint8_t *iv,
4147 size_t iv_size,
4148 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004149{
Ronald Cron6d051732020-10-01 14:10:20 +02004150 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004151 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004152 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004153
Gilles Peskine449bd832023-01-11 14:50:10 +01004154 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004155 status = PSA_ERROR_BAD_STATE;
4156 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004157 }
4158
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004160 status = PSA_ERROR_BAD_STATE;
4161 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004162 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004163
Ronald Cron2fb90522021-07-05 12:31:44 +02004164 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004166 status = PSA_ERROR_BUFFER_TOO_SMALL;
4167 goto exit;
4168 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004169
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004171 status = PSA_ERROR_GENERIC_ERROR;
4172 goto exit;
4173 }
4174
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 status = psa_generate_random(local_iv, default_iv_length);
4176 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004177 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004178 }
Ronald Cron5618a392021-03-26 09:52:26 +01004179
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 status = psa_driver_wrapper_cipher_set_iv(operation,
4181 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004182
4183exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004184 if (status == PSA_SUCCESS) {
4185 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004186 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004187 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004188 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004189 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004190 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004191 }
Ronald Cron6d051732020-10-01 14:10:20 +02004192
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004194}
4195
Gilles Peskine449bd832023-01-11 14:50:10 +01004196psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4197 const uint8_t *iv,
4198 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004199{
Ronald Cron6d051732020-10-01 14:10:20 +02004200 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004201
Gilles Peskine449bd832023-01-11 14:50:10 +01004202 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004203 status = PSA_ERROR_BAD_STATE;
4204 goto exit;
4205 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004208 status = PSA_ERROR_BAD_STATE;
4209 goto exit;
4210 }
Ronald Crona0d68172021-03-26 10:15:08 +01004211
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004213 status = PSA_ERROR_INVALID_ARGUMENT;
4214 goto exit;
4215 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004216
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 status = psa_driver_wrapper_cipher_set_iv(operation,
4218 iv,
4219 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004220
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004221exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004223 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 } else {
4225 psa_cipher_abort(operation);
4226 }
4227 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004228}
4229
Gilles Peskine449bd832023-01-11 14:50:10 +01004230psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4231 const uint8_t *input,
4232 size_t input_length,
4233 uint8_t *output,
4234 size_t output_size,
4235 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004236{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004237 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004238
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004240 status = PSA_ERROR_BAD_STATE;
4241 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004242 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004243
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004245 status = PSA_ERROR_BAD_STATE;
4246 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004247 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004248
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 status = psa_driver_wrapper_cipher_update(operation,
4250 input,
4251 input_length,
4252 output,
4253 output_size,
4254 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004255
4256exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 if (status != PSA_SUCCESS) {
4258 psa_cipher_abort(operation);
4259 }
Ronald Cron6d051732020-10-01 14:10:20 +02004260
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004262}
4263
Gilles Peskine449bd832023-01-11 14:50:10 +01004264psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4265 uint8_t *output,
4266 size_t output_size,
4267 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004268{
David Saadab4ecc272019-02-14 13:48:10 +02004269 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004270
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004272 status = PSA_ERROR_BAD_STATE;
4273 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004274 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004275
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004277 status = PSA_ERROR_BAD_STATE;
4278 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004279 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004280
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 status = psa_driver_wrapper_cipher_finish(operation,
4282 output,
4283 output_size,
4284 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004285
4286exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 if (status == PSA_SUCCESS) {
4288 return psa_cipher_abort(operation);
4289 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004290 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004292
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004294 }
mohammad1603503973b2018-03-12 15:59:30 +02004295}
4296
Gilles Peskine449bd832023-01-11 14:50:10 +01004297psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004298{
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004300 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004301 * in use. It's ok to call abort on such an object, and there's
4302 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004304 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004305
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004307
Ronald Cron49fafa92021-03-10 08:34:23 +01004308 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004309 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004310 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004311
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004313}
4314
Gilles Peskine449bd832023-01-11 14:50:10 +01004315psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4316 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004317 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004318 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004319 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 size_t output_size,
4321 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004322{
4323 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004324 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004325 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004326 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4327 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004328 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004329
David Horstmann62a56d92023-12-14 18:12:47 +00004330 LOCAL_INPUT_DECLARE(input_external, input);
4331 LOCAL_OUTPUT_DECLARE(output_external, output);
4332
David Horstmann36df4b22023-12-13 15:55:25 +00004333 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004334 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004335
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004337 status = PSA_ERROR_INVALID_ARGUMENT;
4338 goto exit;
4339 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4342 PSA_KEY_USAGE_ENCRYPT,
4343 alg);
4344 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004345 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004347
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004348 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004350 };
4351
Gilles Peskine449bd832023-01-11 14:50:10 +01004352 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4353 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004354 status = PSA_ERROR_GENERIC_ERROR;
4355 goto exit;
4356 }
4357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 if (default_iv_length > 0) {
4359 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004360 status = PSA_ERROR_BUFFER_TOO_SMALL;
4361 goto exit;
4362 }
4363
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 status = psa_generate_random(local_iv, default_iv_length);
4365 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004366 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004368 }
4369
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004370 status = psa_driver_wrapper_cipher_encrypt(
4371 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004372 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004373 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004375
4376exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004377 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004379 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004380 }
Ronald Cron23919522021-07-08 19:00:07 +02004381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (status == PSA_SUCCESS) {
4383 if (default_iv_length > 0) {
4384 memcpy(output, local_iv, default_iv_length);
4385 }
4386 *output_length += default_iv_length;
4387 } else {
4388 *output_length = 0;
4389 }
4390
David Horstmann62a56d92023-12-14 18:12:47 +00004391 LOCAL_INPUT_FREE(input_external, input);
4392 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004393
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004395}
4396
Gilles Peskine449bd832023-01-11 14:50:10 +01004397psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4398 psa_algorithm_t alg,
4399 const uint8_t *input,
4400 size_t input_length,
4401 uint8_t *output,
4402 size_t output_size,
4403 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004404{
4405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004406 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004407 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004408 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004409
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004411 status = PSA_ERROR_INVALID_ARGUMENT;
4412 goto exit;
4413 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004414
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4416 PSA_KEY_USAGE_DECRYPT,
4417 alg);
4418 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004419 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004421
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004422 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004424 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004425
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4427 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004428 status = PSA_ERROR_INVALID_ARGUMENT;
4429 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004431 status = PSA_ERROR_INVALID_ARGUMENT;
4432 goto exit;
4433 }
4434
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004435 status = psa_driver_wrapper_cipher_decrypt(
4436 &attributes, slot->key.data, slot->key.bytes,
4437 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004439
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004440exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004441 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004443 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004445
Gilles Peskine449bd832023-01-11 14:50:10 +01004446 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004447 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 }
Ronald Cron23919522021-07-08 19:00:07 +02004449
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004451}
4452
4453
mohammad16035955c982018-04-26 00:53:03 +03004454/****************************************************************/
4455/* AEAD */
4456/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004457
Paul Elliottbaff51c2021-09-28 17:44:45 +01004458/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004459static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004460{
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004462}
4463
4464/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004465static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4466 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004467{
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004469
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004471#if defined(PSA_WANT_ALG_GCM)
4472 case PSA_ALG_GCM:
4473 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 * arbitrarily large nonces. Please note that we do not generally
4475 * recommend the usage of nonces of greater length than
4476 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4477 * size, which can then lead to collisions if you encrypt a very
4478 * large number of messages.*/
4479 if (nonce_length != 0) {
4480 return PSA_SUCCESS;
4481 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004482 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004483#endif /* PSA_WANT_ALG_GCM */
4484#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004485 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 if (nonce_length >= 7 && nonce_length <= 13) {
4487 return PSA_SUCCESS;
4488 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004489 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004490#endif /* PSA_WANT_ALG_CCM */
4491#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004492 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 if (nonce_length == 12) {
4494 return PSA_SUCCESS;
4495 } else if (nonce_length == 8) {
4496 return PSA_ERROR_NOT_SUPPORTED;
4497 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004498 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004499#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004500 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004501 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004503 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004504
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004506}
4507
Gilles Peskine449bd832023-01-11 14:50:10 +01004508static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004509{
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4511 return PSA_ERROR_INVALID_ARGUMENT;
4512 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004513
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004515}
4516
Gilles Peskine449bd832023-01-11 14:50:10 +01004517psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4518 psa_algorithm_t alg,
4519 const uint8_t *nonce,
4520 size_t nonce_length,
4521 const uint8_t *additional_data,
4522 size_t additional_data_length,
4523 const uint8_t *plaintext,
4524 size_t plaintext_length,
4525 uint8_t *ciphertext,
4526 size_t ciphertext_size,
4527 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004528{
Ronald Cron215633c2021-03-16 17:15:37 +01004529 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4530 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004531
mohammad1603f08a5502018-06-03 15:05:47 +03004532 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004533
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 status = psa_aead_check_algorithm(alg);
4535 if (status != PSA_SUCCESS) {
4536 return status;
4537 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004538
Ronald Cron9a986162021-03-26 12:40:07 +01004539 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4541 if (status != PSA_SUCCESS) {
4542 return status;
4543 }
mohammad16035955c982018-04-26 00:53:03 +03004544
Ronald Cron215633c2021-03-16 17:15:37 +01004545 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004547 };
mohammad16035955c982018-04-26 00:53:03 +03004548
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 status = psa_aead_check_nonce_length(alg, nonce_length);
4550 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004551 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004553
Ronald Cronde822812021-03-17 16:08:20 +01004554 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004555 &attributes, slot->key.data, slot->key.bytes,
4556 alg,
4557 nonce, nonce_length,
4558 additional_data, additional_data_length,
4559 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4563 memset(ciphertext, 0, ciphertext_size);
4564 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004565
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004566exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004567 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004568
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004570}
4571
Gilles Peskine449bd832023-01-11 14:50:10 +01004572psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4573 psa_algorithm_t alg,
4574 const uint8_t *nonce,
4575 size_t nonce_length,
4576 const uint8_t *additional_data,
4577 size_t additional_data_length,
4578 const uint8_t *ciphertext,
4579 size_t ciphertext_length,
4580 uint8_t *plaintext,
4581 size_t plaintext_size,
4582 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004583{
Ronald Cron215633c2021-03-16 17:15:37 +01004584 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4585 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004586
Gilles Peskineee652a32018-06-01 19:23:52 +02004587 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004588
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 status = psa_aead_check_algorithm(alg);
4590 if (status != PSA_SUCCESS) {
4591 return status;
4592 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004593
Ronald Cron9a986162021-03-26 12:40:07 +01004594 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4596 if (status != PSA_SUCCESS) {
4597 return status;
4598 }
mohammad16035955c982018-04-26 00:53:03 +03004599
Ronald Cron215633c2021-03-16 17:15:37 +01004600 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004602 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004603
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 status = psa_aead_check_nonce_length(alg, nonce_length);
4605 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004606 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004608
Ronald Cronde822812021-03-17 16:08:20 +01004609 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004610 &attributes, slot->key.data, slot->key.bytes,
4611 alg,
4612 nonce, nonce_length,
4613 additional_data, additional_data_length,
4614 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004616
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 if (status != PSA_SUCCESS && plaintext_size != 0) {
4618 memset(plaintext, 0, plaintext_size);
4619 }
mohammad160360a64d02018-06-03 17:20:42 +03004620
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004621exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004622 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 return status;
mohammad16035955c982018-04-26 00:53:03 +03004625}
4626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4628{
4629 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004630
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004632#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004634 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4636 return PSA_ERROR_INVALID_ARGUMENT;
4637 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004638 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004639#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004640
Przemek Stekiel86679c72022-10-06 17:06:56 +02004641#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004643 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4645 return PSA_ERROR_INVALID_ARGUMENT;
4646 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004647 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004648#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004649
Przemek Stekiel86679c72022-10-06 17:06:56 +02004650#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004652 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 if (tag_len != 16) {
4654 return PSA_ERROR_INVALID_ARGUMENT;
4655 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004656 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004657#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004658
4659 default:
4660 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004662 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004664}
4665
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004666/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004667static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4668 int is_encrypt,
4669 mbedtls_svc_key_id_t key,
4670 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004671{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004672 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4673 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4674 psa_key_slot_t *slot = NULL;
4675 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004676 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004677
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 status = psa_aead_check_algorithm(alg);
4679 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004680 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004682
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004684 status = PSA_ERROR_BAD_STATE;
4685 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004686 }
4687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 if (operation->nonce_set || operation->lengths_set ||
4689 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004690 status = PSA_ERROR_BAD_STATE;
4691 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004692 }
4693
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004695 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004697 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004699
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4701 alg);
4702 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004703 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004705
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004706 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004707 .core = slot->attr
4708 };
4709
Gilles Peskine449bd832023-01-11 14:50:10 +01004710 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004711 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004713
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 if (is_encrypt) {
4715 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4716 &attributes,
4717 slot->key.data,
4718 slot->key.bytes,
4719 alg);
4720 } else {
4721 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4722 &attributes,
4723 slot->key.data,
4724 slot->key.bytes,
4725 alg);
4726 }
4727 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004728 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004730
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004732
4733exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004734 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004735
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004737 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004739 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 } else {
4741 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004742 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004743
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004745}
4746
Paul Elliott302ff6b2021-04-20 18:10:30 +01004747/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004748psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4749 mbedtls_svc_key_id_t key,
4750 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004751{
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004753}
4754
4755/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004756psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4757 mbedtls_svc_key_id_t key,
4758 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004759{
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004761}
4762
4763/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004764psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4765 uint8_t *nonce,
4766 size_t nonce_size,
4767 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004768{
4769 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004770 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004771 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004772
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004773 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004774
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004776 status = PSA_ERROR_BAD_STATE;
4777 goto exit;
4778 }
4779
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004781 status = PSA_ERROR_BAD_STATE;
4782 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004783 }
4784
Paul Elliotte193ea82021-10-01 13:00:16 +01004785 /* For CCM, this size may not be correct according to the PSA
4786 * specification. The PSA Crypto 1.0.1 specification states:
4787 *
4788 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4789 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4790 *
4791 * However this restriction that L has to be the smallest integer is not
4792 * applied in practice, and it is not implementable here since the
4793 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4795 operation->alg);
4796 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004797 status = PSA_ERROR_BUFFER_TOO_SMALL;
4798 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004799 }
4800
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 status = psa_generate_random(local_nonce, required_nonce_size);
4802 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004803 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004805
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004807
Paul Elliott39dc6b82021-05-11 19:16:09 +01004808exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 if (status == PSA_SUCCESS) {
4810 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004811 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 } else {
4813 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004814 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004815
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004817}
4818
4819/* Set the nonce for a multipart authenticated encryption or decryption
4820 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004821psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4822 const uint8_t *nonce,
4823 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004824{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004825 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4826
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004828 status = PSA_ERROR_BAD_STATE;
4829 goto exit;
4830 }
4831
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004833 status = PSA_ERROR_BAD_STATE;
4834 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004835 }
4836
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4838 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004839 status = PSA_ERROR_INVALID_ARGUMENT;
4840 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004841 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004842
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4844 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004845
Paul Elliott39dc6b82021-05-11 19:16:09 +01004846exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004848 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 } else {
4850 psa_aead_abort(operation);
4851 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004852
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004854}
4855
4856/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004857psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4858 size_t ad_length,
4859 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004860{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004861 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4862
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004864 status = PSA_ERROR_BAD_STATE;
4865 goto exit;
4866 }
4867
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 if (operation->lengths_set || operation->ad_started ||
4869 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004870 status = PSA_ERROR_BAD_STATE;
4871 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004872 }
4873
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004875#if defined(PSA_WANT_ALG_GCM)
4876 case PSA_ALG_GCM:
4877 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 * bits. Without the guard this code will generate warnings on 32bit
4879 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004880#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (((uint64_t) ad_length) >> 61 != 0 ||
4882 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004883 status = PSA_ERROR_INVALID_ARGUMENT;
4884 goto exit;
4885 }
Paul Elliott325d3742021-09-27 17:56:28 +01004886#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004887 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004888#endif /* PSA_WANT_ALG_GCM */
4889#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004890 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004892 status = PSA_ERROR_INVALID_ARGUMENT;
4893 goto exit;
4894 }
4895 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004896#endif /* PSA_WANT_ALG_CCM */
4897#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004898 case PSA_ALG_CHACHA20_POLY1305:
4899 /* No length restrictions for ChaChaPoly. */
4900 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004901#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004902 default:
4903 break;
4904 }
Paul Elliott325d3742021-09-27 17:56:28 +01004905
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4907 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004908
Paul Elliott39dc6b82021-05-11 19:16:09 +01004909exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004911 operation->ad_remaining = ad_length;
4912 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004913 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 } else {
4915 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004916 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004917
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004919}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004920
4921/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004922psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4923 const uint8_t *input,
4924 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004925{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004926 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4927
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004929 status = PSA_ERROR_BAD_STATE;
4930 goto exit;
4931 }
4932
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004934 status = PSA_ERROR_BAD_STATE;
4935 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004936 }
4937
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 if (operation->lengths_set) {
4939 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004940 status = PSA_ERROR_INVALID_ARGUMENT;
4941 goto exit;
4942 }
4943
4944 operation->ad_remaining -= input_length;
4945 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004946#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004948 status = PSA_ERROR_BAD_STATE;
4949 goto exit;
4950 }
4951#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 status = psa_driver_wrapper_aead_update_ad(operation, input,
4954 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004955
Paul Elliott39dc6b82021-05-11 19:16:09 +01004956exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004958 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 } else {
4960 psa_aead_abort(operation);
4961 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004962
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004964}
4965
4966/* Encrypt or decrypt a message fragment in an active multipart AEAD
4967 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004968psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4969 const uint8_t *input,
4970 size_t input_length,
4971 uint8_t *output,
4972 size_t output_size,
4973 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004974{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004975 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004976
4977 *output_length = 0;
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->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004985 status = PSA_ERROR_BAD_STATE;
4986 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004987 }
4988
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004990 /* Additional data length was supplied, but not all the additional
4991 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004992 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004993 status = PSA_ERROR_INVALID_ARGUMENT;
4994 goto exit;
4995 }
4996
4997 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004999 status = PSA_ERROR_INVALID_ARGUMENT;
5000 goto exit;
5001 }
5002
5003 operation->body_remaining -= input_length;
5004 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005005#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005007 status = PSA_ERROR_BAD_STATE;
5008 goto exit;
5009 }
5010#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005011
Gilles Peskine449bd832023-01-11 14:50:10 +01005012 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5013 output, output_size,
5014 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005015
Paul Elliott39dc6b82021-05-11 19:16:09 +01005016exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005017 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005018 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005019 } else {
5020 psa_aead_abort(operation);
5021 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005022
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005024}
5025
Gilles Peskine449bd832023-01-11 14:50:10 +01005026static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005027{
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 if (operation->id == 0 || !operation->nonce_set) {
5029 return PSA_ERROR_BAD_STATE;
5030 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005031
Gilles Peskine449bd832023-01-11 14:50:10 +01005032 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5033 operation->body_remaining != 0)) {
5034 return PSA_ERROR_INVALID_ARGUMENT;
5035 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005036
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005038}
5039
Paul Elliott302ff6b2021-04-20 18:10:30 +01005040/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005041psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5042 uint8_t *ciphertext,
5043 size_t ciphertext_size,
5044 size_t *ciphertext_length,
5045 uint8_t *tag,
5046 size_t tag_size,
5047 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005048{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005049 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5050
Paul Elliott302ff6b2021-04-20 18:10:30 +01005051 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005052 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005053
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 status = psa_aead_final_checks(operation);
5055 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005056 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005058
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005060 status = PSA_ERROR_BAD_STATE;
5061 goto exit;
5062 }
5063
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5065 ciphertext_size,
5066 ciphertext_length,
5067 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005068
Paul Elliott39dc6b82021-05-11 19:16:09 +01005069exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005070
5071
Paul Elliottf47b0952021-05-21 18:02:33 +01005072 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005073 * the zero tag size, make sure the tag is set to something implausible.
5074 * Even if the operation succeeds, make sure we clear the rest of the
5075 * buffer to prevent potential leakage of anything previously placed in
5076 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005077 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005078
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005080
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005082}
5083
5084/* Finish authenticating and decrypting a message in a multipart AEAD
5085 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005086psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5087 uint8_t *plaintext,
5088 size_t plaintext_size,
5089 size_t *plaintext_length,
5090 const uint8_t *tag,
5091 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005092{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005093 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5094
Paul Elliott302ff6b2021-04-20 18:10:30 +01005095 *plaintext_length = 0;
5096
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 status = psa_aead_final_checks(operation);
5098 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005099 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005101
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005103 status = PSA_ERROR_BAD_STATE;
5104 goto exit;
5105 }
5106
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5108 plaintext_size,
5109 plaintext_length,
5110 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005111
5112exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005114
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005116}
5117
5118/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005119psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005120{
5121 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5122
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005124 /* The object has (apparently) been initialized but it is not (yet)
5125 * in use. It's ok to call abort on such an object, and there's
5126 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005128 }
5129
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005131
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005133
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005135}
5136
Gilles Peskinee59236f2018-01-27 23:32:46 +01005137/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005138/* Generators */
5139/****************************************************************/
5140
Przemek Stekiel69c46792022-06-10 12:59:51 +02005141#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005142 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005143 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305144 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305145 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005146#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005147#endif /* At least one builtin KDF */
5148
Przemek Stekiel69c46792022-06-10 12:59:51 +02005149#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005150 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5151 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5152static psa_status_t psa_key_derivation_start_hmac(
5153 psa_mac_operation_t *operation,
5154 psa_algorithm_t hash_alg,
5155 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005157{
5158 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5159 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5161 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5162 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005163
Steven Cooreman72f736a2021-05-07 14:14:37 +02005164 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005166
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 status = psa_driver_wrapper_mac_sign_setup(operation,
5168 &attributes,
5169 hmac_key, hmac_key_length,
5170 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005171
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 psa_reset_key_attributes(&attributes);
5173 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005174}
5175#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005176
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005177#define HKDF_STATE_INIT 0 /* no input yet */
5178#define HKDF_STATE_STARTED 1 /* got salt */
5179#define HKDF_STATE_KEYED 2 /* got key */
5180#define HKDF_STATE_OUTPUT 3 /* output started */
5181
Gilles Peskinecbe66502019-05-16 16:59:18 +02005182static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005184{
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5186 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5187 } else {
5188 return operation->alg;
5189 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005190}
5191
Gilles Peskine449bd832023-01-11 14:50:10 +01005192psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005193{
5194 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5196 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005197 /* The object has (apparently) been initialized but it is not
5198 * in use. It's ok to call abort on such an object, and there's
5199 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005200 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005201#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5203 mbedtls_free(operation->ctx.hkdf.info);
5204 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5205 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005206#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005207#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5208 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005209 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5210 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5211 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5212 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005213 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005215 }
5216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005218 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005220 }
5221
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005223 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005225 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005226#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005228 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005230 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005231#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005232 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005233
5234 /* We leave the fields Ai and output_block to be erased safely by the
5235 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005237#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5238 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005239#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5241 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5242 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5243 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005244#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305245#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305246 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305247 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005248 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305249 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305250 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305251
5252 status = PSA_SUCCESS;
5253 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305254#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005255 {
5256 status = PSA_ERROR_BAD_STATE;
5257 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 mbedtls_platform_zeroize(operation, sizeof(*operation));
5259 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005260}
5261
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005262psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005264{
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005266 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005268 }
5269
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005270 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005272}
5273
Gilles Peskine449bd832023-01-11 14:50:10 +01005274psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5275 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005276{
Gilles Peskine449bd832023-01-11 14:50:10 +01005277 if (operation->alg == 0) {
5278 return PSA_ERROR_BAD_STATE;
5279 }
5280 if (capacity > operation->capacity) {
5281 return PSA_ERROR_INVALID_ARGUMENT;
5282 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005283 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005285}
5286
Przemek Stekiel69c46792022-06-10 12:59:51 +02005287#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005288/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005289static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5290 psa_algorithm_t kdf_alg,
5291 uint8_t *output,
5292 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005293{
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5295 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005296 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005297 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005298#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005300#else
5301 const uint8_t last_block = 0xff;
5302#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005303
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 if (hkdf->state < HKDF_STATE_KEYED ||
5305 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005306#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005308#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 )) {
5310 return PSA_ERROR_BAD_STATE;
5311 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005312 hkdf->state = HKDF_STATE_OUTPUT;
5313
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005315 /* Copy what remains of the current block */
5316 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005318 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 }
5320 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005321 output += n;
5322 output_length -= n;
5323 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005325 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005327 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005328 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005329 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005330 * object was corrupted or if this function is called directly
5331 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 if (hkdf->block_number == last_block) {
5333 return PSA_ERROR_BAD_STATE;
5334 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005335
5336 /* We need a new block */
5337 ++hkdf->block_number;
5338 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005339
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5341 hash_alg,
5342 hkdf->prk,
5343 hash_length);
5344 if (status != PSA_SUCCESS) {
5345 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005346 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005347
5348 if (hkdf->block_number != 1) {
5349 status = psa_mac_update(&hkdf->hmac,
5350 hkdf->output_block,
5351 hash_length);
5352 if (status != PSA_SUCCESS) {
5353 return status;
5354 }
5355 }
5356 status = psa_mac_update(&hkdf->hmac,
5357 hkdf->info,
5358 hkdf->info_length);
5359 if (status != PSA_SUCCESS) {
5360 return status;
5361 }
5362 status = psa_mac_update(&hkdf->hmac,
5363 &hkdf->block_number, 1);
5364 if (status != PSA_SUCCESS) {
5365 return status;
5366 }
5367 status = psa_mac_sign_finish(&hkdf->hmac,
5368 hkdf->output_block,
5369 sizeof(hkdf->output_block),
5370 &hmac_output_length);
5371 if (status != PSA_SUCCESS) {
5372 return status;
5373 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005374 }
5375
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005377}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005378#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005379
John Durkop07cc04a2020-11-16 22:08:34 -08005380#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5381 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005382static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5383 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005385{
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5387 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005388 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5389 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005390 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005391
Janos Follath7742fee2019-06-17 12:58:10 +01005392 /* We can't be wanting more output after block 0xff, otherwise
5393 * the capacity check in psa_key_derivation_output_bytes() would have
5394 * prevented this call. It could happen only if the operation
5395 * object was corrupted or if this function is called directly
5396 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 if (tls12_prf->block_number == 0xff) {
5398 return PSA_ERROR_CORRUPTION_DETECTED;
5399 }
Janos Follath7742fee2019-06-17 12:58:10 +01005400
5401 /* We need a new block */
5402 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005403 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005404
5405 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5406 *
5407 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5408 *
5409 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5410 * HMAC_hash(secret, A(2) + seed) +
5411 * HMAC_hash(secret, A(3) + seed) + ...
5412 *
5413 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005414 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005415 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005416 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005417 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005418 * is currently extracted as `output_block` and where i is
5419 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005420 */
5421
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 status = psa_key_derivation_start_hmac(&hmac,
5423 hash_alg,
5424 tls12_prf->secret,
5425 tls12_prf->secret_length);
5426 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005427 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005429
5430 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005432 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5433 * the variable seed and in this instance means it in the context of the
5434 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 status = psa_mac_update(&hmac,
5436 tls12_prf->label,
5437 tls12_prf->label_length);
5438 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005439 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 }
5441 status = psa_mac_update(&hmac,
5442 tls12_prf->seed,
5443 tls12_prf->seed_length);
5444 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005445 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 }
5447 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005448 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5450 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005451 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005453 }
5454
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 status = psa_mac_sign_finish(&hmac,
5456 tls12_prf->Ai, hash_length,
5457 &hmac_output_length);
5458 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005459 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 }
5461 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005462 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005464
5465 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 status = psa_key_derivation_start_hmac(&hmac,
5467 hash_alg,
5468 tls12_prf->secret,
5469 tls12_prf->secret_length);
5470 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005471 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 }
5473 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5474 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005475 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 }
5477 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5478 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005479 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 }
5481 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5482 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005483 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 }
5485 status = psa_mac_sign_finish(&hmac,
5486 tls12_prf->output_block, hash_length,
5487 &hmac_output_length);
5488 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005489 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005491
Janos Follath7742fee2019-06-17 12:58:10 +01005492
5493cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 cleanup_status = psa_mac_abort(&hmac);
5495 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005496 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005498
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005500}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005501
Janos Follath844eb0e2019-06-19 12:10:49 +01005502static psa_status_t psa_key_derivation_tls12_prf_read(
5503 psa_tls12_prf_key_derivation_t *tls12_prf,
5504 psa_algorithm_t alg,
5505 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005507{
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5509 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005510 psa_status_t status;
5511 uint8_t offset, length;
5512
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005514 case PSA_TLS12_PRF_STATE_LABEL_SET:
5515 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5516 break;
5517 case PSA_TLS12_PRF_STATE_OUTPUT:
5518 break;
5519 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005521 }
5522
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005524 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 if (tls12_prf->left_in_block == 0) {
5526 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5527 alg);
5528 if (status != PSA_SUCCESS) {
5529 return status;
5530 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005531
5532 continue;
5533 }
5534
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005536 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005537 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005538 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005540
5541 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005543 output += length;
5544 output_length -= length;
5545 tls12_prf->left_in_block -= length;
5546 }
5547
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005549}
John Durkop07cc04a2020-11-16 22:08:34 -08005550#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5551 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005552
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005553#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5554static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5555 psa_tls12_ecjpake_to_pms_t *ecjpake,
5556 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005558{
5559 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005560 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005561
Gilles Peskine449bd832023-01-11 14:50:10 +01005562 if (output_length != 32) {
5563 return PSA_ERROR_INVALID_ARGUMENT;
5564 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005565
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5567 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5568 &output_size);
5569 if (status != PSA_SUCCESS) {
5570 return status;
5571 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005572
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 if (output_size != output_length) {
5574 return PSA_ERROR_GENERIC_ERROR;
5575 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005576
Gilles Peskine449bd832023-01-11 14:50:10 +01005577 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005578}
5579#endif
5580
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305581#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305582static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5583 psa_pbkdf2_key_derivation_t *pbkdf2,
5584 psa_algorithm_t prf_alg,
5585 uint8_t prf_output_length,
5586 psa_key_attributes_t *attributes)
5587{
5588 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305589 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305590 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305591 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305592 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305593 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305594 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305595
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305596 mac_operation.is_sign = 1;
5597 mac_operation.mac_size = prf_output_length;
5598 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305599
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305600 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5601 attributes,
5602 pbkdf2->password,
5603 pbkdf2->password_length,
5604 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305605 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305606 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305607 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305608 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5609 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305610 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305611 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305612 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305613 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305614 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305615 }
5616 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5617 &mac_output_length);
5618 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305619 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305620 }
5621
5622 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305623 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305624 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305625 }
5626
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305627 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305628
5629 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305630 /* We are passing prf_output_length as mac_size because the driver
5631 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305632 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305633 status = psa_driver_wrapper_mac_compute(attributes,
5634 pbkdf2->password,
5635 pbkdf2->password_length,
5636 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305637 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305638 &mac_output_length);
5639 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305640 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305641 }
5642
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305643 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305644 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305645
5646cleanup:
5647 /* Zeroise buffers to clear sensitive data from memory. */
5648 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5649 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305650}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305651
5652static psa_status_t psa_key_derivation_pbkdf2_read(
5653 psa_pbkdf2_key_derivation_t *pbkdf2,
5654 psa_algorithm_t kdf_alg,
5655 uint8_t *output,
5656 size_t output_length)
5657{
5658 psa_status_t status;
5659 psa_algorithm_t prf_alg;
5660 uint8_t prf_output_length;
5661 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5662 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5663 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5664
5665 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5666 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5667 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5668 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305669 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5670 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305671 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305672 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305673 } else {
5674 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305675 }
5676
5677 switch (pbkdf2->state) {
5678 case PSA_PBKDF2_STATE_PASSWORD_SET:
5679 /* Initially we need a new block so bytes_used is equal to block size*/
5680 pbkdf2->bytes_used = prf_output_length;
5681 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5682 break;
5683 case PSA_PBKDF2_STATE_OUTPUT:
5684 break;
5685 default:
5686 return PSA_ERROR_BAD_STATE;
5687 }
5688
5689 while (output_length != 0) {
5690 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5691 if (n > output_length) {
5692 n = (uint8_t) output_length;
5693 }
5694 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5695 output += n;
5696 output_length -= n;
5697 pbkdf2->bytes_used += n;
5698
5699 if (output_length == 0) {
5700 break;
5701 }
5702
5703 /* We need a new block */
5704 pbkdf2->bytes_used = 0;
5705 pbkdf2->block_number++;
5706
5707 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5708 prf_output_length,
5709 &attributes);
5710 if (status != PSA_SUCCESS) {
5711 return status;
5712 }
5713 }
5714
5715 return PSA_SUCCESS;
5716}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305717#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305718
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005719psa_status_t psa_key_derivation_output_bytes(
5720 psa_key_derivation_operation_t *operation,
5721 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005723{
5724 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005726
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005728 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005730 }
5731
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005733 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005734 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005735 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005736 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005737 goto exit;
5738 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005740 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005741 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005742 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5743 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005744 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005745 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005746 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005747 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005748 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005749
Przemek Stekiel69c46792022-06-10 12:59:51 +02005750#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5752 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5753 output, output_length);
5754 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005755#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005756#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5757 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005758 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5759 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5760 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5761 kdf_alg, output,
5762 output_length);
5763 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005764#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5765 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005766#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005768 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5770 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005771#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305772#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305773 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305774 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5775 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305776 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305777#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005778
Gilles Peskineeab56e42018-07-12 17:12:33 +02005779 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005780 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005782 }
5783
5784exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005785 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005786 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005787 * This allows us to differentiate between exhausted operations and
5788 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5789 * operations. */
5790 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005792 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005793 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005794 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005796}
5797
David Brown7807bf72021-02-09 16:28:23 -07005798#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005799static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005800{
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 if (data_size >= 8) {
5802 mbedtls_des_key_set_parity(data);
5803 }
5804 if (data_size >= 16) {
5805 mbedtls_des_key_set_parity(data + 8);
5806 }
5807 if (data_size >= 24) {
5808 mbedtls_des_key_set_parity(data + 16);
5809 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005810}
David Brown7807bf72021-02-09 16:28:23 -07005811#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005812
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005813/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 * ECC keys on a Weierstrass elliptic curve require the generation
5815 * of a private key which is an integer
5816 * in the range [1, N - 1], where N is the boundary of the private key domain:
5817 * N is the prime p for Diffie-Hellman, or the order of the
5818 * curve’s base point for ECC.
5819 *
5820 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5821 * This function generates the private key using the following process:
5822 *
5823 * 1. Draw a byte string of length ceiling(m/8) bytes.
5824 * 2. If m is not a multiple of 8, set the most significant
5825 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5826 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5827 * 4. If k > N - 2, discard the result and return to step 1.
5828 * 5. Output k + 1 as the private key.
5829 *
5830 * This method allows compliance to NIST standards, specifically the methods titled
5831 * Key-Pair Generation by Testing Candidates in the following publications:
5832 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5833 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5834 * Diffie-Hellman keys.
5835 *
5836 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5837 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5838 *
5839 * Note: Function allocates memory for *data buffer, so given *data should be
5840 * always NULL.
5841 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005842#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5843#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005844static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005845 psa_key_slot_t *slot,
5846 size_t bits,
5847 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005848 uint8_t **data
5849 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005850{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005851 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005852 mbedtls_mpi k;
5853 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005854 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005855 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005856 size_t m;
5857 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005858
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 mbedtls_mpi_init(&k);
5860 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005861
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005862 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005864 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005865 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005866
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005868 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005869 goto cleanup;
5870 }
5871
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005872 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005873 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005874
Gilles Peskine449bd832023-01-11 14:50:10 +01005875 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005876
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005877 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005878 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005879 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005880
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005881 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005882
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005883 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005885
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005886 /* Note: This function is always called with *data == NULL and it
5887 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 *data = mbedtls_calloc(1, m_bytes);
5889 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005890 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005891 goto cleanup;
5892 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005893
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005895 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005897 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005899
5900 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005901 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005902 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005903 * (8 * ceiling(m/8) - m) bits of the first byte in
5904 * the string to zero.
5905 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005907 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005908 }
5909
5910 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005911 * big-endian byte string.
5912 */
5913 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005914
5915 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 * Result of comparison is returned. When it indicates error
5917 * then this function is called again.
5918 */
5919 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005920 }
5921
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005922 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5924 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005925cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 if (ret != 0) {
5927 status = mbedtls_to_psa_error(ret);
5928 }
5929 if (status != PSA_SUCCESS) {
5930 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005931 *data = NULL;
5932 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 mbedtls_mpi_free(&k);
5934 mbedtls_mpi_free(&diff_N_2);
5935 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005936}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005937
5938/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5939 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5940 *
5941 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5942 * draw a 32-byte string and process it as specified in
5943 * Elliptic Curves for Security [RFC7748] §5.
5944 *
5945 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5946 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5947 *
5948 * Note: Function allocates memory for *data buffer, so given *data should be
5949 * always NULL.
5950 */
5951
5952static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5953 size_t bits,
5954 psa_key_derivation_operation_t *operation,
5955 uint8_t **data
5956 )
5957{
5958 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005959 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005960
Gilles Peskine449bd832023-01-11 14:50:10 +01005961 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005962 case 255:
5963 output_length = 32;
5964 break;
5965 case 448:
5966 output_length = 56;
5967 break;
5968 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005970 break;
5971 }
5972
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005974
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 if (*data == NULL) {
5976 return PSA_ERROR_INSUFFICIENT_MEMORY;
5977 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005978
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005980
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005982 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005984
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005986 case 255:
5987 (*data)[0] &= 248;
5988 (*data)[31] &= 127;
5989 (*data)[31] |= 64;
5990 break;
5991 case 448:
5992 (*data)[0] &= 252;
5993 (*data)[55] |= 128;
5994 break;
5995 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005997 break;
5998 }
5999
6000 return status;
6001}
Valerio Setti86587ab2023-06-27 13:09:30 +02006002#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6003static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6004 psa_key_slot_t *slot, size_t bits,
6005 psa_key_derivation_operation_t *operation, uint8_t **data)
6006{
6007 (void) slot;
6008 (void) bits;
6009 (void) operation;
6010 (void) data;
6011 return PSA_ERROR_NOT_SUPPORTED;
6012}
6013
6014static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6015 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6016{
6017 (void) bits;
6018 (void) operation;
6019 (void) data;
6020 return PSA_ERROR_NOT_SUPPORTED;
6021}
6022#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6023#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006024
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006025static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006026 psa_key_slot_t *slot,
6027 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006029{
6030 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306032 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006033 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006034 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006035
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6037 return PSA_ERROR_INVALID_ARGUMENT;
6038 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006039
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006040#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006041 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6043 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6044 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006045 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6047 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006048 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 }
6050 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006051 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6053 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006054 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006055 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006056 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006057 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006058#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006059 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 if (key_type_is_raw_bytes(slot->attr.type)) {
6061 if (bits % 8 != 0) {
6062 return PSA_ERROR_INVALID_ARGUMENT;
6063 }
6064 data = mbedtls_calloc(1, bytes);
6065 if (data == NULL) {
6066 return PSA_ERROR_INSUFFICIENT_MEMORY;
6067 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006068
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 status = psa_key_derivation_output_bytes(operation, data, bytes);
6070 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006071 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 }
David Brown12ca5032021-02-11 11:02:00 -07006073#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6075 psa_des_set_key_parity(data, bytes);
6076 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006077#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 } else {
6079 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006080 }
Ronald Crondd04d422020-11-28 15:14:42 +01006081
Ronald Cronbf33c932020-11-28 18:06:53 +01006082 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006083 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006085 };
6086
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6088 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6089 &storage_size);
6090 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306091 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 }
Archanad8a83dc2021-06-14 10:04:16 +05306093 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 status = psa_allocate_buffer_to_slot(slot, storage_size);
6095 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306096 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 }
Archanad8a83dc2021-06-14 10:04:16 +05306098
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 status = psa_driver_wrapper_import_key(&attributes,
6100 data, bytes,
6101 slot->key.data,
6102 slot->key.bytes,
6103 &slot->key.bytes, &bits);
6104 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006105 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006107
6108exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 mbedtls_free(data);
6110 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006111}
6112
Gilles Peskine449bd832023-01-11 14:50:10 +01006113psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6114 psa_key_derivation_operation_t *operation,
6115 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006116{
6117 psa_status_t status;
6118 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006119 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006120
Ronald Cron81709fc2020-11-14 12:10:32 +01006121 *key = MBEDTLS_SVC_KEY_ID_INIT;
6122
Gilles Peskine0f84d622019-09-12 19:03:13 +02006123 /* Reject any attempt to create a zero-length key so that we don't
6124 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 if (psa_get_key_bits(attributes) == 0) {
6126 return PSA_ERROR_INVALID_ARGUMENT;
6127 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006128
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 if (operation->alg == PSA_ALG_NONE) {
6130 return PSA_ERROR_BAD_STATE;
6131 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006132
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 if (!operation->can_output_key) {
6134 return PSA_ERROR_NOT_PERMITTED;
6135 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006136
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6138 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006139#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006140 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006141 /* Deriving a key in a secure element is not implemented yet. */
6142 status = PSA_ERROR_NOT_SUPPORTED;
6143 }
6144#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 if (status == PSA_SUCCESS) {
6146 status = psa_generate_derived_key_internal(slot,
6147 attributes->core.bits,
6148 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006149 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006150 if (status == PSA_SUCCESS) {
6151 status = psa_finish_key_creation(slot, driver, key);
6152 }
6153 if (status != PSA_SUCCESS) {
6154 psa_fail_key_creation(slot, driver);
6155 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006156
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006158}
6159
Gilles Peskineeab56e42018-07-12 17:12:33 +02006160
6161
6162/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006163/* Key derivation */
6164/****************************************************************/
6165
Steven Cooreman932ffb72021-02-15 12:14:32 +01006166#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006167static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006168{
6169#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6171 return 1;
6172 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006173#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006174#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6176 return 1;
6177 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006178#endif
6179#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6181 return 1;
6182 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006183#endif
6184#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6186 return 1;
6187 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006188#endif
6189#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6191 return 1;
6192 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006193#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006194#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6196 return 1;
6197 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006198#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306199#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6200 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6201 return 1;
6202 }
6203#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306204#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6205 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6206 return 1;
6207 }
6208#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006210}
6211
Gilles Peskine449bd832023-01-11 14:50:10 +01006212static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006213{
6214 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 psa_status_t status = psa_hash_setup(&operation, alg);
6216 psa_hash_abort(&operation);
6217 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006218}
6219
Gilles Peskine969c5d62019-01-16 15:53:06 +01006220static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006221 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006223{
Janos Follath5fe19732019-06-20 15:09:30 +01006224 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6225 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006227
Gilles Peskine969c5d62019-01-16 15:53:06 +01006228 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 if (!is_kdf_alg_supported(kdf_alg)) {
6230 return PSA_ERROR_NOT_SUPPORTED;
6231 }
John Durkop07cc04a2020-11-16 22:08:34 -08006232
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006233 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306234 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6236 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306237 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6238 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6239 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306240 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306241 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 if (hash_size == 0) {
6243 return PSA_ERROR_NOT_SUPPORTED;
6244 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006245
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006246 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6247 * we might fail later, which is somewhat unfriendly and potentially
6248 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 psa_status_t status = psa_hash_try_support(hash_alg);
6250 if (status != PSA_SUCCESS) {
6251 return status;
6252 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006253 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006254
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6256 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6257 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6258 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006259 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006260#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006261 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6263 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006264 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006266#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6267 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 operation->capacity = 255 * hash_size;
6269 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006270}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006271
Gilles Peskine449bd832023-01-11 14:50:10 +01006272static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006273{
6274#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 if (alg == PSA_ALG_ECDH) {
6276 return PSA_SUCCESS;
6277 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006278#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006279#if defined(PSA_WANT_ALG_FFDH)
6280 if (alg == PSA_ALG_FFDH) {
6281 return PSA_SUCCESS;
6282 }
6283#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006284 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006286}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006287
6288static int psa_key_derivation_allows_free_form_secret_input(
6289 psa_algorithm_t kdf_alg)
6290{
6291#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6292 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6293 return 0;
6294 }
6295#endif
6296 (void) kdf_alg;
6297 return 1;
6298}
John Durkop07cc04a2020-11-16 22:08:34 -08006299#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006300
Gilles Peskine449bd832023-01-11 14:50:10 +01006301psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6302 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006303{
6304 psa_status_t status;
6305
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 if (operation->alg != 0) {
6307 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006308 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006309
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6311 return PSA_ERROR_INVALID_ARGUMENT;
6312 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6313#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6314 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6315 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6316 status = psa_key_agreement_try_support(ka_alg);
6317 if (status != PSA_SUCCESS) {
6318 return status;
6319 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006320 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6321 return PSA_ERROR_INVALID_ARGUMENT;
6322 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6324#else
6325 return PSA_ERROR_NOT_SUPPORTED;
6326#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6327 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6328#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6329 status = psa_key_derivation_setup_kdf(operation, alg);
6330#else
6331 return PSA_ERROR_NOT_SUPPORTED;
6332#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6333 } else {
6334 return PSA_ERROR_INVALID_ARGUMENT;
6335 }
6336
6337 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006338 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 }
6340 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006341}
6342
Przemek Stekiel69c46792022-06-10 12:59:51 +02006343#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006344static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6345 psa_algorithm_t kdf_alg,
6346 psa_key_derivation_step_t step,
6347 const uint8_t *data,
6348 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006349{
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006351 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006352 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006353 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006354#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006355 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6356 return PSA_ERROR_INVALID_ARGUMENT;
6357 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006358#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 if (hkdf->state != HKDF_STATE_INIT) {
6360 return PSA_ERROR_BAD_STATE;
6361 } else {
6362 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6363 hash_alg,
6364 data, data_length);
6365 if (status != PSA_SUCCESS) {
6366 return status;
6367 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006368 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006370 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006371 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006372#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006374 /* We shouldn't be in different state as HKDF_EXPAND only allows
6375 * two inputs: SECRET (this case) and INFO which does not modify
6376 * the state. It could happen only if the hkdf
6377 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 if (hkdf->state != HKDF_STATE_INIT) {
6379 return PSA_ERROR_BAD_STATE;
6380 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006381
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006382 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6384 return PSA_ERROR_INVALID_ARGUMENT;
6385 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 memcpy(hkdf->prk, data, data_length);
6388 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006389#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006390 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006391 /* HKDF: If no salt was provided, use an empty salt.
6392 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006394#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6396 return PSA_ERROR_BAD_STATE;
6397 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006398#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6400 hash_alg,
6401 NULL, 0);
6402 if (status != PSA_SUCCESS) {
6403 return status;
6404 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006405 hkdf->state = HKDF_STATE_STARTED;
6406 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 if (hkdf->state != HKDF_STATE_STARTED) {
6408 return PSA_ERROR_BAD_STATE;
6409 }
6410 status = psa_mac_update(&hkdf->hmac,
6411 data, data_length);
6412 if (status != PSA_SUCCESS) {
6413 return status;
6414 }
6415 status = psa_mac_sign_finish(&hkdf->hmac,
6416 hkdf->prk,
6417 sizeof(hkdf->prk),
6418 &data_length);
6419 if (status != PSA_SUCCESS) {
6420 return status;
6421 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006422 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006423
Gilles Peskine2b522db2019-04-12 15:11:49 +02006424 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006425 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006426#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006427 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006428 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006429 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006430 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006432#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006433 {
6434 /* Block 0 is empty, and the next block will be
6435 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006437 }
6438
Gilles Peskine449bd832023-01-11 14:50:10 +01006439 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006440 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006441#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6443 return PSA_ERROR_INVALID_ARGUMENT;
6444 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006445#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006446#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6448 hkdf->state == HKDF_STATE_INIT) {
6449 return PSA_ERROR_BAD_STATE;
6450 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006451#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 if (hkdf->state == HKDF_STATE_OUTPUT) {
6453 return PSA_ERROR_BAD_STATE;
6454 }
6455 if (hkdf->info_set) {
6456 return PSA_ERROR_BAD_STATE;
6457 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006458 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006459 if (data_length != 0) {
6460 hkdf->info = mbedtls_calloc(1, data_length);
6461 if (hkdf->info == NULL) {
6462 return PSA_ERROR_INSUFFICIENT_MEMORY;
6463 }
6464 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006465 }
6466 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006468 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006469 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006470 }
6471}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006472#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006473
John Durkop07cc04a2020-11-16 22:08:34 -08006474#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6475 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006476static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6477 const uint8_t *data,
6478 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006479{
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6481 return PSA_ERROR_BAD_STATE;
6482 }
Janos Follathf08e2652019-06-13 09:05:41 +01006483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 if (data_length != 0) {
6485 prf->seed = mbedtls_calloc(1, data_length);
6486 if (prf->seed == NULL) {
6487 return PSA_ERROR_INSUFFICIENT_MEMORY;
6488 }
Janos Follathf08e2652019-06-13 09:05:41 +01006489
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006491 prf->seed_length = data_length;
6492 }
Janos Follathf08e2652019-06-13 09:05:41 +01006493
Gilles Peskine43f958b2020-12-13 14:55:14 +01006494 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006495
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006497}
6498
Gilles Peskine449bd832023-01-11 14:50:10 +01006499static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6500 const uint8_t *data,
6501 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006502{
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6504 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6505 return PSA_ERROR_BAD_STATE;
6506 }
Janos Follath81550542019-06-13 14:26:34 +01006507
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 if (data_length != 0) {
6509 prf->secret = mbedtls_calloc(1, data_length);
6510 if (prf->secret == NULL) {
6511 return PSA_ERROR_INSUFFICIENT_MEMORY;
6512 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006513
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006515 prf->secret_length = data_length;
6516 }
Janos Follath81550542019-06-13 14:26:34 +01006517
Gilles Peskine43f958b2020-12-13 14:55:14 +01006518 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006521}
6522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6524 const uint8_t *data,
6525 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006526{
Gilles Peskine449bd832023-01-11 14:50:10 +01006527 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6528 return PSA_ERROR_BAD_STATE;
6529 }
Janos Follath63028dd2019-06-13 09:15:47 +01006530
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 if (data_length != 0) {
6532 prf->label = mbedtls_calloc(1, data_length);
6533 if (prf->label == NULL) {
6534 return PSA_ERROR_INSUFFICIENT_MEMORY;
6535 }
Janos Follath63028dd2019-06-13 09:15:47 +01006536
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006538 prf->label_length = data_length;
6539 }
Janos Follath63028dd2019-06-13 09:15:47 +01006540
Gilles Peskine43f958b2020-12-13 14:55:14 +01006541 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006542
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006544}
6545
Gilles Peskine449bd832023-01-11 14:50:10 +01006546static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6547 psa_key_derivation_step_t step,
6548 const uint8_t *data,
6549 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006550{
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006552 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006554 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006556 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006558 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006560 }
6561}
John Durkop07cc04a2020-11-16 22:08:34 -08006562#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6563 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6564
6565#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6566static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6567 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006568 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006569 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006570{
6571 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6573 4 + data_length + prf->other_secret_length :
6574 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006575
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6577 return PSA_ERROR_INVALID_ARGUMENT;
6578 }
John Durkop07cc04a2020-11-16 22:08:34 -08006579
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 uint8_t *pms = mbedtls_calloc(1, pms_len);
6581 if (pms == NULL) {
6582 return PSA_ERROR_INSUFFICIENT_MEMORY;
6583 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006584 uint8_t *cur = pms;
6585
6586 /* pure-PSK:
6587 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006588 *
6589 * The premaster secret is formed as follows: if the PSK is N octets
6590 * long, concatenate a uint16 with the value N, N zero octets, a second
6591 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006592 *
6593 * mixed-PSK:
6594 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6595 * follows: concatenate a uint16 with the length of the other secret,
6596 * the other secret itself, uint16 with the length of PSK, and the
6597 * PSK itself.
6598 * For details please check:
6599 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6600 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6601 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006602 */
6603
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6605 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6606 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6607 if (prf->other_secret_length != 0) {
6608 memcpy(cur, prf->other_secret, prf->other_secret_length);
6609 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006610 cur += prf->other_secret_length;
6611 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 } else {
6613 *cur++ = MBEDTLS_BYTE_1(data_length);
6614 *cur++ = MBEDTLS_BYTE_0(data_length);
6615 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006616 cur += data_length;
6617 }
6618
Gilles Peskine449bd832023-01-11 14:50:10 +01006619 *cur++ = MBEDTLS_BYTE_1(data_length);
6620 *cur++ = MBEDTLS_BYTE_0(data_length);
6621 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006622 cur += data_length;
6623
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006624 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006625
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006626 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006627 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006628}
Janos Follath6660f0e2019-06-17 08:44:03 +01006629
Przemek Stekiele47201b2022-04-19 13:53:28 +02006630static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6631 psa_tls12_prf_key_derivation_t *prf,
6632 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006633 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006634{
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6636 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006637 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006638
6639 if (data_length != 0) {
6640 prf->other_secret = mbedtls_calloc(1, data_length);
6641 if (prf->other_secret == NULL) {
6642 return PSA_ERROR_INSUFFICIENT_MEMORY;
6643 }
6644
6645 memcpy(prf->other_secret, data, data_length);
6646 prf->other_secret_length = data_length;
6647 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006648 prf->other_secret_length = 0;
6649 }
6650
6651 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6652
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006654}
6655
Janos Follath6660f0e2019-06-17 08:44:03 +01006656static psa_status_t psa_tls12_prf_psk_to_ms_input(
6657 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006658 psa_key_derivation_step_t step,
6659 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006660 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006661{
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006663 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006664 return psa_tls12_prf_psk_to_ms_set_key(prf,
6665 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006666 break;
6667 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006668 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6669 data,
6670 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006671 break;
6672 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006673 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006674 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006675
Przemek Stekiele47201b2022-04-19 13:53:28 +02006676 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006677}
John Durkop07cc04a2020-11-16 22:08:34 -08006678#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006679
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006680#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6681static psa_status_t psa_tls12_ecjpake_to_pms_input(
6682 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006683 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006684 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006686{
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6688 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6689 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006690 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006691
6692 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006693 if (data[0] != 0x04) {
6694 return PSA_ERROR_INVALID_ARGUMENT;
6695 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006696
6697 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006698 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006701}
6702#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306703
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306704#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306705static psa_status_t psa_pbkdf2_set_input_cost(
6706 psa_pbkdf2_key_derivation_t *pbkdf2,
6707 psa_key_derivation_step_t step,
6708 uint64_t data)
6709{
6710 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6711 return PSA_ERROR_INVALID_ARGUMENT;
6712 }
6713
6714 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6715 return PSA_ERROR_BAD_STATE;
6716 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306717
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306718 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306719 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306720 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306721
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306722 if (data == 0) {
6723 return PSA_ERROR_INVALID_ARGUMENT;
6724 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306725
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306726 pbkdf2->input_cost = data;
6727 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6728
6729 return PSA_SUCCESS;
6730}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306731
6732static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6733 const uint8_t *data,
6734 size_t data_length)
6735{
Gilles Peskineead17662023-08-20 22:02:51 +02006736 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6737 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6738 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6739 /* Appending to existing salt. No state change. */
6740 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306741 return PSA_ERROR_BAD_STATE;
6742 }
6743
Gilles Peskineca57d782023-07-20 19:08:06 +02006744 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006745 /* Appending an empty string, nothing to do. */
6746 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306747 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306748
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306749 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6750 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306751 return PSA_ERROR_INSUFFICIENT_MEMORY;
6752 }
6753
Gilles Peskineead17662023-08-20 22:02:51 +02006754 if (pbkdf2->salt_length != 0) {
6755 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6756 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306757 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306758 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306759 mbedtls_free(pbkdf2->salt);
6760 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306761 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306762 return PSA_SUCCESS;
6763}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306764
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306765#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306766static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306767 const uint8_t *input,
6768 size_t input_len,
6769 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306770 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306771{
6772 psa_status_t status = PSA_SUCCESS;
6773 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6774 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306775 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306776 } else {
6777 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306778 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306779 }
6780 return status;
6781}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306782#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306783
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306784#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306785static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6786 size_t input_len,
6787 uint8_t *output,
6788 size_t *output_len)
6789{
6790 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306791 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306792 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306793 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306794 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6795 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6796 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306797 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306798 * mac_size as the driver function sets mac_output_length = mac_size
6799 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306800 status = psa_driver_wrapper_mac_compute(&attributes,
6801 zeros, sizeof(zeros),
6802 PSA_ALG_CMAC, input, input_len,
6803 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306804 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6805 128U,
6806 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306807 output_len);
6808 } else {
6809 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306810 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306811 }
6812 return status;
6813}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306814#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306815
6816static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306817 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306818 const uint8_t *data,
6819 size_t data_length)
6820{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306821 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306822 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6823 return PSA_ERROR_BAD_STATE;
6824 }
6825
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306826#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306827 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6828 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6829 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6830 pbkdf2->password,
6831 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306832 } else
6833#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6834#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6835 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306836 status = psa_pbkdf2_cmac_set_password(data, data_length,
6837 pbkdf2->password,
6838 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306839 } else
6840#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6841 {
6842 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306843 }
6844
6845 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6846
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306847 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306848}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306849
6850static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306851 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306852 psa_key_derivation_step_t step,
6853 const uint8_t *data,
6854 size_t data_length)
6855{
6856 switch (step) {
6857 case PSA_KEY_DERIVATION_INPUT_SALT:
6858 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6859 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306860 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306861 default:
6862 return PSA_ERROR_INVALID_ARGUMENT;
6863 }
6864}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306865#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306866
Gilles Peskineb8965192019-09-24 16:21:10 +02006867/** Check whether the given key type is acceptable for the given
6868 * input step of a key derivation.
6869 *
6870 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6871 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6872 * Both secret and non-secret inputs can alternatively have the type
6873 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6874 * that the input was passed as a buffer rather than via a key object.
6875 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006876static int psa_key_derivation_check_input_type(
6877 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006879{
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006881 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 if (key_type == PSA_KEY_TYPE_DERIVE) {
6883 return PSA_SUCCESS;
6884 }
6885 if (key_type == PSA_KEY_TYPE_NONE) {
6886 return PSA_SUCCESS;
6887 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006888 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006889 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 if (key_type == PSA_KEY_TYPE_DERIVE) {
6891 return PSA_SUCCESS;
6892 }
6893 if (key_type == PSA_KEY_TYPE_NONE) {
6894 return PSA_SUCCESS;
6895 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006896 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006897 case PSA_KEY_DERIVATION_INPUT_LABEL:
6898 case PSA_KEY_DERIVATION_INPUT_SALT:
6899 case PSA_KEY_DERIVATION_INPUT_INFO:
6900 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6902 return PSA_SUCCESS;
6903 }
6904 if (key_type == PSA_KEY_TYPE_NONE) {
6905 return PSA_SUCCESS;
6906 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006907 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306908 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6909 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6910 return PSA_SUCCESS;
6911 }
6912 if (key_type == PSA_KEY_TYPE_DERIVE) {
6913 return PSA_SUCCESS;
6914 }
6915 if (key_type == PSA_KEY_TYPE_NONE) {
6916 return PSA_SUCCESS;
6917 }
6918 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006919 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006921}
6922
Janos Follathb80a94e2019-06-12 15:54:46 +01006923static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006924 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006925 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006926 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006927 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006929{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006930 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 status = psa_key_derivation_check_input_type(step, key_type);
6934 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006935 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006937
Przemek Stekiel69c46792022-06-10 12:59:51 +02006938#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006939 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6940 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6941 step, data, data_length);
6942 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006943#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006944#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6946 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6947 step, data, data_length);
6948 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006949#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6950#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6952 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6953 step, data, data_length);
6954 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006955#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006956#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006957 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006958 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6960 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006961#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306962#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306963 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306964 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6965 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306966 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306967#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006968 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006969 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006970 (void) data;
6971 (void) data_length;
6972 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006974 }
6975
Gilles Peskine224b0d62019-09-23 18:13:17 +02006976exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 if (status != PSA_SUCCESS) {
6978 psa_key_derivation_abort(operation);
6979 }
6980 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006981}
6982
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306983static psa_status_t psa_key_derivation_input_integer_internal(
6984 psa_key_derivation_operation_t *operation,
6985 psa_key_derivation_step_t step,
6986 uint64_t value)
6987{
6988 psa_status_t status;
6989 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6990
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306991#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306992 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306993 status = psa_pbkdf2_set_input_cost(
6994 &operation->ctx.pbkdf2, step, value);
6995 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306996#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306997 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306998 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306999 (void) value;
7000 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307001 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307002 }
7003
7004 if (status != PSA_SUCCESS) {
7005 psa_key_derivation_abort(operation);
7006 }
7007 return status;
7008}
7009
Janos Follath51f4a0f2019-06-14 11:35:55 +01007010psa_status_t psa_key_derivation_input_bytes(
7011 psa_key_derivation_operation_t *operation,
7012 psa_key_derivation_step_t step,
7013 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007015{
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 return psa_key_derivation_input_internal(operation, step,
7017 PSA_KEY_TYPE_NONE,
7018 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007019}
7020
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307021psa_status_t psa_key_derivation_input_integer(
7022 psa_key_derivation_operation_t *operation,
7023 psa_key_derivation_step_t step,
7024 uint64_t value)
7025{
7026 return psa_key_derivation_input_integer_internal(operation, step, value);
7027}
7028
Janos Follath51f4a0f2019-06-14 11:35:55 +01007029psa_status_t psa_key_derivation_input_key(
7030 psa_key_derivation_operation_t *operation,
7031 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007033{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007034 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007035 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007036 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007037
Ronald Cron5c522922020-11-14 16:35:34 +01007038 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7040 if (status != PSA_SUCCESS) {
7041 psa_key_derivation_abort(operation);
7042 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007043 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007044
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307045 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7046 * permission to output to a key object. */
7047 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7048 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007049 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007050 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007051
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 status = psa_key_derivation_input_internal(operation,
7053 step, slot->attr.type,
7054 slot->key.data,
7055 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007056
Ryan Everett1b70a072024-01-04 10:32:49 +00007057 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007058
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007060}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007061
7062
7063
7064/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007065/* Key agreement */
7066/****************************************************************/
7067
Gilles Peskine449bd832023-01-11 14:50:10 +01007068psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7069 const uint8_t *key_buffer,
7070 size_t key_buffer_size,
7071 psa_algorithm_t alg,
7072 const uint8_t *peer_key,
7073 size_t peer_key_length,
7074 uint8_t *shared_secret,
7075 size_t shared_secret_size,
7076 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007077{
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007079#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007080 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7082 key_buffer_size, alg,
7083 peer_key, peer_key_length,
7084 shared_secret,
7085 shared_secret_size,
7086 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007087#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007088
7089#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7090 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007091 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007092 peer_key,
7093 peer_key_length,
7094 key_buffer,
7095 key_buffer_size,
7096 shared_secret,
7097 shared_secret_size,
7098 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007099#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7100
Gilles Peskine01d718c2018-09-18 12:01:02 +02007101 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007102 (void) attributes;
7103 (void) key_buffer;
7104 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007105 (void) peer_key;
7106 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007107 (void) shared_secret;
7108 (void) shared_secret_size;
7109 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007111 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007112}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007113
Aditya Deshpande17845b82022-10-13 17:21:01 +01007114/** Internal function for raw key agreement
7115 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007116 * to the driver's implementation if a driver is present.
7117 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007118 * (psa_key_agreement_raw_builtin).
7119 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007120static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7121 psa_key_slot_t *private_key,
7122 const uint8_t *peer_key,
7123 size_t peer_key_length,
7124 uint8_t *shared_secret,
7125 size_t shared_secret_size,
7126 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007127{
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7129 return PSA_ERROR_NOT_SUPPORTED;
7130 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007131
7132 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007134 };
7135
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 return psa_driver_wrapper_key_agreement(&attributes,
7137 private_key->key.data,
7138 private_key->key.bytes, alg,
7139 peer_key, peer_key_length,
7140 shared_secret,
7141 shared_secret_size,
7142 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007143}
7144
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007145/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007146 * to potentially free embedded data structures and wipe confidential data.
7147 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007148static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7149 psa_key_derivation_step_t step,
7150 psa_key_slot_t *private_key,
7151 const uint8_t *peer_key,
7152 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007153{
7154 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007155 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007156 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007158
7159 /* Step 1: run the secret agreement algorithm to generate the shared
7160 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 status = psa_key_agreement_raw_internal(ka_alg,
7162 private_key,
7163 peer_key, peer_key_length,
7164 shared_secret,
7165 sizeof(shared_secret),
7166 &shared_secret_length);
7167 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007168 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007170
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007171 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007172 * the shared secret. A shared secret is permitted wherever a key
7173 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 status = psa_key_derivation_input_internal(operation, step,
7175 PSA_KEY_TYPE_DERIVE,
7176 shared_secret,
7177 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007178exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7180 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007181}
7182
Gilles Peskine449bd832023-01-11 14:50:10 +01007183psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7184 psa_key_derivation_step_t step,
7185 mbedtls_svc_key_id_t private_key,
7186 const uint8_t *peer_key,
7187 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007188{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007189 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007190 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007191 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007192
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7194 return PSA_ERROR_INVALID_ARGUMENT;
7195 }
Ronald Cron5c522922020-11-14 16:35:34 +01007196 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7198 if (status != PSA_SUCCESS) {
7199 return status;
7200 }
7201 status = psa_key_agreement_internal(operation, step,
7202 slot,
7203 peer_key, peer_key_length);
7204 if (status != PSA_SUCCESS) {
7205 psa_key_derivation_abort(operation);
7206 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007207 /* If a private key has been added as SECRET, we allow the derived
7208 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007210 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007212 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007213
Ryan Everett1b70a072024-01-04 10:32:49 +00007214 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007215
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007217}
7218
Gilles Peskine449bd832023-01-11 14:50:10 +01007219psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7220 mbedtls_svc_key_id_t private_key,
7221 const uint8_t *peer_key,
7222 size_t peer_key_length,
7223 uint8_t *output,
7224 size_t output_size,
7225 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007226{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007227 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007228 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007229 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007230 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007231
Gilles Peskine449bd832023-01-11 14:50:10 +01007232 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007233 status = PSA_ERROR_INVALID_ARGUMENT;
7234 goto exit;
7235 }
Ronald Cron5c522922020-11-14 16:35:34 +01007236 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7238 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007239 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007241
Gilles Peskine3e561302022-04-14 00:17:15 +02007242 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7243 * for the output size. The PSA specification only guarantees that this
7244 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7245 * but it might be nice to allow smaller buffers if the output fits.
7246 * At the time of writing this comment, with only ECDH implemented,
7247 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7248 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7249 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007250 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007251 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7252 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007253 status = PSA_ERROR_BUFFER_TOO_SMALL;
7254 goto exit;
7255 }
7256
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 status = psa_key_agreement_raw_internal(alg, slot,
7258 peer_key, peer_key_length,
7259 output, output_size,
7260 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007261
7262exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007264 /* If an error happens and is not handled properly, the output
7265 * may be used as a key to protect sensitive data. Arrange for such
7266 * a key to be random, which is likely to result in decryption or
7267 * verification errors. This is better than filling the buffer with
7268 * some constant data such as zeros, which would result in the data
7269 * being protected with a reproducible, easily knowable key.
7270 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007272 *output_length = output_size;
7273 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007274
Ryan Everett1b70a072024-01-04 10:32:49 +00007275 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007276
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007278}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007279
7280
Gilles Peskine30524eb2020-11-13 17:02:26 +01007281
Gilles Peskine86a440b2018-11-12 18:39:40 +01007282/****************************************************************/
7283/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007284/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007285
Gilles Peskine672a7712023-04-28 21:00:28 +02007286#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7287#include "entropy_poll.h"
7288#endif
7289
Gilles Peskine30524eb2020-11-13 17:02:26 +01007290/** Initialize the PSA random generator.
7291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007292static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007293{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007294#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007296#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7297
Gilles Peskine30524eb2020-11-13 17:02:26 +01007298 /* Set default configuration if
7299 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007300 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007301 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 }
7303 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007304 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007305 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007306
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007308#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7309 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7310 /* The PSA entropy injection feature depends on using NV seed as an entropy
7311 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 mbedtls_entropy_add_source(&rng->entropy,
7313 mbedtls_nv_seed_poll, NULL,
7314 MBEDTLS_ENTROPY_BLOCK_SIZE,
7315 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007316#endif
7317
Gilles Peskine449bd832023-01-11 14:50:10 +01007318 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007319#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007320}
7321
7322/** Deinitialize the PSA random generator.
7323 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007324static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007325{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007326#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007327 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007328#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007329 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7330 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007331#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007332}
7333
7334/** Seed the PSA random generator.
7335 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007336static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007337{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007338#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7339 /* Do nothing: the external RNG seeds itself. */
7340 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007341 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007342#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007343 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7345 drbg_seed, sizeof(drbg_seed) - 1);
7346 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007347#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007348}
7349
Gilles Peskine449bd832023-01-11 14:50:10 +01007350psa_status_t psa_generate_random(uint8_t *output,
7351 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007352{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007353 GUARD_MODULE_INITIALIZED;
7354
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007355#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7356
7357 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7359 output, output_size,
7360 &output_length);
7361 if (status != PSA_SUCCESS) {
7362 return status;
7363 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007364 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007365 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 if (output_length != output_size) {
7367 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7368 }
7369 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007370
7371#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7372
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007374 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7376 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7377 output_size);
7378 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7379 output, request_size);
7380 if (ret != 0) {
7381 return mbedtls_to_psa_error(ret);
7382 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007383 output_size -= request_size;
7384 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007385 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007387#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007388}
7389
Gilles Peskine8814fc42020-12-14 15:33:44 +01007390/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007391 *
7392 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7393 * `psa_generate_random(...)`. The state parameter is ignored since the
7394 * PSA API doesn't support passing an explicit state.
7395 *
7396 * In the non-external case, psa_generate_random() calls an
7397 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7398 * and semantics as mbedtls_psa_get_random(). As an optimization,
7399 * instead of doing this back-and-forth between the PSA API and the
7400 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7401 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007402 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007403#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7404int mbedtls_psa_get_random(void *p_rng,
7405 unsigned char *output,
7406 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007407{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007408 /* This function takes a pointer to the RNG state because that's what
7409 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7410 * its own state internally and doesn't let the caller access that state.
7411 * So we just ignore the state parameter, and in practice we'll pass
7412 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007413 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 psa_status_t status = psa_generate_random(output, output_size);
7415 if (status == PSA_SUCCESS) {
7416 return 0;
7417 } else {
7418 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7419 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007420}
7421#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7422
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007423#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007424psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7425 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007426{
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 if (global_data.initialized) {
7428 return PSA_ERROR_NOT_PERMITTED;
7429 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007430
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7432 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7433 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7434 return PSA_ERROR_INVALID_ARGUMENT;
7435 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007436
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007438}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007439#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007440
Ronald Cron3772afe2021-02-08 16:10:05 +01007441/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007442 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007443 * \param type The key type
7444 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007445 *
7446 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007447 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007448 * \retval #PSA_ERROR_INVALID_ARGUMENT
7449 * The size in bits of the key is not valid.
7450 * \retval #PSA_ERROR_NOT_SUPPORTED
7451 * The type and/or the size in bits of the key or the combination of
7452 * the two is not supported.
7453 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007454static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007456{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007457 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007458
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 if (key_type_is_raw_bytes(type)) {
7460 status = psa_validate_unstructured_key_bit_size(type, bits);
7461 if (status != PSA_SUCCESS) {
7462 return status;
7463 }
7464 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007465#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7467 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7468 return PSA_ERROR_NOT_SUPPORTED;
7469 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007470 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007471 return PSA_ERROR_NOT_SUPPORTED;
7472 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007473
Ronald Cron01b2aba2020-10-05 09:42:02 +02007474 /* Accept only byte-aligned keys, for the same reasons as
7475 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 if (bits % 8 != 0) {
7477 return PSA_ERROR_NOT_SUPPORTED;
7478 }
7479 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007480#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007481
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007482#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007484 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 return PSA_SUCCESS;
7486 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007487#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007488
Valerio Settia55f0422023-07-10 15:34:41 +02007489#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007490 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007491 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007492 return PSA_ERROR_NOT_SUPPORTED;
7493 }
7494 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007495#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007496 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007498 }
7499
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007501}
7502
Ronald Cron55ed0592020-10-05 10:30:40 +02007503psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007504 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007506{
7507 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007508 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007509
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 if ((attributes->domain_parameters == NULL) &&
7511 (attributes->domain_parameters_size != 0)) {
7512 return PSA_ERROR_INVALID_ARGUMENT;
7513 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007514
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 if (key_type_is_raw_bytes(type)) {
7516 status = psa_generate_random(key_buffer, key_buffer_size);
7517 if (status != PSA_SUCCESS) {
7518 return status;
7519 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007520
David Brown12ca5032021-02-11 11:02:00 -07007521#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 if (type == PSA_KEY_TYPE_DES) {
7523 psa_des_set_key_parity(key_buffer, key_buffer_size);
7524 }
David Brown8107e312021-02-12 08:08:46 -07007525#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007527
Valerio Setti76df8c12023-07-11 14:11:28 +02007528#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7530 return mbedtls_psa_rsa_generate_key(attributes,
7531 key_buffer,
7532 key_buffer_size,
7533 key_buffer_length);
7534 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007535#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007536
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007537#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7539 return mbedtls_psa_ecp_generate_key(attributes,
7540 key_buffer,
7541 key_buffer_size,
7542 key_buffer_length);
7543 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007544#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007545
Valerio Settia55f0422023-07-10 15:34:41 +02007546#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007547 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7548 return mbedtls_psa_ffdh_generate_key(attributes,
7549 key_buffer,
7550 key_buffer_size,
7551 key_buffer_length);
7552 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007553#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007554 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 (void) key_buffer_length;
7556 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007557 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007558
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007560}
Darryl Green0c6575a2018-11-07 16:05:30 +00007561
Gilles Peskine449bd832023-01-11 14:50:10 +01007562psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7563 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007564{
7565 psa_status_t status;
7566 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007567 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007568 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007569
Ronald Cron81709fc2020-11-14 12:10:32 +01007570 *key = MBEDTLS_SVC_KEY_ID_INIT;
7571
Gilles Peskine0f84d622019-09-12 19:03:13 +02007572 /* Reject any attempt to create a zero-length key so that we don't
7573 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 if (psa_get_key_bits(attributes) == 0) {
7575 return PSA_ERROR_INVALID_ARGUMENT;
7576 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007577
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007578 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7580 return PSA_ERROR_INVALID_ARGUMENT;
7581 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007582
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7584 &slot, &driver);
7585 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007586 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 }
Gilles Peskine11792082019-08-06 18:36:36 +02007588
Ronald Cron977c2472020-10-13 08:32:21 +02007589 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307590 * storage ( thus not in the case of generating a key in a secure element
7591 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7592 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 if (slot->key.data == NULL) {
7594 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7595 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007596 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 attributes->core.type, attributes->core.bits);
7598 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007599 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007601
7602 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 attributes->core.type,
7604 attributes->core.bits);
7605 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007606 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 attributes, &key_buffer_size);
7608 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007609 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 }
Ronald Cron977c2472020-10-13 08:32:21 +02007611 }
Ronald Cron977c2472020-10-13 08:32:21 +02007612
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7614 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007615 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 }
Ronald Cron977c2472020-10-13 08:32:21 +02007617 }
7618
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 status = psa_driver_wrapper_generate_key(attributes,
7620 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007621
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 if (status != PSA_SUCCESS) {
7623 psa_remove_key_data_from_memory(slot);
7624 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007625
Gilles Peskine11792082019-08-06 18:36:36 +02007626exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 if (status == PSA_SUCCESS) {
7628 status = psa_finish_key_creation(slot, driver, key);
7629 }
7630 if (status != PSA_SUCCESS) {
7631 psa_fail_key_creation(slot, driver);
7632 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007633
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007635}
7636
Gilles Peskinee59236f2018-01-27 23:32:46 +01007637/****************************************************************/
7638/* Module setup */
7639/****************************************************************/
7640
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007641#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007642psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 void (* entropy_init)(mbedtls_entropy_context *ctx),
7644 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007645{
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7647 return PSA_ERROR_BAD_STATE;
7648 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007649 global_data.rng.entropy_init = entropy_init;
7650 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007652}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007653#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007654
Gilles Peskine449bd832023-01-11 14:50:10 +01007655void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007656{
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007658 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7659 mbedtls_psa_random_free(&global_data.rng);
7660 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007661 /* Wipe all remaining data, including configuration.
7662 * In particular, this sets all state indicator to the value
7663 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007665
7666 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007667 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007668}
7669
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007670#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7671/** Recover a transaction that was interrupted by a power failure.
7672 *
7673 * This function is called during initialization, before psa_crypto_init()
7674 * returns. If this function returns a failure status, the initialization
7675 * fails.
7676 */
7677static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007679{
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007681 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7682 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 /* TODO - fall through to the failure case until this
7684 * is implemented.
7685 * https://github.com/ARMmbed/mbed-crypto/issues/218
7686 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007687 default:
7688 /* We found an unsupported transaction in the storage.
7689 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007690 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007691 }
7692}
7693#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7694
Gilles Peskine449bd832023-01-11 14:50:10 +01007695psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007696{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007697 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007698
Gilles Peskinec6b69072018-11-20 21:42:52 +01007699 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007700 if (global_data.initialized != 0) {
7701 return PSA_SUCCESS;
7702 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007703
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007704 /* Init drivers */
7705 status = psa_driver_wrapper_init();
7706 if (status != PSA_SUCCESS) {
7707 goto exit;
7708 }
7709 global_data.drivers_initialized = 1;
7710
Valerio Setti402cfba2023-11-13 10:24:32 +01007711 status = psa_initialize_key_slots();
7712 if (status != PSA_SUCCESS) {
7713 goto exit;
7714 }
7715
Gilles Peskine30524eb2020-11-13 17:02:26 +01007716 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007718 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 status = mbedtls_psa_random_seed(&global_data.rng);
7720 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007721 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007722 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007723 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007724
Gilles Peskine4b734222019-07-24 15:56:31 +02007725#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007726 status = psa_crypto_load_transaction();
7727 if (status == PSA_SUCCESS) {
7728 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7729 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007730 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 }
7732 status = psa_crypto_stop_transaction();
7733 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007734 /* There's no transaction to complete. It's all good. */
7735 status = PSA_SUCCESS;
7736 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007737#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007738
Gilles Peskinec6b69072018-11-20 21:42:52 +01007739 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007740 global_data.initialized = 1;
7741
7742exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 if (status != PSA_SUCCESS) {
7744 mbedtls_psa_crypto_free();
7745 }
7746 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007747}
7748
Yanray Wangffc3c482023-07-11 12:01:04 +08007749#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007750psa_status_t psa_crypto_driver_pake_get_password_len(
7751 const psa_crypto_driver_pake_inputs_t *inputs,
7752 size_t *password_len)
7753{
7754 if (inputs->password_len == 0) {
7755 return PSA_ERROR_BAD_STATE;
7756 }
7757
7758 *password_len = inputs->password_len;
7759
7760 return PSA_SUCCESS;
7761}
7762
7763psa_status_t psa_crypto_driver_pake_get_password(
7764 const psa_crypto_driver_pake_inputs_t *inputs,
7765 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7766{
7767 if (inputs->password_len == 0) {
7768 return PSA_ERROR_BAD_STATE;
7769 }
7770
7771 if (buffer_size < inputs->password_len) {
7772 return PSA_ERROR_BUFFER_TOO_SMALL;
7773 }
7774
7775 memcpy(buffer, inputs->password, inputs->password_len);
7776 *buffer_length = inputs->password_len;
7777
7778 return PSA_SUCCESS;
7779}
7780
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007781psa_status_t psa_crypto_driver_pake_get_user_len(
7782 const psa_crypto_driver_pake_inputs_t *inputs,
7783 size_t *user_len)
7784{
7785 if (inputs->user_len == 0) {
7786 return PSA_ERROR_BAD_STATE;
7787 }
7788
7789 *user_len = inputs->user_len;
7790
7791 return PSA_SUCCESS;
7792}
7793
7794psa_status_t psa_crypto_driver_pake_get_user(
7795 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007796 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007797{
7798 if (inputs->user_len == 0) {
7799 return PSA_ERROR_BAD_STATE;
7800 }
7801
Przemek Stekielc0e62502023-03-14 11:49:36 +01007802 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007803 return PSA_ERROR_BUFFER_TOO_SMALL;
7804 }
7805
Przemek Stekielc0e62502023-03-14 11:49:36 +01007806 memcpy(user_id, inputs->user, inputs->user_len);
7807 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007808
7809 return PSA_SUCCESS;
7810}
7811
7812psa_status_t psa_crypto_driver_pake_get_peer_len(
7813 const psa_crypto_driver_pake_inputs_t *inputs,
7814 size_t *peer_len)
7815{
7816 if (inputs->peer_len == 0) {
7817 return PSA_ERROR_BAD_STATE;
7818 }
7819
7820 *peer_len = inputs->peer_len;
7821
7822 return PSA_SUCCESS;
7823}
7824
7825psa_status_t psa_crypto_driver_pake_get_peer(
7826 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007827 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007828{
7829 if (inputs->peer_len == 0) {
7830 return PSA_ERROR_BAD_STATE;
7831 }
7832
Przemek Stekielc0e62502023-03-14 11:49:36 +01007833 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007834 return PSA_ERROR_BUFFER_TOO_SMALL;
7835 }
7836
Przemek Stekielc0e62502023-03-14 11:49:36 +01007837 memcpy(peer_id, inputs->peer, inputs->peer_len);
7838 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007839
7840 return PSA_SUCCESS;
7841}
7842
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007843psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7844 const psa_crypto_driver_pake_inputs_t *inputs,
7845 psa_pake_cipher_suite_t *cipher_suite)
7846{
7847 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7848 return PSA_ERROR_BAD_STATE;
7849 }
7850
7851 *cipher_suite = inputs->cipher_suite;
7852
7853 return PSA_SUCCESS;
7854}
7855
Neil Armstronga7d08c32022-06-01 18:21:20 +02007856psa_status_t psa_pake_setup(
7857 psa_pake_operation_t *operation,
7858 const psa_pake_cipher_suite_t *cipher_suite)
7859{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007860 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007861
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007862 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007863 status = PSA_ERROR_BAD_STATE;
7864 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007865 }
7866
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007867 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007868 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007869 status = PSA_ERROR_INVALID_ARGUMENT;
7870 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007871 }
7872
Przemek Stekiel51eac532022-12-07 11:04:51 +01007873 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7874
Przemek Stekiele12ed362022-12-21 12:54:46 +01007875 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007876 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7877 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007878 operation->data.inputs.cipher_suite = *cipher_suite;
7879
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007880#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007881 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007882 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007883 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007884
David Horstmann16f01512023-06-14 17:21:07 +01007885 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007886 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007887 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007888#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007889 {
7890 status = PSA_ERROR_NOT_SUPPORTED;
7891 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007892 }
7893
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007894 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7895
Przemek Stekiel51eac532022-12-07 11:04:51 +01007896 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007897exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007898 psa_pake_abort(operation);
7899 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007900}
7901
7902psa_status_t psa_pake_set_password_key(
7903 psa_pake_operation_t *operation,
7904 mbedtls_svc_key_id_t password)
7905{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007906 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007907 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7908 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007909 psa_key_attributes_t attributes;
7910 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007911
Przemek Stekiel51eac532022-12-07 11:04:51 +01007912 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007913 status = PSA_ERROR_BAD_STATE;
7914 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007915 }
7916
Przemek Stekiel6c764412022-11-22 14:05:12 +01007917 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7918 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007919 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007920 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007921 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007922 }
7923
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007924 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007925 .core = slot->attr
7926 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007927
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007928 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007929
Przemek Stekiel51eac532022-12-07 11:04:51 +01007930 if (type != PSA_KEY_TYPE_PASSWORD &&
7931 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7932 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007933 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007934 }
7935
Przemek Stekiel51eac532022-12-07 11:04:51 +01007936 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7937 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007938 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007939 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007940 }
7941
7942 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7943 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007944 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007945exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007946 if (status != PSA_SUCCESS) {
7947 psa_pake_abort(operation);
7948 }
Ryan Everett1b70a072024-01-04 10:32:49 +00007949 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007950 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007951}
7952
7953psa_status_t psa_pake_set_user(
7954 psa_pake_operation_t *operation,
7955 const uint8_t *user_id,
7956 size_t user_id_len)
7957{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007958 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007959
7960 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007961 status = PSA_ERROR_BAD_STATE;
7962 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007963 }
7964
Przemek Stekiel51eac532022-12-07 11:04:51 +01007965 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007966 status = PSA_ERROR_INVALID_ARGUMENT;
7967 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007968 }
7969
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007970 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007971 status = PSA_ERROR_BAD_STATE;
7972 goto exit;
7973 }
7974
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007975 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7976 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007977 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7978 goto exit;
7979 }
7980
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007981 memcpy(operation->data.inputs.user, user_id, user_id_len);
7982 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007983
7984 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007985exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007986 psa_pake_abort(operation);
7987 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007988}
7989
7990psa_status_t psa_pake_set_peer(
7991 psa_pake_operation_t *operation,
7992 const uint8_t *peer_id,
7993 size_t peer_id_len)
7994{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007995 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007996
7997 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007998 status = PSA_ERROR_BAD_STATE;
7999 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008000 }
8001
Przemek Stekiel51eac532022-12-07 11:04:51 +01008002 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008003 status = PSA_ERROR_INVALID_ARGUMENT;
8004 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008005 }
8006
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008007 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008008 status = PSA_ERROR_BAD_STATE;
8009 goto exit;
8010 }
8011
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008012 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8013 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008014 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8015 goto exit;
8016 }
8017
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008018 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8019 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008020
8021 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008022exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008023 psa_pake_abort(operation);
8024 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008025}
8026
8027psa_status_t psa_pake_set_role(
8028 psa_pake_operation_t *operation,
8029 psa_pake_role_t role)
8030{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008031 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008032
Przemek Stekiel51eac532022-12-07 11:04:51 +01008033 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008034 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008035 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008036 }
8037
Przemek Stekiel09104b82023-03-06 14:11:51 +01008038 switch (operation->alg) {
8039#if defined(PSA_WANT_ALG_JPAKE)
8040 case PSA_ALG_JPAKE:
8041 if (role == PSA_PAKE_ROLE_NONE) {
8042 return PSA_SUCCESS;
8043 }
8044 status = PSA_ERROR_INVALID_ARGUMENT;
8045 break;
8046#endif
8047 default:
8048 (void) role;
8049 status = PSA_ERROR_NOT_SUPPORTED;
8050 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008051 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008052exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008053 psa_pake_abort(operation);
8054 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008055}
8056
David Horstmanne7f21e62023-05-12 18:17:21 +01008057/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008058#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008059static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008060 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008061{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008062 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008063 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008064 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008065
David Horstmann024e5c52023-06-14 15:48:21 +01008066 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008067 is_x1 = (stage->outputs < 1);
8068 } else {
8069 is_x1 = (stage->inputs < 1);
8070 }
8071
David Horstmann74a3d8c2023-06-14 18:28:19 +01008072 key_share_step = is_x1 ?
8073 PSA_JPAKE_X1_STEP_KEY_SHARE :
8074 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008075 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008076 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8077 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8078 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8079 } else {
8080 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008081 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008082 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008083}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008084#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008085
Przemek Stekiel2797d372022-12-22 11:19:22 +01008086static psa_status_t psa_pake_complete_inputs(
8087 psa_pake_operation_t *operation)
8088{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008089 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008090 /* Create copy of the inputs on stack as inputs share memory
8091 with the driver context which will be setup by the driver. */
8092 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008093
Przemek Stekielfde11282023-03-13 16:06:09 +01008094 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008095 return PSA_ERROR_BAD_STATE;
8096 }
8097
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008098 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008099 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8100 return PSA_ERROR_BAD_STATE;
8101 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008102 }
8103
Przemek Stekiel18620a32023-01-17 16:34:52 +01008104 /* Clear driver context */
8105 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8106
8107 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008108
8109 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008110 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008111
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008112 /* User and peer are translated to role. */
8113 mbedtls_free(inputs.user);
8114 mbedtls_free(inputs.peer);
8115
Przemek Stekiel2797d372022-12-22 11:19:22 +01008116 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008117#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008118 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008119 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008120 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008121#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008122 {
8123 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008124 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008125 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008126 return status;
8127}
8128
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008129#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008130static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008131 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008132 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008133 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008134{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008135 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8136 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8137 step != PSA_PAKE_STEP_ZK_PROOF) {
8138 return PSA_ERROR_INVALID_ARGUMENT;
8139 }
8140
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008141 psa_jpake_computation_stage_t *computation_stage =
8142 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008143
David Horstmann5da95602023-06-08 15:37:12 +01008144 if (computation_stage->round != PSA_JPAKE_FIRST &&
8145 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008146 return PSA_ERROR_BAD_STATE;
8147 }
8148
David Horstmanne7f21e62023-05-12 18:17:21 +01008149 /* Check that the step we are given is the one we were expecting */
8150 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008151 return PSA_ERROR_BAD_STATE;
8152 }
8153
David Horstmanne7f21e62023-05-12 18:17:21 +01008154 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8155 computation_stage->inputs == 0 &&
8156 computation_stage->outputs == 0) {
8157 /* Start of the round, so function decides whether we are inputting
8158 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008159 computation_stage->io_mode = io_mode;
8160 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008161 /* Middle of the round so the mode we are in must match the function
8162 * called by the user */
8163 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008164 }
8165
8166 return PSA_SUCCESS;
8167}
8168
David Horstmanne7f21e62023-05-12 18:17:21 +01008169static psa_status_t psa_jpake_epilogue(
8170 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008171 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008172{
David Horstmanne7f21e62023-05-12 18:17:21 +01008173 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008174 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008175
David Horstmanne7f21e62023-05-12 18:17:21 +01008176 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8177 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008178 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008179 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008180 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008181 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008182 }
8183 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008184 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008185 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008186 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008187 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008188 }
8189 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008190 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8191 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008192 /* End of a round, move to the next round */
8193 stage->inputs = 0;
8194 stage->outputs = 0;
8195 stage->round++;
8196 }
8197 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008198 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008199 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008200 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008201 return PSA_SUCCESS;
8202}
David Horstmanne7f21e62023-05-12 18:17:21 +01008203
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008204#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008205
Neil Armstronga7d08c32022-06-01 18:21:20 +02008206psa_status_t psa_pake_output(
8207 psa_pake_operation_t *operation,
8208 psa_pake_step_t step,
8209 uint8_t *output,
8210 size_t output_size,
8211 size_t *output_length)
8212{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008213 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008214 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008215 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008216
8217 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008218 status = psa_pake_complete_inputs(operation);
8219 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008220 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008221 }
8222 }
8223
8224 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008225 status = PSA_ERROR_BAD_STATE;
8226 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008227 }
8228
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008229 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008230 status = PSA_ERROR_INVALID_ARGUMENT;
8231 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008232 }
8233
Przemek Stekiele12ed362022-12-21 12:54:46 +01008234 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008235#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008236 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008237 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008238 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008239 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008240 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008241 driver_step = convert_jpake_computation_stage_to_driver_step(
8242 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008243 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008244#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008245 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008246 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008247 status = PSA_ERROR_NOT_SUPPORTED;
8248 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008249 }
8250
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008251 status = psa_driver_wrapper_pake_output(operation, driver_step,
8252 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008253
8254 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008255 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008256 }
8257
8258 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008259#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008260 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008261 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008262 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008263 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008264 }
8265 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008266#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008267 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008268 status = PSA_ERROR_NOT_SUPPORTED;
8269 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008270 }
8271
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008272 return PSA_SUCCESS;
8273exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008274 psa_pake_abort(operation);
8275 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008276}
8277
8278psa_status_t psa_pake_input(
8279 psa_pake_operation_t *operation,
8280 psa_pake_step_t step,
8281 const uint8_t *input,
8282 size_t input_length)
8283{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008284 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008285 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008286 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8287 operation->primitive,
8288 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008289
8290 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008291 status = psa_pake_complete_inputs(operation);
8292 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008293 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008294 }
8295 }
8296
8297 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008298 status = PSA_ERROR_BAD_STATE;
8299 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008300 }
8301
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008302 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008303 status = PSA_ERROR_INVALID_ARGUMENT;
8304 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008305 }
8306
Przemek Stekiele12ed362022-12-21 12:54:46 +01008307 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008308#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008309 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008310 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008311 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008312 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008313 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008314 driver_step = convert_jpake_computation_stage_to_driver_step(
8315 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008316 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008317#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008318 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008319 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008320 status = PSA_ERROR_NOT_SUPPORTED;
8321 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008322 }
8323
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008324 status = psa_driver_wrapper_pake_input(operation, driver_step,
8325 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008326
8327 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008328 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008329 }
8330
8331 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008332#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008333 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008334 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008335 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008336 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008337 }
8338 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008339#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008340 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008341 status = PSA_ERROR_NOT_SUPPORTED;
8342 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008343 }
8344
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008345 return PSA_SUCCESS;
8346exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008347 psa_pake_abort(operation);
8348 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008349}
8350
8351psa_status_t psa_pake_get_implicit_key(
8352 psa_pake_operation_t *operation,
8353 psa_key_derivation_operation_t *output)
8354{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008355 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008356 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008357 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008358 size_t shared_key_len = 0;
8359
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008360 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008361 status = PSA_ERROR_BAD_STATE;
8362 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008363 }
8364
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008365#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008366 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008367 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008368 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008369 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008370 status = PSA_ERROR_BAD_STATE;
8371 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008372 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008373 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008374#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008375 {
8376 status = PSA_ERROR_NOT_SUPPORTED;
8377 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008378 }
8379
Przemek Stekiel0c781802022-11-29 14:53:13 +01008380 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8381 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008382 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008383 &shared_key_len);
8384
8385 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008386 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008387 }
8388
8389 status = psa_key_derivation_input_bytes(output,
8390 PSA_KEY_DERIVATION_INPUT_SECRET,
8391 shared_key,
8392 shared_key_len);
8393
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008394 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008395exit:
8396 abort_status = psa_pake_abort(operation);
8397 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008398}
8399
8400psa_status_t psa_pake_abort(
8401 psa_pake_operation_t *operation)
8402{
Przemek Stekield69dca92023-01-31 19:59:20 +01008403 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008404
Przemek Stekield69dca92023-01-31 19:59:20 +01008405 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008406 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008407 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008408
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008409 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8410 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008411 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008412 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008413 }
8414 if (operation->data.inputs.user != NULL) {
8415 mbedtls_free(operation->data.inputs.user);
8416 }
8417 if (operation->data.inputs.peer != NULL) {
8418 mbedtls_free(operation->data.inputs.peer);
8419 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008420 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008421 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008422
Przemek Stekield69dca92023-01-31 19:59:20 +01008423 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008424}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008425#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008426
David Horstmann00d7a042023-12-07 18:39:17 +00008427/* Memory copying test hooks. These are called before input copy, after input
8428 * copy, before output copy and after output copy, respectively.
8429 * They are used by memory-poisoning tests to temporarily unpoison buffers
8430 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008431#if defined(MBEDTLS_TEST_HOOKS)
8432void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8433void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8434void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8435void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8436#endif
David Horstmannfde97392023-10-30 20:29:43 +00008437
David Horstmann1b7279a2023-11-15 15:18:30 +00008438/** Copy from an input buffer to a local copy.
8439 *
8440 * \param[in] input Pointer to input buffer.
8441 * \param[in] input_len Length of the input buffer.
8442 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8443 * \param[out] input_copy_len Length of the local copy buffer.
8444 * \return #PSA_SUCCESS, if the buffer was successfully
8445 * copied.
8446 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8447 * copy is too small to hold contents of the
8448 * input buffer.
8449 */
8450MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008451psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8452 uint8_t *input_copy, size_t input_copy_len)
8453{
8454 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008455 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008456 }
8457
David Horstmann372b8bb2023-11-24 16:21:04 +00008458#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008459 if (psa_input_pre_copy_hook != NULL) {
8460 psa_input_pre_copy_hook(input, input_len);
8461 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008462#endif
8463
David Horstmann777e7412023-11-15 17:33:47 +00008464 if (input_len > 0) {
8465 memcpy(input_copy, input, input_len);
8466 }
David Horstmannfde97392023-10-30 20:29:43 +00008467
David Horstmann372b8bb2023-11-24 16:21:04 +00008468#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008469 if (psa_input_post_copy_hook != NULL) {
8470 psa_input_post_copy_hook(input, input_len);
8471 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008472#endif
8473
David Horstmannfde97392023-10-30 20:29:43 +00008474 return PSA_SUCCESS;
8475}
8476
David Horstmann1b7279a2023-11-15 15:18:30 +00008477/** Copy from a local output buffer into a user-supplied one.
8478 *
8479 * \param[in] output_copy Pointer to a local buffer containing the output.
8480 * \param[in] output_copy_len Length of the local buffer.
8481 * \param[out] output Pointer to user-supplied output buffer.
8482 * \param[out] output_len Length of the user-supplied output buffer.
8483 * \return #PSA_SUCCESS, if the buffer was successfully
8484 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008485 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008486 * user-supplied output buffer is too small to
8487 * hold the contents of the local buffer.
8488 */
8489MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008490psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8491 uint8_t *output, size_t output_len)
8492{
8493 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008494 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008495 }
David Horstmann777e7412023-11-15 17:33:47 +00008496
David Horstmann372b8bb2023-11-24 16:21:04 +00008497#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008498 if (psa_output_pre_copy_hook != NULL) {
8499 psa_output_pre_copy_hook(output, output_len);
8500 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008501#endif
8502
David Horstmann777e7412023-11-15 17:33:47 +00008503 if (output_copy_len > 0) {
8504 memcpy(output, output_copy, output_copy_len);
8505 }
8506
David Horstmann372b8bb2023-11-24 16:21:04 +00008507#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008508 if (psa_output_post_copy_hook != NULL) {
8509 psa_output_post_copy_hook(output, output_len);
8510 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008511#endif
8512
David Horstmann8978f5c2023-10-30 20:37:12 +00008513 return PSA_SUCCESS;
8514}
8515
David Horstmannf1734052023-11-20 17:15:32 +00008516psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8517 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008518{
8519 psa_status_t status;
8520
David Horstmann9db14482023-11-23 15:50:37 +00008521 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008522
David Horstmannc5cc1c32023-11-15 18:11:26 +00008523 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008524 return PSA_SUCCESS;
8525 }
8526
David Horstmannf1734052023-11-20 17:15:32 +00008527 local_input->buffer = mbedtls_calloc(input_len, 1);
8528 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008529 /* Since we dealt with the zero-length case above, we know that
8530 * a NULL return value means a failure of allocation. */
8531 return PSA_ERROR_INSUFFICIENT_MEMORY;
8532 }
David Horstmannf1734052023-11-20 17:15:32 +00008533 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008534
David Horstmannf1734052023-11-20 17:15:32 +00008535 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008536
8537 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008538 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008539 if (status != PSA_SUCCESS) {
8540 goto error;
8541 }
8542
8543 return PSA_SUCCESS;
8544
8545error:
David Horstmannf1734052023-11-20 17:15:32 +00008546 mbedtls_free(local_input->buffer);
8547 local_input->buffer = NULL;
8548 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008549 return status;
8550}
8551
David Horstmannf1734052023-11-20 17:15:32 +00008552void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008553{
David Horstmannf1734052023-11-20 17:15:32 +00008554 mbedtls_free(local_input->buffer);
8555 local_input->buffer = NULL;
8556 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008557}
8558
David Horstmann89875a42023-11-20 12:54:09 +00008559psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8560 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008561{
David Horstmann9db14482023-11-23 15:50:37 +00008562 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008563
David Horstmannc5cc1c32023-11-15 18:11:26 +00008564 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008565 return PSA_SUCCESS;
8566 }
David Horstmann89875a42023-11-20 12:54:09 +00008567 local_output->buffer = mbedtls_calloc(output_len, 1);
8568 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008569 /* Since we dealt with the zero-length case above, we know that
8570 * a NULL return value means a failure of allocation. */
8571 return PSA_ERROR_INSUFFICIENT_MEMORY;
8572 }
David Horstmann89875a42023-11-20 12:54:09 +00008573 local_output->length = output_len;
8574 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008575
8576 return PSA_SUCCESS;
8577}
8578
David Horstmann89875a42023-11-20 12:54:09 +00008579psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008580{
David Horstmannc335a4e2023-11-15 15:57:32 +00008581 psa_status_t status;
8582
David Horstmann89875a42023-11-20 12:54:09 +00008583 if (local_output->buffer == NULL) {
8584 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008585 return PSA_SUCCESS;
8586 }
David Horstmann89875a42023-11-20 12:54:09 +00008587 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008588 /* We have an internal copy but nothing to copy back to. */
8589 return PSA_ERROR_CORRUPTION_DETECTED;
8590 }
8591
David Horstmann89875a42023-11-20 12:54:09 +00008592 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8593 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008594 if (status != PSA_SUCCESS) {
8595 return status;
8596 }
David Horstmann9467ea32023-11-08 17:44:18 +00008597
David Horstmann89875a42023-11-20 12:54:09 +00008598 mbedtls_free(local_output->buffer);
8599 local_output->buffer = NULL;
8600 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008601
8602 return PSA_SUCCESS;
8603}
8604
Gilles Peskinee59236f2018-01-27 23:32:46 +01008605#endif /* MBEDTLS_PSA_CRYPTO_C */