blob: bcda6d689dc6232b9fb5e5066baefcf75ce8815d [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"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020073#include "md_psa.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
115/* Declare a local copy of an input buffer.
116 *
117 * Note: This macro must be called before any operations which may jump to
118 * the exit label, so that the local input copy object is safe to be freed.
119 *
120 * Assumptions:
121 * - input is the name of a pointer to the buffer to be copied
122 * - The name LOCAL_INPUT_COPY_OF_input is unused in the current scope
123 */
124#define LOCAL_INPUT_DECLARE(input) \
125 psa_crypto_local_input_t LOCAL_INPUT_COPY_OF_##input = PSA_CRYPTO_LOCAL_INPUT_INIT;
126
127/* Allocate a copy of the buffer input and create a pointer with the name
128 * input_copy_name that points to the start of the copy.
129 *
David Horstmanne9a88ab2023-11-29 17:07:13 +0000130 * Assumptions:
131 * - psa_status_t status exists
132 * - An exit label is declared
David Horstmann36df4b22023-12-13 15:55:25 +0000133 * - input is the name of a pointer to the buffer to be copied
134 * - LOCAL_INPUT_DECLARE(input) has previously been called
135 * - input_copy_name is a name that is not used in the current scope
David Horstmanne9a88ab2023-11-29 17:07:13 +0000136 */
David Horstmann36df4b22023-12-13 15:55:25 +0000137#define LOCAL_INPUT_ALLOC(input, length, input_copy_name) \
138 status = psa_crypto_local_input_alloc(input, length, \
139 &LOCAL_INPUT_COPY_OF_##input); \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000140 if (status != PSA_SUCCESS) { \
141 goto exit; \
142 } \
David Horstmann36df4b22023-12-13 15:55:25 +0000143 const uint8_t *input_copy_name = LOCAL_INPUT_COPY_OF_##input.buffer;
David Horstmanne9a88ab2023-11-29 17:07:13 +0000144
David Horstmann36df4b22023-12-13 15:55:25 +0000145/* Free the local input copy allocated previously by LOCAL_INPUT_ALLOC()
146 *
David Horstmann3e72db42023-12-08 14:08:18 +0000147 * Assumptions:
David Horstmann36df4b22023-12-13 15:55:25 +0000148 * - input_copy_name is the name of the input copy created by LOCAL_INPUT_ALLOC()
149 * - input is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000150 */
David Horstmann36df4b22023-12-13 15:55:25 +0000151#define LOCAL_INPUT_FREE(input_copy_name, input) \
152 input_copy_name = NULL; \
153 psa_crypto_local_input_free(&LOCAL_INPUT_COPY_OF_##input);
David Horstmanne9a88ab2023-11-29 17:07:13 +0000154
David Horstmann36df4b22023-12-13 15:55:25 +0000155/* Declare a local copy of an output buffer.
156 *
157 * Note: This macro must be called before any operations which may jump to
158 * the exit label, so that the local output copy object is safe to be freed.
159 *
160 * Assumptions:
161 * - output is the name of a pointer to the buffer to be copied
162 * - The name LOCAL_OUTPUT_COPY_OF_output is unused in the current scope
163 */
164#define LOCAL_OUTPUT_DECLARE(output) \
165 psa_crypto_local_output_t LOCAL_OUTPUT_COPY_OF_##output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
166
167/* Allocate a copy of the buffer output and create a pointer with the name
168 * output_copy_name that points to the start of the copy.
169 *
David Horstmanne9a88ab2023-11-29 17:07:13 +0000170 * Assumptions:
171 * - psa_status_t status exists
172 * - An exit label is declared
David Horstmann36df4b22023-12-13 15:55:25 +0000173 * - output is the name of a pointer to the buffer to be copied
174 * - LOCAL_OUTPUT_DECLARE(output) has previously been called
175 * - output_copy_name is a name that is not used in the current scope
David Horstmanne9a88ab2023-11-29 17:07:13 +0000176 */
David Horstmann36df4b22023-12-13 15:55:25 +0000177#define LOCAL_OUTPUT_ALLOC(output, length, output_copy_name) \
178 status = psa_crypto_local_output_alloc(output, length, \
179 &LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000180 if (status != PSA_SUCCESS) { \
181 goto exit; \
182 } \
David Horstmann36df4b22023-12-13 15:55:25 +0000183 uint8_t *output_copy_name = LOCAL_OUTPUT_COPY_OF_##output.buffer;
David Horstmanne9a88ab2023-11-29 17:07:13 +0000184
David Horstmann36df4b22023-12-13 15:55:25 +0000185/* Free the local input copy allocated previously by LOCAL_INPUT_ALLOC()
David Horstmann3e72db42023-12-08 14:08:18 +0000186 * after first copying back its contents to the original buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000187 *
David Horstmann3e72db42023-12-08 14:08:18 +0000188 * Assumptions:
David Horstmann3e72db42023-12-08 14:08:18 +0000189 * - psa_status_t status exists
David Horstmann36df4b22023-12-13 15:55:25 +0000190 * - input_copy_name is the name of the input copy created by LOCAL_INPUT_ALLOC()
191 * - input is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000192 */
David Horstmann36df4b22023-12-13 15:55:25 +0000193#define LOCAL_OUTPUT_FREE(output_copy_name, output) \
194 output_copy_name = NULL; \
David Horstmann5a945f52023-12-13 14:09:08 +0000195 do { \
196 psa_status_t local_output_status; \
David Horstmann36df4b22023-12-13 15:55:25 +0000197 local_output_status = psa_crypto_local_output_free(&LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmann5a945f52023-12-13 14:09:08 +0000198 if (local_output_status != PSA_SUCCESS) { \
199 /* Since this error case is an internal error, it's more serious than \
200 * any existing error code and so it's fine to overwrite the existing \
201 * status. */ \
202 status = local_output_status; \
203 } \
204 } while (0)
David Horstmann513101b2023-11-29 17:24:08 +0000205#else /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmann36df4b22023-12-13 15:55:25 +0000206#define LOCAL_INPUT_DECLARE(input)
207#define LOCAL_INPUT_ALLOC(input, length, input_copy_name) \
208 const uint8_t *input_copy_name = input;
209#define LOCAL_INPUT_FREE(input_copy_name, input) \
210 input_copy_name = NULL;
211#define LOCAL_OUTPUT_DECLARE(output)
212#define LOCAL_OUTPUT_ALLOC(output, length, output_copy_name) \
213 uint8_t *output_copy_name = output;
214#define LOCAL_OUTPUT_FREE(output_copy_name, output) \
215 output_copy_name = NULL;
216
David Horstmann513101b2023-11-29 17:24:08 +0000217#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000218
219
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100220int psa_can_do_hash(psa_algorithm_t hash_alg)
221{
222 (void) hash_alg;
223 return global_data.drivers_initialized;
224}
Valerio Settia55f0422023-07-10 15:34:41 +0200225#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200226 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200227 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200228static int psa_is_dh_key_size_valid(size_t bits)
229{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200230 if (bits != 2048 && bits != 3072 && bits != 4096 &&
231 bits != 6144 && bits != 8192) {
232 return 0;
233 }
234
235 return 1;
236}
Valerio Settia55f0422023-07-10 15:34:41 +0200237#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200238 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200239 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100240
Gilles Peskine449bd832023-01-11 14:50:10 +0100241psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100242{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100243 /* Mbed TLS error codes can combine a high-level error code and a
244 * low-level error code. The low-level error usually reflects the
245 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 int low_level_ret = -(-ret & 0x007f);
247 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100248 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100250
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100251#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100252 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
253 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100255 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
256 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100257#endif
258
259#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200260 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
261 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
262 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
263 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
264 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200266 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200268 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100270#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200271
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100272#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000273 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100274 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100276#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100277
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100278#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100279 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100280 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100281 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100282 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100283#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100284
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100285#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200286 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100288#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200289
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100290#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200291 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100292 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200293 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100295#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200296
Dave Rodgman509b5672023-08-16 19:26:23 +0100297#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100298 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100300 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100302 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100304 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100306 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100308 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100309 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100310 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100312#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100313
Gilles Peskine449bd832023-01-11 14:50:10 +0100314#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
315 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100316 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
317 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100318 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100320 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
321 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100323 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100325#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100326
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100327#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100328 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100329 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100330#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100331
Gilles Peskinee59236f2018-01-27 23:32:46 +0100332 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
333 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
334 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100336
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100337#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100338 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200340 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100342 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100344#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100345
Gilles Peskine82e57d12020-11-13 21:31:17 +0100346#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100348 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
349 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100350 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100352 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
353 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100355 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100357#endif
358
Dave Rodgmandea266f2023-08-31 11:52:43 +0100359#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100360 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100362 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100364 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100366#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100367 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100369#endif
370#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100371
Dave Rodgman509b5672023-08-16 19:26:23 +0100372#if defined(MBEDTLS_BIGNUM_C)
373#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100374 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100375 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100376#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100377 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100379 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100380 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100381 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100383 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100385 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100386 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100387 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100388 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100389 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100390 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100391#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100392
Dave Rodgman509b5672023-08-16 19:26:23 +0100393#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100394 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100396 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
397 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100399#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
400 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100401 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100403#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100404 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
405 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100407 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100408 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100409 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
410 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100412 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100414 case MBEDTLS_ERR_PK_INVALID_ALG:
415 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
416 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100418 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200420 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100422#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100423
Gilles Peskineff2d2002019-05-06 15:26:23 +0200424 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100425 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200426 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200428
Dave Rodgman509b5672023-08-16 19:26:23 +0100429#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100430 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100432 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100434 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100436 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100438 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
439 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100440 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100441 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100443 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100444 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100445 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100447#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200448
Dave Rodgman1dab4452023-09-01 09:59:51 +0100449#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300450 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300451 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300453 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100454 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300455 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300457 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
458 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100459 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300460 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100461 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100462 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100463 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100464
Dave Rodgman509b5672023-08-16 19:26:23 +0100465#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000466 case MBEDTLS_ERR_ECP_IN_PROGRESS:
467 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100468#endif
469#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000470
Janos Follatha13b9052019-11-22 12:48:59 +0000471 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300473
Gilles Peskinee59236f2018-01-27 23:32:46 +0100474 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100476 }
477}
478
Paul Elliottdc42ca82023-02-24 18:11:59 +0000479/**
480 * \brief For output buffers which contain "tags"
481 * (outputs that may be checked for validity like
482 * hashes, MACs and signatures), fill the unused
483 * part of the output buffer (the whole buffer on
484 * error, the trailing part on success) with
485 * something that isn't a valid tag (barring an
486 * attack on the tag and deliberately-crafted
487 * input), in case the caller doesn't check the
488 * return status properly.
489 *
490 * \param output_buffer Pointer to buffer to wipe. May not be NULL
491 * unless \p output_buffer_size is zero.
492 * \param status Status of function called to generate
493 * output_buffer originally
494 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
495 * could be NULL.
496 * \param output_buffer_length Length of data written to output_buffer, must be
497 * less than \p output_buffer_size
498 */
499static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000500 size_t output_buffer_size, size_t output_buffer_length)
501{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000502 size_t offset = 0;
503
504 if (output_buffer_size == 0) {
505 /* If output_buffer_size is 0 then we have nothing to do. We must not
506 call memset because output_buffer may be NULL in this case */
507 return;
508 }
509
510 if (status == PSA_SUCCESS) {
511 offset = output_buffer_length;
512 }
513
514 memset(output_buffer + offset, '!', output_buffer_size - offset);
515}
516
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200517
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200518
519
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100520/****************************************************************/
521/* Key management */
522/****************************************************************/
523
Valerio Settia9aab1a2023-06-19 13:39:54 +0200524#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200525psa_ecc_family_t mbedtls_ecc_group_to_psa(mbedtls_ecp_group_id grpid,
526 size_t *bits)
527{
528 switch (grpid) {
Valerio Settic437fae2023-09-08 14:58:03 +0200529#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200530 case MBEDTLS_ECP_DP_SECP192R1:
531 *bits = 192;
532 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100533#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200534#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200535 case MBEDTLS_ECP_DP_SECP224R1:
536 *bits = 224;
537 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100538#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200539#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200540 case MBEDTLS_ECP_DP_SECP256R1:
541 *bits = 256;
542 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100543#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200544#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200545 case MBEDTLS_ECP_DP_SECP384R1:
546 *bits = 384;
547 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100548#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200549#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200550 case MBEDTLS_ECP_DP_SECP521R1:
551 *bits = 521;
552 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100553#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200554#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200555 case MBEDTLS_ECP_DP_BP256R1:
556 *bits = 256;
557 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100558#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200559#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200560 case MBEDTLS_ECP_DP_BP384R1:
561 *bits = 384;
562 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100563#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200564#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200565 case MBEDTLS_ECP_DP_BP512R1:
566 *bits = 512;
567 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100568#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200569#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200570 case MBEDTLS_ECP_DP_CURVE25519:
571 *bits = 255;
572 return PSA_ECC_FAMILY_MONTGOMERY;
Dave Rodgman6f682032023-08-16 18:44:32 +0100573#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200574#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200575 case MBEDTLS_ECP_DP_SECP192K1:
576 *bits = 192;
577 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100578#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200579#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200580 case MBEDTLS_ECP_DP_SECP224K1:
581 *bits = 224;
582 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100583#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200584#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200585 case MBEDTLS_ECP_DP_SECP256K1:
586 *bits = 256;
587 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100588#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200589#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200590 case MBEDTLS_ECP_DP_CURVE448:
591 *bits = 448;
592 return PSA_ECC_FAMILY_MONTGOMERY;
Dave Rodgman6f682032023-08-16 18:44:32 +0100593#endif
Valerio Settibc2b1d32023-06-19 12:15:13 +0200594 default:
595 *bits = 0;
596 return 0;
597 }
598}
599
Gilles Peskine449bd832023-01-11 14:50:10 +0100600mbedtls_ecp_group_id mbedtls_ecc_group_of_psa(psa_ecc_family_t curve,
601 size_t bits,
602 int bits_is_sloppy)
Gilles Peskine12313cd2018-06-20 00:20:32 +0200603{
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 switch (curve) {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100605 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100607#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100608 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return MBEDTLS_ECP_DP_SECP192R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100610#endif
611#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100612 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100613 return MBEDTLS_ECP_DP_SECP224R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100614#endif
615#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100616 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 return MBEDTLS_ECP_DP_SECP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100618#endif
619#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100620 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 return MBEDTLS_ECP_DP_SECP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100622#endif
623#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100624 case 521:
Gilles Peskine449bd832023-01-11 14:50:10 +0100625 return MBEDTLS_ECP_DP_SECP521R1;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100626 case 528:
Gilles Peskine449bd832023-01-11 14:50:10 +0100627 if (bits_is_sloppy) {
628 return MBEDTLS_ECP_DP_SECP521R1;
629 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100630 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100631#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100632 }
633 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100634
Paul Elliott8ff510a2020-06-02 17:19:28 +0100635 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100636 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100637#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100638 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100639 return MBEDTLS_ECP_DP_BP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100640#endif
641#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100642 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100643 return MBEDTLS_ECP_DP_BP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100644#endif
645#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100646 case 512:
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 return MBEDTLS_ECP_DP_BP512R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100648#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100649 }
650 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100651
Paul Elliott8ff510a2020-06-02 17:19:28 +0100652 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100653 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100654#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100655 case 255:
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 return MBEDTLS_ECP_DP_CURVE25519;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100657 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100658 if (bits_is_sloppy) {
659 return MBEDTLS_ECP_DP_CURVE25519;
660 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100661 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100662#endif
663#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100664 case 448:
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 return MBEDTLS_ECP_DP_CURVE448;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100666#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100667 }
668 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100669
Paul Elliott8ff510a2020-06-02 17:19:28 +0100670 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100672#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100673 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 return MBEDTLS_ECP_DP_SECP192K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100675#endif
676#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100677 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return MBEDTLS_ECP_DP_SECP224K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100679#endif
680#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100681 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return MBEDTLS_ECP_DP_SECP256K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100683#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100684 }
685 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200686 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100687
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100688 (void) bits_is_sloppy;
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return MBEDTLS_ECP_DP_NONE;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200690}
Valerio Settia9aab1a2023-06-19 13:39:54 +0200691#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200692
Gilles Peskine449bd832023-01-11 14:50:10 +0100693psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
694 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200695{
696 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200698 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200699 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200700 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200701 case PSA_KEY_TYPE_PASSWORD:
702 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200703 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100704#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200705 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100706 if (bits != 128 && bits != 192 && bits != 256) {
707 return PSA_ERROR_INVALID_ARGUMENT;
708 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200709 break;
710#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200711#if defined(PSA_WANT_KEY_TYPE_ARIA)
712 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 if (bits != 128 && bits != 192 && bits != 256) {
714 return PSA_ERROR_INVALID_ARGUMENT;
715 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200716 break;
717#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100718#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200719 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 if (bits != 128 && bits != 192 && bits != 256) {
721 return PSA_ERROR_INVALID_ARGUMENT;
722 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200723 break;
724#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100725#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200726 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100727 if (bits != 64 && bits != 128 && bits != 192) {
728 return PSA_ERROR_INVALID_ARGUMENT;
729 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200730 break;
731#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100732#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200733 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100734 if (bits != 256) {
735 return PSA_ERROR_INVALID_ARGUMENT;
736 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200737 break;
738#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200739 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100740 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200741 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 if (bits % 8 != 0) {
743 return PSA_ERROR_INVALID_ARGUMENT;
744 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200745
Gilles Peskine449bd832023-01-11 14:50:10 +0100746 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200747}
748
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100749/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100750 *
Steven Cooremancd640932021-03-08 12:00:27 +0100751 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
752 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100753 *
754 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100755 * \param[in] key_type The key type of the key to be used with the
756 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100757 *
758 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100759 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100760 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100761 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100762 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100763MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100764 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100766{
Gilles Peskine449bd832023-01-11 14:50:10 +0100767 if (PSA_ALG_IS_HMAC(algorithm)) {
768 if (key_type == PSA_KEY_TYPE_HMAC) {
769 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100770 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100771 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100772
Gilles Peskine449bd832023-01-11 14:50:10 +0100773 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
774 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
775 * key. */
776 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
777 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
778 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
779 * the block length (larger than 1) for block ciphers. */
780 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
781 return PSA_SUCCESS;
782 }
783 }
784 }
785
786 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100787}
788
Gilles Peskine449bd832023-01-11 14:50:10 +0100789psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
790 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200791{
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (slot->key.data != NULL) {
793 return PSA_ERROR_ALREADY_EXISTS;
794 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200795
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 slot->key.data = mbedtls_calloc(1, buffer_length);
797 if (slot->key.data == NULL) {
798 return PSA_ERROR_INSUFFICIENT_MEMORY;
799 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200800
Ronald Cronea0f8a62020-11-25 17:52:23 +0100801 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200803}
804
Gilles Peskine449bd832023-01-11 14:50:10 +0100805psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
806 const uint8_t *data,
807 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200808{
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 psa_status_t status = psa_allocate_buffer_to_slot(slot,
810 data_length);
811 if (status != PSA_SUCCESS) {
812 return status;
813 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200814
Gilles Peskine449bd832023-01-11 14:50:10 +0100815 memcpy(slot->key.data, data, data_length);
816 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200817}
818
Ronald Crona0fe59f2020-11-29 11:14:53 +0100819psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100820 const psa_key_attributes_t *attributes,
821 const uint8_t *data, size_t data_length,
822 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100823 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100824{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100825 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
826 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100827
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200828 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100829 if (data_length == 0) {
830 return PSA_ERROR_NOT_SUPPORTED;
831 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200832
Gilles Peskine449bd832023-01-11 14:50:10 +0100833 if (key_type_is_raw_bytes(type)) {
834 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200835
Gilles Peskine449bd832023-01-11 14:50:10 +0100836 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
837 *bits);
838 if (status != PSA_SUCCESS) {
839 return status;
840 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200841
Ronald Crondd04d422020-11-28 15:14:42 +0100842 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100843 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100844 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200846
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 return PSA_SUCCESS;
848 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200849#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200850 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100851 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200852 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100853 return PSA_ERROR_INVALID_ARGUMENT;
854 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200855 return mbedtls_psa_ffdh_import_key(attributes,
856 data, data_length,
857 key_buffer, key_buffer_size,
858 key_buffer_length,
859 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100860 }
Valerio Settia55f0422023-07-10 15:34:41 +0200861#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200862 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200863#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100864 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
865 if (PSA_KEY_TYPE_IS_ECC(type)) {
866 return mbedtls_psa_ecp_import_key(attributes,
867 data, data_length,
868 key_buffer, key_buffer_size,
869 key_buffer_length,
870 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100871 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200872#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800873 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200874#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
875 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100876 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
877 if (PSA_KEY_TYPE_IS_RSA(type)) {
878 return mbedtls_psa_rsa_import_key(attributes,
879 data, data_length,
880 key_buffer, key_buffer_size,
881 key_buffer_length,
882 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200883 }
Valerio Settife478902023-07-25 12:27:19 +0200884#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
885 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800886 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100887 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100888
Gilles Peskine449bd832023-01-11 14:50:10 +0100889 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100890}
891
Gilles Peskinef603c712019-01-19 13:40:11 +0100892/** Calculate the intersection of two algorithm usage policies.
893 *
894 * Return 0 (which allows no operation) on incompatibility.
895 */
896static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100897 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100898 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100899 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100900{
Gilles Peskine549ea862019-05-22 11:45:59 +0200901 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100902 if (alg1 == alg2) {
903 return alg1;
904 }
Steven Cooreman03488022021-02-18 12:07:20 +0100905 /* If the policies are from the same hash-and-sign family, check
906 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100907 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
908 PSA_ALG_IS_SIGN_HASH(alg2) &&
909 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
910 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
911 return alg2;
912 }
913 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
914 return alg1;
915 }
Steven Cooreman03488022021-02-18 12:07:20 +0100916 }
917 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100918 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100919 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100920 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
921 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
922 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
923 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
924 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100925 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100926
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100927 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100928 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
929 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
930 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
931 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100932 }
933 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100934 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
935 (alg1_len <= alg2_len)) {
936 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100937 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
939 (alg2_len <= alg1_len)) {
940 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100941 }
942 }
943 /* If the policies are from the same MAC family, check whether one
944 * of them is a minimum-MAC-length policy. Calculate the most
945 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
947 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
948 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100949 /* Validate the combination of key type and algorithm. Since the base
950 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100951 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
952 return 0;
953 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100954
Steven Cooreman31a876d2021-03-03 20:47:40 +0100955 /* Get the (exact or at-least) output lengths for both sides of the
956 * requested intersection. None of the currently supported algorithms
957 * have an output length dependent on the actual key size, so setting it
958 * to a bogus value of 0 is currently OK.
959 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100960 * Note that for at-least-this-length wildcard algorithms, the output
961 * length is set to the shortest allowed length, which allows us to
962 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
964 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100965 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100966
Steven Cooremana1d83222021-02-25 10:20:29 +0100967 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
969 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
970 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100971 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100972
973 /* If only one is an at-least-this-length policy, the intersection would
974 * be the other (fixed-length) policy as long as said fixed length is
975 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
977 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100978 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
980 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100981 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100982
Steven Cooremancd640932021-03-08 12:00:27 +0100983 /* If none of them are wildcards, check whether they define the same tag
984 * length. This is still possible here when one is default-length and
985 * the other specific-length. Ensure to always return the
986 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 if (alg1_len == alg2_len) {
988 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
989 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100990 }
991 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100993}
994
Gilles Peskine449bd832023-01-11 14:50:10 +0100995static int psa_key_algorithm_permits(psa_key_type_t key_type,
996 psa_algorithm_t policy_alg,
997 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200998{
Gilles Peskine549ea862019-05-22 11:45:59 +0200999 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 if (requested_alg == policy_alg) {
1001 return 1;
1002 }
Steven Cooreman03488022021-02-18 12:07:20 +01001003 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
1004 * and requested_alg is the same hash-and-sign family with any hash,
1005 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
1007 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
1008 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
1009 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +01001010 }
1011 /* If policy_alg is a wildcard AEAD algorithm of the same base as
1012 * the requested algorithm, check the requested tag length to be
1013 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 if (PSA_ALG_IS_AEAD(policy_alg) &&
1015 PSA_ALG_IS_AEAD(requested_alg) &&
1016 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
1017 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
1018 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
1019 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
1020 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +01001021 }
Steven Cooremancd640932021-03-08 12:00:27 +01001022 /* If policy_alg is a MAC algorithm of the same base as the requested
1023 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 if (PSA_ALG_IS_MAC(policy_alg) &&
1025 PSA_ALG_IS_MAC(requested_alg) &&
1026 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
1027 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001028 /* Validate the combination of key type and algorithm. Since the policy
1029 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
1031 return 0;
1032 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001033
Steven Cooreman31a876d2021-03-03 20:47:40 +01001034 /* Get both the requested output length for the algorithm which is to be
1035 * verified, and the default output length for the base algorithm.
1036 * Note that none of the currently supported algorithms have an output
1037 * length dependent on actual key size, so setting it to a bogus value
1038 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001039 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001041 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +01001042 key_type, 0,
1043 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001044
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001045 /* If the policy is default-length, only allow an algorithm with
1046 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
1048 return requested_output_length == default_output_length;
1049 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001050
1051 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +01001052 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
1054 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
1055 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001056 }
1057
Steven Cooremancd640932021-03-08 12:00:27 +01001058 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
1059 * check for the requested MAC length to be equal to or longer than the
1060 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
1062 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
1063 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001064 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001065 }
Steven Cooremance48e852020-10-05 16:02:45 +02001066 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001067 * a key derivation with that key agreement should also be allowed. This
1068 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
1070 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
1071 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
1072 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +02001073 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001074 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001076}
1077
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001078/** Test whether a policy permits an algorithm.
1079 *
1080 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +01001081 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001082 * \note This function requires providing the key type for which the policy is
1083 * being validated, since some algorithm policy definitions (e.g. MAC)
1084 * have different properties depending on what kind of cipher it is
1085 * combined with.
1086 *
Steven Cooreman7e39f052021-02-23 14:18:32 +01001087 * \retval PSA_SUCCESS When \p alg is a specific algorithm
1088 * allowed by the \p policy.
1089 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
1090 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
1091 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001092 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001093static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
1094 psa_key_type_t key_type,
1095 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001096{
Steven Cooremand788fab2021-02-25 11:29:17 +01001097 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 if (alg == 0) {
1099 return PSA_ERROR_INVALID_ARGUMENT;
1100 }
Steven Cooremand788fab2021-02-25 11:29:17 +01001101
Steven Cooreman7e39f052021-02-23 14:18:32 +01001102 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 if (PSA_ALG_IS_WILDCARD(alg)) {
1104 return PSA_ERROR_INVALID_ARGUMENT;
1105 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001106
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
1108 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
1109 return PSA_SUCCESS;
1110 } else {
1111 return PSA_ERROR_NOT_PERMITTED;
1112 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001113}
1114
Gilles Peskinef603c712019-01-19 13:40:11 +01001115/** Restrict a key policy based on a constraint.
1116 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001117 * \note This function requires providing the key type for which the policy is
1118 * being restricted, since some algorithm policy definitions (e.g. MAC)
1119 * have different properties depending on what kind of cipher it is
1120 * combined with.
1121 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001122 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +01001123 * \param[in,out] policy The policy to restrict.
1124 * \param[in] constraint The policy constraint to apply.
1125 *
1126 * \retval #PSA_SUCCESS
1127 * \c *policy contains the intersection of the original value of
1128 * \c *policy and \c *constraint.
1129 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001130 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +01001131 * \c *policy is unchanged.
1132 */
1133static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001134 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +01001135 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +01001137{
1138 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 psa_key_policy_algorithm_intersection(key_type, policy->alg,
1140 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +02001141 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
1143 constraint->alg2);
1144 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1145 return PSA_ERROR_INVALID_ARGUMENT;
1146 }
1147 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1148 return PSA_ERROR_INVALID_ARGUMENT;
1149 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001150 policy->usage &= constraint->usage;
1151 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001152 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001154}
1155
Przemek Stekiel061f6942022-11-30 10:51:35 +01001156/** Get the description of a key given its identifier and policy constraints
1157 * and lock it.
1158 *
1159 * The key must have allow all the usage flags set in \p usage. If \p alg is
1160 * nonzero, the key must allow operations with this algorithm. If \p alg is
1161 * zero, the algorithm is not checked.
1162 *
1163 * In case of a persistent key, the function loads the description of the key
1164 * into a key slot if not already done.
1165 *
1166 * On success, the returned key slot is locked. It is the responsibility of
1167 * the caller to unlock the key slot when it does not access it anymore.
1168 */
1169static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001170 mbedtls_svc_key_id_t key,
1171 psa_key_slot_t **p_slot,
1172 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001174{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001175 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001176 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001177
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 status = psa_get_and_lock_key_slot(key, p_slot);
1179 if (status != PSA_SUCCESS) {
1180 return status;
1181 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001182 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001183
1184 /* Enforce that usage policy for the key slot contains all the flags
1185 * required by the usage parameter. There is one exception: public
1186 * keys can always be exported, so we treat public key objects as
1187 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001188 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001189 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001191
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001193 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001194 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001195 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001196
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001197 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 if (alg != 0) {
1199 status = psa_key_policy_permits(&slot->attr.policy,
1200 slot->attr.type,
1201 alg);
1202 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001203 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001205 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001206
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001208
1209error:
1210 *p_slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001212
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001214}
Darryl Green940d72c2018-07-13 13:18:51 +01001215
Ronald Cron5c522922020-11-14 16:35:34 +01001216/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001217 *
1218 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001219 * available, as opposed to a key in a secure element and/or to be used
1220 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001221 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001222 * This is a temporary function that may be used instead of
1223 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1224 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001225 *
Ronald Cron5c522922020-11-14 16:35:34 +01001226 * On success, the returned key slot is locked. It is the responsibility of the
1227 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001228 */
Ronald Cron5c522922020-11-14 16:35:34 +01001229static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1230 mbedtls_svc_key_id_t key,
1231 psa_key_slot_t **p_slot,
1232 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001234{
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1236 usage, alg);
1237 if (status != PSA_SUCCESS) {
1238 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001239 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001240
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
1242 psa_unlock_key_slot(*p_slot);
1243 *p_slot = NULL;
1244 return PSA_ERROR_NOT_SUPPORTED;
1245 }
1246
1247 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001248}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001249
Gilles Peskine449bd832023-01-11 14:50:10 +01001250psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001251{
Gilles Peskine449bd832023-01-11 14:50:10 +01001252 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001253 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001255
Ronald Cronea0f8a62020-11-25 17:52:23 +01001256 slot->key.data = NULL;
1257 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001258
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001260}
1261
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001262/** Completely wipe a slot in memory, including its policy.
1263 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001264psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001265{
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001267
Gilles Peskine449bd832023-01-11 14:50:10 +01001268 /*
1269 * As the return error code may not be handled in case of multiple errors,
1270 * do our best to report an unexpected lock counter. Assert with
1271 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
1272 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1273 * function is called as part of the execution of a test suite, the
1274 * execution of the test suite is stopped in error if the assertion fails.
1275 */
1276 if (slot->lock_count != 1) {
1277 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->lock_count == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001278 status = PSA_ERROR_CORRUPTION_DETECTED;
1279 }
1280
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001281 /* Multipart operations may still be using the key. This is safe
1282 * because all multipart operation objects are independent from
1283 * the key slot: if they need to access the key after the setup
1284 * phase, they have a copy of the key. Note that this means that
1285 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001286 /* At this point, key material and other type-specific content has
1287 * been wiped. Clear remaining metadata. We can call memset and not
1288 * zeroize because the metadata is not particularly sensitive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 memset(slot, 0, sizeof(*slot));
1290 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001291}
1292
Gilles Peskine449bd832023-01-11 14:50:10 +01001293psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001294{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001295 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001296 psa_status_t status; /* status of the last operation */
1297 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001298#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1299 psa_se_drv_table_entry_t *driver;
1300#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001301
Gilles Peskine449bd832023-01-11 14:50:10 +01001302 if (mbedtls_svc_key_id_is_null(key)) {
1303 return PSA_SUCCESS;
1304 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001305
Ronald Cronf2911112020-10-29 17:51:10 +01001306 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001307 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001308 * key, this will load the key description from persistent memory if not
1309 * done yet. We cannot avoid this loading as without it we don't know if
1310 * the key is operated by an SE or not and this information is needed by
1311 * the current implementation.
1312 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001313 status = psa_get_and_lock_key_slot(key, &slot);
1314 if (status != PSA_SUCCESS) {
1315 return status;
1316 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001317
Ronald Cronf2911112020-10-29 17:51:10 +01001318 /*
1319 * If the key slot containing the key description is under access by the
1320 * library (apart from the present access), the key cannot be destroyed
1321 * yet. For the time being, just return in error. Eventually (to be
1322 * implemented), the key should be destroyed when all accesses have
1323 * stopped.
1324 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001325 if (slot->lock_count > 1) {
1326 psa_unlock_key_slot(slot);
1327 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001328 }
1329
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001331 /* Refuse the destruction of a read-only key (which may or may not work
1332 * if we attempt it, depending on whether the key is merely read-only
1333 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001334 * Just do the best we can, which is to wipe the copy in memory
1335 * (done in this function's cleanup code). */
1336 overall_status = PSA_ERROR_NOT_PERMITTED;
1337 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001338 }
1339
Gilles Peskine354f7672019-07-12 23:46:38 +02001340#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1342 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001343 /* For a key in a secure element, we need to do three things:
1344 * remove the key file in internal storage, destroy the
1345 * key inside the secure element, and update the driver's
1346 * persistent data. Start a transaction that will encompass these
1347 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001349 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001351 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 status = psa_crypto_save_transaction();
1353 if (status != PSA_SUCCESS) {
1354 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001355 /* We should still try to destroy the key in the secure
1356 * element and the key metadata in storage. This is especially
1357 * important if the error is that the storage is full.
1358 * But how to do it exactly without risking an inconsistent
1359 * state after a reset?
1360 * https://github.com/ARMmbed/mbed-crypto/issues/215
1361 */
1362 overall_status = status;
1363 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001364 }
1365
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 status = psa_destroy_se_key(driver,
1367 psa_key_slot_get_slot_number(slot));
1368 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001369 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001371 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001372#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1373
Darryl Greend49a4992018-06-18 17:27:26 +01001374#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001375 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1376 status = psa_destroy_persistent_key(slot->attr.id);
1377 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001378 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001379 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001380
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001381 /* TODO: other slots may have a copy of the same key. We should
1382 * invalidate them.
1383 * https://github.com/ARMmbed/mbed-crypto/issues/214
1384 */
Darryl Greend49a4992018-06-18 17:27:26 +01001385 }
1386#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001387
Gilles Peskinefc762652019-07-22 19:30:34 +02001388#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 if (driver != NULL) {
1390 status = psa_save_se_persistent_data(driver);
1391 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001392 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 }
1394 status = psa_crypto_stop_transaction();
1395 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001396 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001398 }
1399#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1400
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001401exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001403 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001405 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 }
1407 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001408}
1409
Valerio Settib2bcedb2023-07-10 11:24:00 +02001410#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001411 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001412static psa_status_t psa_get_rsa_public_exponent(
1413 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001415{
1416 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001417 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001418 uint8_t *buffer = NULL;
1419 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001421
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1423 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001424 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 }
1426 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001427 /* It's the default value, which is reported as an empty string,
1428 * so there's nothing to do. */
1429 goto exit;
1430 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001431
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 buflen = mbedtls_mpi_size(&mpi);
1433 buffer = mbedtls_calloc(1, buflen);
1434 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001435 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1436 goto exit;
1437 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1439 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001440 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001442 attributes->domain_parameters = buffer;
1443 attributes->domain_parameters_size = buflen;
1444
1445exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 mbedtls_mpi_free(&mpi);
1447 if (ret != 0) {
1448 mbedtls_free(buffer);
1449 }
1450 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001451}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001452#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001453 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001454
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001455/** Retrieve all the publicly-accessible attributes of a key.
1456 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001457psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1458 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001459{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001460 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001461 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001462 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001463
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001465
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1467 if (status != PSA_SUCCESS) {
1468 return status;
1469 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001470
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001471 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1473 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001474
1475#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1477 psa_set_key_slot_number(attributes,
1478 psa_key_slot_get_slot_number(slot));
1479 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001480#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001481
Gilles Peskine449bd832023-01-11 14:50:10 +01001482 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001483#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1484 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001485 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001486 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001487 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001488 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001489 * is not yet implemented.
1490 * https://github.com/ARMmbed/mbed-crypto/issues/216
1491 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001493 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001494
Ronald Cron90857082020-11-25 14:58:33 +01001495 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 slot->attr.type,
1497 slot->key.data,
1498 slot->key.bytes,
1499 &rsa);
1500 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001501 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001503
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 status = psa_get_rsa_public_exponent(rsa,
1505 attributes);
1506 mbedtls_rsa_free(rsa);
1507 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001508 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001509 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001510#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1511 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001512 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001513 default:
1514 /* Nothing else to do. */
1515 break;
1516 }
1517
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 if (status != PSA_SUCCESS) {
1519 psa_reset_key_attributes(attributes);
1520 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001521
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001523
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001525}
1526
Gilles Peskinec8000c02019-08-02 20:15:51 +02001527#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1528psa_status_t psa_get_key_slot_number(
1529 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001531{
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001533 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 return PSA_SUCCESS;
1535 } else {
1536 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001537 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001538}
1539#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1542 size_t key_buffer_size,
1543 uint8_t *data,
1544 size_t data_size,
1545 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001546{
Gilles Peskine449bd832023-01-11 14:50:10 +01001547 if (key_buffer_size > data_size) {
1548 return PSA_ERROR_BUFFER_TOO_SMALL;
1549 }
1550 memcpy(data, key_buffer, key_buffer_size);
1551 memset(data + key_buffer_size, 0,
1552 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001553 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001555}
1556
Ronald Cron7285cda2020-11-26 14:46:37 +01001557psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001558 const psa_key_attributes_t *attributes,
1559 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001560 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001561{
Ronald Crond18b5f82020-11-25 16:46:05 +01001562 psa_key_type_t type = attributes->core.type;
1563
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 if (key_type_is_raw_bytes(type) ||
1565 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001566 PSA_KEY_TYPE_IS_ECC(type) ||
1567 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 return psa_export_key_buffer_internal(
1569 key_buffer, key_buffer_size,
1570 data, data_size, data_length);
1571 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001572 /* This shouldn't happen in the reference implementation, but
1573 it is valid for a special-purpose implementation to omit
1574 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001575 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001576 }
1577}
1578
Gilles Peskine449bd832023-01-11 14:50:10 +01001579psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1580 uint8_t *data,
1581 size_t data_size,
1582 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001583{
1584 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1585 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1586 psa_key_slot_t *slot;
1587
Ronald Crone907e552021-01-18 13:22:38 +01001588 /* Reject a zero-length output buffer now, since this can never be a
1589 * valid key representation. This way we know that data must be a valid
1590 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 if (data_size == 0) {
1592 return PSA_ERROR_BUFFER_TOO_SMALL;
1593 }
Ronald Crone907e552021-01-18 13:22:38 +01001594
Ronald Cron9486f9d2020-11-26 13:36:23 +01001595 /* Set the key to empty now, so that even when there are errors, we always
1596 * set data_length to a value between 0 and data_size. On error, setting
1597 * the key to empty is a good choice because an empty key representation is
1598 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001599 *data_length = 0;
1600
Ronald Cron9486f9d2020-11-26 13:36:23 +01001601 /* Export requires the EXPORT flag. There is an exception for public keys,
1602 * which don't require any flag, but
1603 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1604 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1606 PSA_KEY_USAGE_EXPORT, 0);
1607 if (status != PSA_SUCCESS) {
1608 return status;
1609 }
mohammad160306e79202018-03-28 13:17:44 +03001610
Ronald Crond18b5f82020-11-25 16:46:05 +01001611 psa_key_attributes_t attributes = {
1612 .core = slot->attr
1613 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 status = psa_driver_wrapper_export_key(&attributes,
1615 slot->key.data, slot->key.bytes,
1616 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001617
Gilles Peskine449bd832023-01-11 14:50:10 +01001618 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001619
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001621}
1622
Ronald Cron7285cda2020-11-26 14:46:37 +01001623psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001624 const psa_key_attributes_t *attributes,
1625 const uint8_t *key_buffer,
1626 size_t key_buffer_size,
1627 uint8_t *data,
1628 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001630{
Ronald Crond18b5f82020-11-25 16:46:05 +01001631 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001632
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001633 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001634 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1635 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001636 /* Exporting public -> public */
1637 return psa_export_key_buffer_internal(
1638 key_buffer, key_buffer_size,
1639 data, data_size, data_length);
1640 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001641#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001642 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1643 return mbedtls_psa_rsa_export_public_key(attributes,
1644 key_buffer,
1645 key_buffer_size,
1646 data,
1647 data_size,
1648 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001649#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001650 /* We don't know how to convert a private RSA key to public. */
1651 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001652#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001653 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001654 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001655#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001656 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1657 return mbedtls_psa_ecp_export_public_key(attributes,
1658 key_buffer,
1659 key_buffer_size,
1660 data,
1661 data_size,
1662 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001663#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001664 /* We don't know how to convert a private ECC key to public */
1665 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001666#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001667 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001668 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001669#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001670 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001671 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001672 key_buffer,
1673 key_buffer_size,
1674 data, data_size,
1675 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001676#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001677 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001678#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001679 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001681 (void) key_buffer;
1682 (void) key_buffer_size;
1683 (void) data;
1684 (void) data_size;
1685 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001687 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001688}
Ronald Crond18b5f82020-11-25 16:46:05 +01001689
Gilles Peskine449bd832023-01-11 14:50:10 +01001690psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1691 uint8_t *data,
1692 size_t data_size,
1693 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001694{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001695 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001696 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001697 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001698 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001699
Ronald Crone907e552021-01-18 13:22:38 +01001700 /* Reject a zero-length output buffer now, since this can never be a
1701 * valid key representation. This way we know that data must be a valid
1702 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 if (data_size == 0) {
1704 return PSA_ERROR_BUFFER_TOO_SMALL;
1705 }
Ronald Crone907e552021-01-18 13:22:38 +01001706
Darryl Greendd8fb772018-11-07 16:00:44 +00001707 /* Set the key to empty now, so that even when there are errors, we always
1708 * set data_length to a value between 0 and data_size. On error, setting
1709 * the key to empty is a good choice because an empty key representation is
1710 * unlikely to be accepted anywhere. */
1711 *data_length = 0;
1712
1713 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1715 if (status != PSA_SUCCESS) {
1716 return status;
1717 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001718
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1720 status = PSA_ERROR_INVALID_ARGUMENT;
1721 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001722 }
1723
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001724 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001725 .core = slot->attr
1726 };
Ronald Cron67227982020-11-26 15:16:05 +01001727 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001728 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001730
1731exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001735}
1736
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001737MBEDTLS_STATIC_ASSERT(
1738 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1739 "One or more key attribute flag is listed as both external-only and dual-use")
1740MBEDTLS_STATIC_ASSERT(
1741 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1742 "One or more key attribute flag is listed as both internal-only and dual-use")
1743MBEDTLS_STATIC_ASSERT(
1744 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1745 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001746
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001747/** Validate that a key policy is internally well-formed.
1748 *
1749 * This function only rejects invalid policies. It does not validate the
1750 * consistency of the policy with respect to other attributes of the key
1751 * such as the key type.
1752 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001753static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001754{
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1756 PSA_KEY_USAGE_COPY |
1757 PSA_KEY_USAGE_ENCRYPT |
1758 PSA_KEY_USAGE_DECRYPT |
1759 PSA_KEY_USAGE_SIGN_MESSAGE |
1760 PSA_KEY_USAGE_VERIFY_MESSAGE |
1761 PSA_KEY_USAGE_SIGN_HASH |
1762 PSA_KEY_USAGE_VERIFY_HASH |
1763 PSA_KEY_USAGE_VERIFY_DERIVATION |
1764 PSA_KEY_USAGE_DERIVE)) != 0) {
1765 return PSA_ERROR_INVALID_ARGUMENT;
1766 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001767
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001769}
1770
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001771/** Validate the internal consistency of key attributes.
1772 *
1773 * This function only rejects invalid attribute values. If does not
1774 * validate the consistency of the attributes with any key data that may
1775 * be involved in the creation of the key.
1776 *
1777 * Call this function early in the key creation process.
1778 *
1779 * \param[in] attributes Key attributes for the new key.
1780 * \param[out] p_drv On any return, the driver for the key, if any.
1781 * NULL for a transparent key.
1782 *
1783 */
1784static psa_status_t psa_validate_key_attributes(
1785 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001787{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001788 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1790 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001791
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 status = psa_validate_key_location(lifetime, p_drv);
1793 if (status != PSA_SUCCESS) {
1794 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001795 }
1796
Gilles Peskine449bd832023-01-11 14:50:10 +01001797 status = psa_validate_key_persistence(lifetime);
1798 if (status != PSA_SUCCESS) {
1799 return status;
1800 }
1801
1802 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1803 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1804 return PSA_ERROR_INVALID_ARGUMENT;
1805 }
1806 } else {
1807 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1808 return PSA_ERROR_INVALID_ARGUMENT;
1809 }
1810 }
1811
1812 status = psa_validate_key_policy(&attributes->core.policy);
1813 if (status != PSA_SUCCESS) {
1814 return status;
1815 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001816
1817 /* Refuse to create overly large keys.
1818 * Note that this doesn't trigger on import if the attributes don't
1819 * explicitly specify a size (so psa_get_key_bits returns 0), so
1820 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1822 return PSA_ERROR_NOT_SUPPORTED;
1823 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001824
Gilles Peskine91e8c332019-08-02 19:19:39 +02001825 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1827 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1828 return PSA_ERROR_INVALID_ARGUMENT;
1829 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001830
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001832}
1833
Gilles Peskine4747d192019-04-17 15:05:45 +02001834/** Prepare a key slot to receive key material.
1835 *
1836 * This function allocates a key slot and sets its metadata.
1837 *
1838 * If this function fails, call psa_fail_key_creation().
1839 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001840 * This function is intended to be used as follows:
1841 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001842 * it with the specified attributes, and in case of a volatile key assign it
1843 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001844 * -# Populate the slot with the key material.
1845 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1846 * In case of failure at any step, stop the sequence and call
1847 * psa_fail_key_creation().
1848 *
Ronald Cron5c522922020-11-14 16:35:34 +01001849 * On success, the key slot is locked. It is the responsibility of the caller
1850 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001851 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001852 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001853 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001854 * \param[out] p_slot On success, a pointer to the prepared slot.
1855 * \param[out] p_drv On any return, the driver for the key, if any.
1856 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001857 *
1858 * \retval #PSA_SUCCESS
1859 * The key slot is ready to receive key material.
1860 * \return If this function fails, the key slot is an invalid state.
1861 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001862 */
1863static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001864 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001865 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001866 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001868{
1869 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001870 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001871 psa_key_slot_t *slot;
1872
Gilles Peskinedf179142019-07-15 22:02:14 +02001873 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001874 *p_drv = NULL;
1875
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 status = psa_validate_key_attributes(attributes, p_drv);
1877 if (status != PSA_SUCCESS) {
1878 return status;
1879 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001880
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1882 if (status != PSA_SUCCESS) {
1883 return status;
1884 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001885 slot = *p_slot;
1886
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001887 /* We're storing the declared bit-size of the key. It's up to each
1888 * creation mechanism to verify that this information is correct.
1889 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001890 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001891 * is optional (import, copy). In case of a volatile key, assign it the
1892 * volatile key identifier associated to the slot returned to contain its
1893 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001894
1895 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001897#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1898 slot->attr.id = volatile_key_id;
1899#else
1900 slot->attr.id.key_id = volatile_key_id;
1901#endif
1902 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001903
Gilles Peskine91e8c332019-08-02 19:19:39 +02001904 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001905 * external-only flags, query `attributes`. Thanks to the check
1906 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001907 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001908 * may have set. */
1909 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001910
Gilles Peskinecbaff462019-07-12 23:46:04 +02001911#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001912 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001913 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001914 * create the key file in internal storage, create the
1915 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001916 * persistent data. This is done by starting a transaction that will
1917 * encompass these three actions.
1918 * For registering a volatile key, we just need to find an appropriate
1919 * slot number inside the SE. Since the key is designated volatile, creating
1920 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001921 /* The first thing to do is to find a slot number for the new key.
1922 * We save the slot number in persistent storage as part of the
1923 * transaction data. It will be needed to recover if the power
1924 * fails during the key creation process, to clean up on the secure
1925 * element side after restarting. Obtaining a slot number from the
1926 * secure element driver updates its persistent state, but we do not yet
1927 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001928 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001930 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1932 &slot_number);
1933 if (status != PSA_SUCCESS) {
1934 return status;
1935 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001936
Gilles Peskine449bd832023-01-11 14:50:10 +01001937 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1938 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001939 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001940 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001941 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 status = psa_crypto_save_transaction();
1943 if (status != PSA_SUCCESS) {
1944 (void) psa_crypto_stop_transaction();
1945 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001946 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001947 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001948
1949 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001951 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001952
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001954 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001956 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001957#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1958
Ryan Everett975d4112023-11-16 13:37:51 +00001959 slot->status = PSA_SLOT_OCCUPIED;
1960
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001962}
Gilles Peskine4747d192019-04-17 15:05:45 +02001963
1964/** Finalize the creation of a key once its key material has been set.
1965 *
1966 * This entails writing the key to persistent storage.
1967 *
1968 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001969 * See the documentation of psa_start_key_creation() for the intended use
1970 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001971 *
Ronald Cron5c522922020-11-14 16:35:34 +01001972 * If the finalization succeeds, the function unlocks the key slot (it was
1973 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1974 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001975 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001976 * \param[in,out] slot Pointer to the slot with key material.
1977 * \param[in] driver The secure element driver for the key,
1978 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001979 * \param[out] key On success, identifier of the key. Note that the
1980 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001981 *
1982 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001983 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001984 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1985 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1986 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1987 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1988 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1989 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001990 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001991 * \return If this function fails, the key slot is an invalid state.
1992 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001993 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001994static psa_status_t psa_finish_key_creation(
1995 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001996 psa_se_drv_table_entry_t *driver,
1997 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001998{
1999 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02002000 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02002001 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02002002
2003#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02002005#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002007 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01002008 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01002010
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00002011 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
2012 sizeof(data.slot_number),
2013 "Slot number size does not match psa_se_key_data_storage_t");
2014
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
2016 status = psa_save_persistent_key(&slot->attr,
2017 (uint8_t *) &data,
2018 sizeof(data));
2019 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02002020#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2021 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002022 /* Key material is saved in export representation in the slot, so
2023 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 status = psa_save_persistent_key(&slot->attr,
2025 slot->key.data,
2026 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02002027 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002028 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002029#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2030
Gilles Peskinecbaff462019-07-12 23:46:04 +02002031#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002032 /* Finish the transaction for a key creation. This does not
2033 * happen when registering an existing key. Detect this case
2034 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002035 * creation of a persistent key in a secure element requires a transaction,
2036 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 if (driver != NULL &&
2038 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
2039 status = psa_save_se_persistent_data(driver);
2040 if (status != PSA_SUCCESS) {
2041 psa_destroy_persistent_key(slot->attr.id);
2042 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02002043 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02002045 }
2046#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2047
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002049 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 status = psa_unlock_key_slot(slot);
2051 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002052 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002054 }
Ronald Cron50972942020-11-14 11:28:25 +01002055
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002057}
2058
2059/** Abort the creation of a key.
2060 *
2061 * You may call this function after calling psa_start_key_creation(),
2062 * or after psa_finish_key_creation() fails. In other circumstances, this
2063 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002064 * See the documentation of psa_start_key_creation() for the intended use
2065 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002066 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002067 * \param[in,out] slot Pointer to the slot with key material.
2068 * \param[in] driver The secure element driver for the key,
2069 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002071static void psa_fail_key_creation(psa_key_slot_t *slot,
2072 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02002073{
Gilles Peskine011e4282019-06-26 18:34:38 +02002074 (void) driver;
2075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02002077 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 }
Gilles Peskine011e4282019-06-26 18:34:38 +02002079
2080#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002081 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002082 * element, and the failure happened later (when saving metadata
2083 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002084 * element.
2085 * https://github.com/ARMmbed/mbed-crypto/issues/217
2086 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002087
Gilles Peskined7729582019-08-05 15:55:54 +02002088 /* Abort the ongoing transaction if any (there may not be one if
2089 * the creation process failed before starting one, or if the
2090 * key creation is a registration of a key in a secure element).
2091 * Earlier functions must already have done what it takes to undo any
2092 * partial creation. All that's left is to update the transaction data
2093 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002095#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2096
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02002098}
2099
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002100/** Validate optional attributes during key creation.
2101 *
2102 * Some key attributes are optional during key creation. If they are
2103 * specified in the attributes structure, check that they are consistent
2104 * with the data in the slot.
2105 *
2106 * This function should be called near the end of key creation, after
2107 * the slot in memory is fully populated but before saving persistent data.
2108 */
2109static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002110 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002112{
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 if (attributes->core.type != 0) {
2114 if (attributes->core.type != slot->attr.type) {
2115 return PSA_ERROR_INVALID_ARGUMENT;
2116 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002117 }
2118
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002120#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2121 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2123 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002124 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002125 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002126 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002127
Ronald Cron90857082020-11-25 14:58:33 +01002128 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 slot->attr.type,
2130 slot->key.data,
2131 slot->key.bytes,
2132 &rsa);
2133 if (status != PSA_SUCCESS) {
2134 return status;
2135 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 mbedtls_mpi_init(&actual);
2138 mbedtls_mpi_init(&required);
2139 ret = mbedtls_rsa_export(rsa,
2140 NULL, NULL, NULL, NULL, &actual);
2141 mbedtls_rsa_free(rsa);
2142 mbedtls_free(rsa);
2143 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002144 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 }
2146 ret = mbedtls_mpi_read_binary(&required,
2147 attributes->domain_parameters,
2148 attributes->domain_parameters_size);
2149 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002150 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 }
2152 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002153 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 }
2155rsa_exit:
2156 mbedtls_mpi_free(&actual);
2157 mbedtls_mpi_free(&required);
2158 if (ret != 0) {
2159 return mbedtls_to_psa_error(ret);
2160 }
2161 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002162#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2163 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002164 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002165 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002167 }
2168 }
2169
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 if (attributes->core.bits != 0) {
2171 if (attributes->core.bits != slot->attr.bits) {
2172 return PSA_ERROR_INVALID_ARGUMENT;
2173 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002174 }
2175
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002177}
2178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
2180 const uint8_t *data,
2181 size_t data_length,
2182 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002183{
2184 psa_status_t status;
2185 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002186 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002187 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302188 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002189
Ronald Cron81709fc2020-11-14 12:10:32 +01002190 *key = MBEDTLS_SVC_KEY_ID_INIT;
2191
Gilles Peskine0f84d622019-09-12 19:03:13 +02002192 /* Reject zero-length symmetric keys (including raw data key objects).
2193 * This also rejects any key which might be encoded as an empty string,
2194 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 if (data_length == 0) {
2196 return PSA_ERROR_INVALID_ARGUMENT;
2197 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002198
Archana449608b2021-09-08 15:36:05 +05302199 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 if (data_length > SIZE_MAX / 8) {
2201 return PSA_ERROR_NOT_SUPPORTED;
2202 }
Archana6ed4bda2021-08-04 10:47:15 +05302203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2205 &slot, &driver);
2206 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002207 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002209
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002210 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302211 * storage ( thus not in the case of importing a key in a secure element
2212 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2213 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 if (slot->key.data == NULL) {
2215 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302216 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 attributes, data, data_length, &storage_size);
2218 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302219 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 }
Archanad8a83dc2021-06-14 10:04:16 +05302221 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 status = psa_allocate_buffer_to_slot(slot, storage_size);
2223 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002224 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002226 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002227
2228 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 status = psa_driver_wrapper_import_key(attributes,
2230 data, data_length,
2231 slot->key.data,
2232 slot->key.bytes,
2233 &slot->key.bytes, &bits);
2234 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002235 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002239 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002241 status = PSA_ERROR_INVALID_ARGUMENT;
2242 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002243 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002244
Archana6ed4bda2021-08-04 10:47:15 +05302245 /* Enforce a size limit, and in particular ensure that the bit
2246 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302248 status = PSA_ERROR_NOT_SUPPORTED;
2249 goto exit;
2250 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 status = psa_validate_optional_attributes(slot, attributes);
2252 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002253 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002257exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 if (status != PSA_SUCCESS) {
2259 psa_fail_key_creation(slot, driver);
2260 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002261
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002263}
2264
Gilles Peskined7729582019-08-05 15:55:54 +02002265#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2266psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002268{
2269 psa_status_t status;
2270 psa_key_slot_t *slot = NULL;
2271 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002272 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002273
2274 /* Leaving attributes unspecified is not currently supported.
2275 * It could make sense to query the key type and size from the
2276 * secure element, but not all secure elements support this
2277 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2279 return PSA_ERROR_NOT_SUPPORTED;
2280 }
2281 if (psa_get_key_bits(attributes) == 0) {
2282 return PSA_ERROR_NOT_SUPPORTED;
2283 }
Gilles Peskined7729582019-08-05 15:55:54 +02002284
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2286 &slot, &driver);
2287 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002288 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 }
Gilles Peskined7729582019-08-05 15:55:54 +02002290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002292
2293exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 if (status != PSA_SUCCESS) {
2295 psa_fail_key_creation(slot, driver);
2296 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002297
Gilles Peskined7729582019-08-05 15:55:54 +02002298 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 psa_close_key(key);
2300 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002301}
2302#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2303
Gilles Peskine449bd832023-01-11 14:50:10 +01002304psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2305 const psa_key_attributes_t *specified_attributes,
2306 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002307{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002308 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002309 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002310 psa_key_slot_t *source_slot = NULL;
2311 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002312 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002313 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302314 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002315
Ronald Cron81709fc2020-11-14 12:10:32 +01002316 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2317
Archana8a180362021-07-05 02:18:48 +05302318 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2320 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002321 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002323
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 status = psa_validate_optional_attributes(source_slot,
2325 specified_attributes);
2326 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002327 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002329
Archana9d17bf42021-09-10 06:22:44 +05302330 /* The target key type and number of bits have been validated by
2331 * psa_validate_optional_attributes() to be either equal to zero or
2332 * equal to the ones of the source key. So it is safe to inherit
2333 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302334 * */
Archana9d17bf42021-09-10 06:22:44 +05302335 actual_attributes.core.bits = source_slot->attr.bits;
2336 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302337
2338
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 status = psa_restrict_key_policy(source_slot->attr.type,
2340 &actual_attributes.core.policy,
2341 &source_slot->attr.policy);
2342 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002343 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002345
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2347 &target_slot, &driver);
2348 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002349 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 }
2351 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2352 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302353 /*
Archana9d17bf42021-09-10 06:22:44 +05302354 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302355 * the source key would need to be exported as plaintext and re-imported
2356 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302357 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302358 * appropriate API invocations from the application, if needed.
2359 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002360 status = PSA_ERROR_NOT_SUPPORTED;
2361 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002362 }
Archana8a180362021-07-05 02:18:48 +05302363 /*
2364 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302365 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302366 * - For opaque keys this translates to an invocation of the drivers'
2367 * copy_key entry point through the dispatch layer.
2368 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2370 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2371 &storage_size);
2372 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302373 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 }
Archana374fe5b2021-09-08 15:50:28 +05302375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2377 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302378 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 }
Archana374fe5b2021-09-08 15:50:28 +05302380
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 status = psa_driver_wrapper_copy_key(&actual_attributes,
2382 source_slot->key.data,
2383 source_slot->key.bytes,
2384 target_slot->key.data,
2385 target_slot->key.bytes,
2386 &target_slot->key.bytes);
2387 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302388 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 }
2390 } else {
2391 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302392 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 source_slot->key.bytes);
2394 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302395 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 }
Archana8a180362021-07-05 02:18:48 +05302397 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002399exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 if (status != PSA_SUCCESS) {
2401 psa_fail_key_creation(target_slot, driver);
2402 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002403
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002405
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002407}
2408
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002409
2410
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002411/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002412/* Message digests */
2413/****************************************************************/
2414
Gilles Peskine449bd832023-01-11 14:50:10 +01002415psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002416{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002417 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 if (operation->id == 0) {
2419 return PSA_SUCCESS;
2420 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002421
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002423 operation->id = 0;
2424
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002426}
2427
Gilles Peskine449bd832023-01-11 14:50:10 +01002428psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2429 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002430{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002431 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002432
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002433 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002435 status = PSA_ERROR_BAD_STATE;
2436 goto exit;
2437 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002438
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002440 status = PSA_ERROR_INVALID_ARGUMENT;
2441 goto exit;
2442 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002443
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002444 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2445 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002447
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002449
2450exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 if (status != PSA_SUCCESS) {
2452 psa_hash_abort(operation);
2453 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002454
2455 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002456}
2457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2459 const uint8_t *input,
2460 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002461{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002462 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2463
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002465 status = PSA_ERROR_BAD_STATE;
2466 goto exit;
2467 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002468
Steven Cooremanc8288352021-03-04 14:02:19 +01002469 /* Don't require hash implementations to behave correctly on a
2470 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 if (input_length == 0) {
2472 return PSA_SUCCESS;
2473 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002474
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002476
2477exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 if (status != PSA_SUCCESS) {
2479 psa_hash_abort(operation);
2480 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002483}
2484
Gilles Peskine449bd832023-01-11 14:50:10 +01002485psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2486 uint8_t *hash,
2487 size_t hash_size,
2488 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002489{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002490 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 if (operation->id == 0) {
2492 return PSA_ERROR_BAD_STATE;
2493 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002494
Steven Cooreman1e582352021-02-18 17:24:37 +01002495 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 operation, hash, hash_size, hash_length);
2497 psa_hash_abort(operation);
2498 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002499}
2500
Gilles Peskine449bd832023-01-11 14:50:10 +01002501psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2502 const uint8_t *hash,
2503 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002504{
Ronald Cron69a63422021-10-18 09:47:58 +02002505 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002506 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002507 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 operation,
2509 actual_hash, sizeof(actual_hash),
2510 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002511
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002513 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002517 status = PSA_ERROR_INVALID_SIGNATURE;
2518 goto exit;
2519 }
2520
Dave Rodgman78701152023-08-29 14:20:18 +01002521 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002522 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002524
2525exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2527 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002528 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002530
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002532}
2533
Gilles Peskine449bd832023-01-11 14:50:10 +01002534psa_status_t psa_hash_compute(psa_algorithm_t alg,
2535 const uint8_t *input, size_t input_length,
2536 uint8_t *hash, size_t hash_size,
2537 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002538{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002539 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 if (!PSA_ALG_IS_HASH(alg)) {
2541 return PSA_ERROR_INVALID_ARGUMENT;
2542 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002543
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2545 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002546}
2547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548psa_status_t psa_hash_compare(psa_algorithm_t alg,
2549 const uint8_t *input, size_t input_length,
2550 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002551{
Ronald Cron69a63422021-10-18 09:47:58 +02002552 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002553 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002554
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 if (!PSA_ALG_IS_HASH(alg)) {
2556 return PSA_ERROR_INVALID_ARGUMENT;
2557 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002558
Steven Cooreman1e582352021-02-18 17:24:37 +01002559 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 alg, input, input_length,
2561 actual_hash, sizeof(actual_hash),
2562 &actual_hash_length);
2563 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002564 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 }
2566 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002567 status = PSA_ERROR_INVALID_SIGNATURE;
2568 goto exit;
2569 }
Dave Rodgman78701152023-08-29 14:20:18 +01002570 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002571 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002573
2574exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2576 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002577}
2578
Gilles Peskine449bd832023-01-11 14:50:10 +01002579psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2580 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002581{
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 if (source_operation->id == 0 ||
2583 target_operation->id != 0) {
2584 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002585 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2588 target_operation);
2589 if (status != PSA_SUCCESS) {
2590 psa_hash_abort(target_operation);
2591 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002594}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002595
2596
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002597/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002598/* MAC */
2599/****************************************************************/
2600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002602{
Steven Cooremane6804192021-03-19 18:28:56 +01002603 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 if (operation->id == 0) {
2605 return PSA_SUCCESS;
2606 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002609 operation->mac_size = 0;
2610 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002611 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002614}
2615
Ronald Cron2dff3b22021-06-17 16:33:22 +02002616static psa_status_t psa_mac_finalize_alg_and_key_validation(
2617 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002618 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002620{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002621 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 psa_key_type_t key_type = psa_get_key_type(attributes);
2623 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002624
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if (!PSA_ALG_IS_MAC(alg)) {
2626 return PSA_ERROR_INVALID_ARGUMENT;
2627 }
Steven Cooremane6804192021-03-19 18:28:56 +01002628
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002629 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 status = psa_mac_key_can_do(alg, key_type);
2631 if (status != PSA_SUCCESS) {
2632 return status;
2633 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002634
Steven Cooremand1a68f12021-05-10 11:13:41 +02002635 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002637
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002639 /* A very short MAC is too short for security since it can be
2640 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2641 * so we make this our minimum, even though 32 bits is still
2642 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002644 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002645
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2647 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002648 /* It's impossible to "truncate" to a larger length than the full length
2649 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002651 }
2652
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002654 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2655 * that is disabled in the compile-time configuration. The result can
2656 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2657 * configuration into account. In this case, force a return of
2658 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2659 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2660 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2661 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2662 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002664 }
2665
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002667}
2668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2670 mbedtls_svc_key_id_t key,
2671 psa_algorithm_t alg,
2672 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002673{
2674 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2675 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002676 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002677 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002678
2679 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002681 status = PSA_ERROR_BAD_STATE;
2682 goto exit;
2683 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002684
2685 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 key,
2687 &slot,
2688 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2689 alg);
2690 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002691 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002693
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002694 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002695 .core = slot->attr
2696 };
2697
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2699 &operation->mac_size);
2700 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002701 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002703
2704 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002705 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 if (is_sign) {
2707 status = psa_driver_wrapper_mac_sign_setup(operation,
2708 &attributes,
2709 slot->key.data,
2710 slot->key.bytes,
2711 alg);
2712 } else {
2713 status = psa_driver_wrapper_mac_verify_setup(operation,
2714 &attributes,
2715 slot->key.data,
2716 slot->key.bytes,
2717 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002718 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002719
Gilles Peskinefbfac682018-07-08 20:51:54 +02002720exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 if (status != PSA_SUCCESS) {
2722 psa_mac_abort(operation);
2723 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002724
Gilles Peskine449bd832023-01-11 14:50:10 +01002725 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002728}
2729
Gilles Peskine449bd832023-01-11 14:50:10 +01002730psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2731 mbedtls_svc_key_id_t key,
2732 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002733{
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002735}
2736
Gilles Peskine449bd832023-01-11 14:50:10 +01002737psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2738 mbedtls_svc_key_id_t key,
2739 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002740{
Gilles Peskine449bd832023-01-11 14:50:10 +01002741 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002742}
2743
Gilles Peskine449bd832023-01-11 14:50:10 +01002744psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2745 const uint8_t *input,
2746 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002747{
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 if (operation->id == 0) {
2749 return PSA_ERROR_BAD_STATE;
2750 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002751
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002752 /* Don't require hash implementations to behave correctly on a
2753 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 if (input_length == 0) {
2755 return PSA_SUCCESS;
2756 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002757
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2759 input, input_length);
2760 if (status != PSA_SUCCESS) {
2761 psa_mac_abort(operation);
2762 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002763
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002765}
2766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2768 uint8_t *mac,
2769 size_t mac_size,
2770 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002771{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002772 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2773 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002776 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002777 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002778 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002779
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002781 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002782 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002783 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002784
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002785 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2786 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002788 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002789 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002790 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002791
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002793 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002794 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002795 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 status = psa_driver_wrapper_mac_sign_finish(operation,
2798 mac, operation->mac_size,
2799 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002800
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002801exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002802 /* In case of success, set the potential excess room in the output buffer
2803 * to an invalid value, to avoid potentially leaking a longer MAC.
2804 * In case of error, set the output length and content to a safe default,
2805 * such that in case the caller misses an error check, the output would be
2806 * an unachievable MAC.
2807 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002809 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002810 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002811 }
mohammad16036df908f2018-04-02 08:34:15 -07002812
Paul Elliottdc42ca82023-02-24 18:11:59 +00002813 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002816
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002818}
2819
Gilles Peskine449bd832023-01-11 14:50:10 +01002820psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2821 const uint8_t *mac,
2822 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002823{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002824 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2825 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002828 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002829 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002830 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002831
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002833 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002834 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002835 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002836
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002838 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002839 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002840 }
2841
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 status = psa_driver_wrapper_mac_verify_finish(operation,
2843 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002844
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002845exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002847
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002849}
2850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2852 psa_algorithm_t alg,
2853 const uint8_t *input,
2854 size_t input_length,
2855 uint8_t *mac,
2856 size_t mac_size,
2857 size_t *mac_length,
2858 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002859{
2860 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002861 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2862 psa_key_slot_t *slot;
2863 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002864 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002865
Ronald Cron51131b52021-06-17 17:17:20 +02002866 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 key,
2868 &slot,
2869 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2870 alg);
2871 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002872 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002874
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002875 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002876 .core = slot->attr
2877 };
2878
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2880 &operation_mac_size);
2881 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002882 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002886 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002887 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002888 }
2889
2890 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 &attributes,
2892 slot->key.data, slot->key.bytes,
2893 alg,
2894 input, input_length,
2895 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002896
2897exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002898 /* In case of success, set the potential excess room in the output buffer
2899 * to an invalid value, to avoid potentially leaking a longer MAC.
2900 * In case of error, set the output length and content to a safe default,
2901 * such that in case the caller misses an error check, the output would be
2902 * an unachievable MAC.
2903 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002905 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002906 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002907 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002908
2909 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002912
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002914}
2915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002917 psa_algorithm_t alg,
2918 const uint8_t *input,
2919 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 uint8_t *mac,
2921 size_t mac_size,
2922 size_t *mac_length)
2923{
2924 return psa_mac_compute_internal(key, alg,
2925 input, input_length,
2926 mac, mac_size, mac_length, 1);
2927}
2928
2929psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2930 psa_algorithm_t alg,
2931 const uint8_t *input,
2932 size_t input_length,
2933 const uint8_t *mac,
2934 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002935{
2936 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002937 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2938 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002939
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 status = psa_mac_compute_internal(key, alg,
2941 input, input_length,
2942 actual_mac, sizeof(actual_mac),
2943 &actual_mac_length, 0);
2944 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002945 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002946 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002947
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002949 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002950 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002951 }
Dave Rodgman78701152023-08-29 14:20:18 +01002952 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002953 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002954 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002955 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002956
2957exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002959
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002961}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002962
Gilles Peskinee59236f2018-01-27 23:32:46 +01002963/****************************************************************/
2964/* Asymmetric cryptography */
2965/****************************************************************/
2966
Gilles Peskine449bd832023-01-11 14:50:10 +01002967static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2968 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002969{
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 if (input_is_message) {
2971 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2972 return PSA_ERROR_INVALID_ARGUMENT;
2973 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002974
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2976 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2977 return PSA_ERROR_INVALID_ARGUMENT;
2978 }
2979 }
2980 } else {
2981 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2982 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002983 }
2984 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002987}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002988
Gilles Peskine449bd832023-01-11 14:50:10 +01002989static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2990 int input_is_message,
2991 psa_algorithm_t alg,
2992 const uint8_t *input,
2993 size_t input_length,
2994 uint8_t *signature,
2995 size_t signature_size,
2996 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002997{
2998 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2999 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3000 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003001 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003002
3003 *signature_length = 0;
3004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 status = psa_sign_verify_check_alg(input_is_message, alg);
3006 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003007 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003009
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003010 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02003011 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003012 * buffer can in principle be empty since it doesn't actually have
3013 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 if (signature_size == 0) {
3015 return PSA_ERROR_BUFFER_TOO_SMALL;
3016 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003017
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003018 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 key, &slot,
3020 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
3021 PSA_KEY_USAGE_SIGN_HASH,
3022 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003023
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003025 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003027
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003029 status = PSA_ERROR_INVALID_ARGUMENT;
3030 goto exit;
3031 }
3032
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003033 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003035 };
3036
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003038 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003039 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003040 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 signature, signature_size, signature_length);
3042 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003043
3044 status = psa_driver_wrapper_sign_hash(
3045 &attributes, slot->key.data, slot->key.bytes,
3046 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003048 }
3049
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003050
3051exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003052 psa_wipe_tag_output_buffer(signature, status, signature_size,
3053 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003054
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003056
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003058}
3059
Gilles Peskine449bd832023-01-11 14:50:10 +01003060static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3061 int input_is_message,
3062 psa_algorithm_t alg,
3063 const uint8_t *input,
3064 size_t input_length,
3065 const uint8_t *signature,
3066 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003067{
3068 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3069 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3070 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003071
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 status = psa_sign_verify_check_alg(input_is_message, alg);
3073 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003074 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003076
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003077 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 key, &slot,
3079 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3080 PSA_KEY_USAGE_VERIFY_HASH,
3081 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003082
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 if (status != PSA_SUCCESS) {
3084 return status;
3085 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003086
3087 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003088 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003089 };
3090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003092 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003093 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003094 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 signature, signature_length);
3096 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003097 status = psa_driver_wrapper_verify_hash(
3098 &attributes, slot->key.data, slot->key.bytes,
3099 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003101 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003102
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003104
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003106
3107}
3108
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003109psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003110 const psa_key_attributes_t *attributes,
3111 const uint8_t *key_buffer,
3112 size_t key_buffer_size,
3113 psa_algorithm_t alg,
3114 const uint8_t *input,
3115 size_t input_length,
3116 uint8_t *signature,
3117 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003119{
3120 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003121
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003123 size_t hash_length;
3124 uint8_t hash[PSA_HASH_MAX_SIZE];
3125
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003126 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 PSA_ALG_SIGN_GET_HASH(alg),
3128 input, input_length,
3129 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003130
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003132 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003134
3135 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 attributes, key_buffer, key_buffer_size,
3137 alg, hash, hash_length,
3138 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003139 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003140
Gilles Peskine449bd832023-01-11 14:50:10 +01003141 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003142}
3143
Gilles Peskine449bd832023-01-11 14:50:10 +01003144psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3145 psa_algorithm_t alg,
3146 const uint8_t *input,
3147 size_t input_length,
3148 uint8_t *signature,
3149 size_t signature_size,
3150 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003151{
3152 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003153 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003155}
3156
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003157psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003158 const psa_key_attributes_t *attributes,
3159 const uint8_t *key_buffer,
3160 size_t key_buffer_size,
3161 psa_algorithm_t alg,
3162 const uint8_t *input,
3163 size_t input_length,
3164 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003166{
3167 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003168
Gilles Peskine449bd832023-01-11 14:50:10 +01003169 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003170 size_t hash_length;
3171 uint8_t hash[PSA_HASH_MAX_SIZE];
3172
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003173 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003174 PSA_ALG_SIGN_GET_HASH(alg),
3175 input, input_length,
3176 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003177
Gilles Peskine449bd832023-01-11 14:50:10 +01003178 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003179 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003180 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003181
3182 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 attributes, key_buffer, key_buffer_size,
3184 alg, hash, hash_length,
3185 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003186 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003187
Gilles Peskine449bd832023-01-11 14:50:10 +01003188 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003189}
3190
Gilles Peskine449bd832023-01-11 14:50:10 +01003191psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3192 psa_algorithm_t alg,
3193 const uint8_t *input,
3194 size_t input_length,
3195 const uint8_t *signature,
3196 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003197{
3198 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003199 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003200 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003201}
3202
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003203psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003204 const psa_key_attributes_t *attributes,
3205 const uint8_t *key_buffer, size_t key_buffer_size,
3206 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003208{
Gilles Peskine449bd832023-01-11 14:50:10 +01003209 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3210 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3211 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003212#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003213 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3214 return mbedtls_psa_rsa_sign_hash(
3215 attributes,
3216 key_buffer, key_buffer_size,
3217 alg, hash, hash_length,
3218 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003219#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3220 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 } else {
3222 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003223 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003224 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3225 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003226#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003227 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3228 return mbedtls_psa_ecdsa_sign_hash(
3229 attributes,
3230 key_buffer, key_buffer_size,
3231 alg, hash, hash_length,
3232 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003233#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3234 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003235 } else {
3236 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003237 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003238 }
Ronald Cron4501c982021-03-19 20:09:32 +01003239
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 (void) key_buffer;
3241 (void) key_buffer_size;
3242 (void) hash;
3243 (void) hash_length;
3244 (void) signature;
3245 (void) signature_size;
3246 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003247
Gilles Peskine449bd832023-01-11 14:50:10 +01003248 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003249}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003250
Gilles Peskine449bd832023-01-11 14:50:10 +01003251psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3252 psa_algorithm_t alg,
3253 const uint8_t *hash,
3254 size_t hash_length,
3255 uint8_t *signature,
3256 size_t signature_size,
3257 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003258{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003259 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003260 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003262}
3263
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003264psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003265 const psa_key_attributes_t *attributes,
3266 const uint8_t *key_buffer, size_t key_buffer_size,
3267 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003269{
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3271 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3272 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003273#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3275 return mbedtls_psa_rsa_verify_hash(
3276 attributes,
3277 key_buffer, key_buffer_size,
3278 alg, hash, hash_length,
3279 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003280#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3281 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 } else {
3283 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003284 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3286 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003287#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003288 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3289 return mbedtls_psa_ecdsa_verify_hash(
3290 attributes,
3291 key_buffer, key_buffer_size,
3292 alg, hash, hash_length,
3293 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003294#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3295 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 } else {
3297 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003298 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003299 }
Ronald Cron4501c982021-03-19 20:09:32 +01003300
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 (void) key_buffer;
3302 (void) key_buffer_size;
3303 (void) hash;
3304 (void) hash_length;
3305 (void) signature;
3306 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003307
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003309}
3310
Gilles Peskine449bd832023-01-11 14:50:10 +01003311psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3312 psa_algorithm_t alg,
3313 const uint8_t *hash,
3314 size_t hash_length,
3315 const uint8_t *signature,
3316 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003317{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003318 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003319 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003320 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003321}
3322
Gilles Peskine449bd832023-01-11 14:50:10 +01003323psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3324 psa_algorithm_t alg,
3325 const uint8_t *input,
3326 size_t input_length,
3327 const uint8_t *salt,
3328 size_t salt_length,
3329 uint8_t *output,
3330 size_t output_size,
3331 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003332{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003333 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003334 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003335 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003336 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003337
Darryl Green5cc689a2018-07-24 15:34:10 +01003338 (void) input;
3339 (void) input_length;
3340 (void) salt;
3341 (void) output;
3342 (void) output_size;
3343
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003344 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003345
Gilles Peskine449bd832023-01-11 14:50:10 +01003346 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3347 return PSA_ERROR_INVALID_ARGUMENT;
3348 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003349
Ronald Cron5c522922020-11-14 16:35:34 +01003350 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3352 if (status != PSA_SUCCESS) {
3353 return status;
3354 }
3355 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3356 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003357 status = PSA_ERROR_INVALID_ARGUMENT;
3358 goto exit;
3359 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003360
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003361 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003363 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003364
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003365 status = psa_driver_wrapper_asymmetric_encrypt(
3366 &attributes, slot->key.data, slot->key.bytes,
3367 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003369exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003371
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003373}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003374
Gilles Peskine449bd832023-01-11 14:50:10 +01003375psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3376 psa_algorithm_t alg,
3377 const uint8_t *input,
3378 size_t input_length,
3379 const uint8_t *salt,
3380 size_t salt_length,
3381 uint8_t *output,
3382 size_t output_size,
3383 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003384{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003385 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003386 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003387 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003388 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003389
Darryl Green5cc689a2018-07-24 15:34:10 +01003390 (void) input;
3391 (void) input_length;
3392 (void) salt;
3393 (void) output;
3394 (void) output_size;
3395
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003396 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003397
Gilles Peskine449bd832023-01-11 14:50:10 +01003398 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3399 return PSA_ERROR_INVALID_ARGUMENT;
3400 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003401
Ronald Cron5c522922020-11-14 16:35:34 +01003402 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003403 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3404 if (status != PSA_SUCCESS) {
3405 return status;
3406 }
3407 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003408 status = PSA_ERROR_INVALID_ARGUMENT;
3409 goto exit;
3410 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003411
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003412 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003414 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003415
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003416 status = psa_driver_wrapper_asymmetric_decrypt(
3417 &attributes, slot->key.data, slot->key.bytes,
3418 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003420
3421exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003423
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003425}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003426
Paul Elliott9fe12f62022-11-30 19:16:02 +00003427/****************************************************************/
3428/* Asymmetric interruptible cryptography */
3429/****************************************************************/
3430
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003431static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3432
Paul Elliott9fe12f62022-11-30 19:16:02 +00003433void psa_interruptible_set_max_ops(uint32_t max_ops)
3434{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003435 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003436}
3437
3438uint32_t psa_interruptible_get_max_ops(void)
3439{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003440 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003441}
3442
Paul Elliott9fe12f62022-11-30 19:16:02 +00003443uint32_t psa_sign_hash_get_num_ops(
3444 const psa_sign_hash_interruptible_operation_t *operation)
3445{
Paul Elliott296ede92022-12-15 17:00:30 +00003446 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003447}
3448
3449uint32_t psa_verify_hash_get_num_ops(
3450 const psa_verify_hash_interruptible_operation_t *operation)
3451{
Paul Elliott296ede92022-12-15 17:00:30 +00003452 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003453}
3454
Paul Elliott59ad9452022-12-18 15:09:02 +00003455static psa_status_t psa_sign_hash_abort_internal(
3456 psa_sign_hash_interruptible_operation_t *operation)
3457{
3458 if (operation->id == 0) {
3459 /* The object has (apparently) been initialized but it is not (yet)
3460 * in use. It's ok to call abort on such an object, and there's
3461 * nothing to do. */
3462 return PSA_SUCCESS;
3463 }
3464
3465 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3466
3467 status = psa_driver_wrapper_sign_hash_abort(operation);
3468
3469 operation->id = 0;
3470
Paul Elliotte6145dc2023-02-07 12:51:21 +00003471 /* Do not clear either the error_occurred or num_ops elements here as they
3472 * only want to be cleared by the application calling abort, not by abort
3473 * being called at completion of an operation. */
3474
Paul Elliott59ad9452022-12-18 15:09:02 +00003475 return status;
3476}
3477
Paul Elliott9fe12f62022-11-30 19:16:02 +00003478psa_status_t psa_sign_hash_start(
3479 psa_sign_hash_interruptible_operation_t *operation,
3480 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3481 const uint8_t *hash, size_t hash_length)
3482{
3483 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3484 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3485 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003486 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003487
Paul Elliottc9774412023-02-06 15:14:07 +00003488 /* Check that start has not been previously called, or operation has not
3489 * previously errored. */
3490 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003491 return PSA_ERROR_BAD_STATE;
3492 }
3493
Paul Elliott9fe12f62022-11-30 19:16:02 +00003494 status = psa_sign_verify_check_alg(0, alg);
3495 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003496 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003497 return status;
3498 }
3499
3500 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3501 PSA_KEY_USAGE_SIGN_HASH,
3502 alg);
3503
3504 if (status != PSA_SUCCESS) {
3505 goto exit;
3506 }
3507
3508 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3509 status = PSA_ERROR_INVALID_ARGUMENT;
3510 goto exit;
3511 }
3512
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003513 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003514 .core = slot->attr
3515 };
3516
Paul Elliott296ede92022-12-15 17:00:30 +00003517 /* Ensure ops count gets reset, in case of operation re-use. */
3518 operation->num_ops = 0;
3519
Paul Elliott9fe12f62022-11-30 19:16:02 +00003520 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3521 slot->key.data,
3522 slot->key.bytes, alg,
3523 hash, hash_length);
3524exit:
3525
3526 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003527 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003528 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003529 }
3530
3531 unlock_status = psa_unlock_key_slot(slot);
3532
Paul Elliottc9774412023-02-06 15:14:07 +00003533 if (unlock_status != PSA_SUCCESS) {
3534 operation->error_occurred = 1;
3535 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003536
Paul Elliottc9774412023-02-06 15:14:07 +00003537 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003538}
3539
3540
3541psa_status_t psa_sign_hash_complete(
3542 psa_sign_hash_interruptible_operation_t *operation,
3543 uint8_t *signature, size_t signature_size,
3544 size_t *signature_length)
3545{
3546 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3547
3548 *signature_length = 0;
3549
Paul Elliottc9774412023-02-06 15:14:07 +00003550 /* Check that start has been called first, and that operation has not
3551 * previously errored. */
3552 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003553 status = PSA_ERROR_BAD_STATE;
3554 goto exit;
3555 }
3556
Paul Elliott096abc42023-02-03 18:33:23 +00003557 /* Immediately reject a zero-length signature buffer. This guarantees that
3558 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003559 if (signature_size == 0) {
3560 status = PSA_ERROR_BUFFER_TOO_SMALL;
3561 goto exit;
3562 }
3563
3564 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3565 signature_size,
3566 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003567
Paul Elliott296ede92022-12-15 17:00:30 +00003568 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003569 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003570
Paul Elliottebe225c2023-02-10 14:32:53 +00003571exit:
3572
Paul Elliott59200a22023-02-21 15:07:40 +00003573 psa_wipe_tag_output_buffer(signature, status, signature_size,
3574 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003575
Paul Elliott53bb3122023-02-10 14:22:22 +00003576 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003577 if (status != PSA_SUCCESS) {
3578 operation->error_occurred = 1;
3579 }
3580
Paul Elliott59ad9452022-12-18 15:09:02 +00003581 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003582 }
3583
3584 return status;
3585}
3586
3587psa_status_t psa_sign_hash_abort(
3588 psa_sign_hash_interruptible_operation_t *operation)
3589{
Paul Elliott59ad9452022-12-18 15:09:02 +00003590 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3591
3592 status = psa_sign_hash_abort_internal(operation);
3593
3594 /* We clear the number of ops done here, so that it is not cleared when
3595 * the operation fails or succeeds, only on manual abort. */
3596 operation->num_ops = 0;
3597
Paul Elliottc9774412023-02-06 15:14:07 +00003598 /* Likewise, failure state. */
3599 operation->error_occurred = 0;
3600
Paul Elliott59ad9452022-12-18 15:09:02 +00003601 return status;
3602}
3603
3604static psa_status_t psa_verify_hash_abort_internal(
3605 psa_verify_hash_interruptible_operation_t *operation)
3606{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003607 if (operation->id == 0) {
3608 /* The object has (apparently) been initialized but it is not (yet)
3609 * in use. It's ok to call abort on such an object, and there's
3610 * nothing to do. */
3611 return PSA_SUCCESS;
3612 }
3613
Paul Elliott59ad9452022-12-18 15:09:02 +00003614 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3615
3616 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003617
3618 operation->id = 0;
3619
Paul Elliotte6145dc2023-02-07 12:51:21 +00003620 /* Do not clear either the error_occurred or num_ops elements here as they
3621 * only want to be cleared by the application calling abort, not by abort
3622 * being called at completion of an operation. */
3623
Paul Elliott59ad9452022-12-18 15:09:02 +00003624 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003625}
3626
3627psa_status_t psa_verify_hash_start(
3628 psa_verify_hash_interruptible_operation_t *operation,
3629 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3630 const uint8_t *hash, size_t hash_length,
3631 const uint8_t *signature, size_t signature_length)
3632{
3633 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3634 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3635 psa_key_slot_t *slot;
3636
Paul Elliottc9774412023-02-06 15:14:07 +00003637 /* Check that start has not been previously called, or operation has not
3638 * previously errored. */
3639 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003640 return PSA_ERROR_BAD_STATE;
3641 }
3642
3643 status = psa_sign_verify_check_alg(0, alg);
3644 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003645 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003646 return status;
3647 }
3648
3649 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3650 PSA_KEY_USAGE_VERIFY_HASH,
3651 alg);
3652
3653 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003654 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003655 return status;
3656 }
3657
3658 psa_key_attributes_t attributes = {
3659 .core = slot->attr
3660 };
3661
Paul Elliott296ede92022-12-15 17:00:30 +00003662 /* Ensure ops count gets reset, in case of operation re-use. */
3663 operation->num_ops = 0;
3664
Paul Elliott9fe12f62022-11-30 19:16:02 +00003665 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3666 slot->key.data,
3667 slot->key.bytes,
3668 alg, hash, hash_length,
3669 signature, signature_length);
3670
3671 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003672 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003673 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003674 }
3675
3676 unlock_status = psa_unlock_key_slot(slot);
3677
Paul Elliottc9774412023-02-06 15:14:07 +00003678 if (unlock_status != PSA_SUCCESS) {
3679 operation->error_occurred = 1;
3680 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003681
Paul Elliottc9774412023-02-06 15:14:07 +00003682 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003683}
3684
3685psa_status_t psa_verify_hash_complete(
3686 psa_verify_hash_interruptible_operation_t *operation)
3687{
3688 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3689
Paul Elliottc9774412023-02-06 15:14:07 +00003690 /* Check that start has been called first, and that operation has not
3691 * previously errored. */
3692 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003693 status = PSA_ERROR_BAD_STATE;
3694 goto exit;
3695 }
3696
3697 status = psa_driver_wrapper_verify_hash_complete(operation);
3698
Paul Elliott296ede92022-12-15 17:00:30 +00003699 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003700 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003701 operation);
3702
Paul Elliottebe225c2023-02-10 14:32:53 +00003703exit:
3704
Paul Elliott9fe12f62022-11-30 19:16:02 +00003705 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003706 if (status != PSA_SUCCESS) {
3707 operation->error_occurred = 1;
3708 }
3709
Paul Elliott59ad9452022-12-18 15:09:02 +00003710 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003711 }
3712
3713 return status;
3714}
3715
3716psa_status_t psa_verify_hash_abort(
3717 psa_verify_hash_interruptible_operation_t *operation)
3718{
Paul Elliott59ad9452022-12-18 15:09:02 +00003719 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003720
Paul Elliott59ad9452022-12-18 15:09:02 +00003721 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003722
Paul Elliott59ad9452022-12-18 15:09:02 +00003723 /* We clear the number of ops done here, so that it is not cleared when
3724 * the operation fails or succeeds, only on manual abort. */
3725 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003726
Paul Elliottc9774412023-02-06 15:14:07 +00003727 /* Likewise, failure state. */
3728 operation->error_occurred = 0;
3729
Paul Elliott59ad9452022-12-18 15:09:02 +00003730 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003731}
3732
Paul Elliott588f8ed2022-12-02 18:10:26 +00003733/****************************************************************/
3734/* Asymmetric interruptible cryptography internal */
3735/* implementations */
3736/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003737
Paul Elliott588f8ed2022-12-02 18:10:26 +00003738void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3739{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003740
Paul Elliott588f8ed2022-12-02 18:10:26 +00003741#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3742 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3743 defined(MBEDTLS_ECP_RESTARTABLE)
3744
3745 /* Internal implementation uses zero to indicate infinite number max ops,
3746 * therefore avoid this value, and set to minimum possible. */
3747 if (max_ops == 0) {
3748 max_ops = 1;
3749 }
3750
Paul Elliott588f8ed2022-12-02 18:10:26 +00003751 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003752#else
3753 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003754#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3755 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3756 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3757}
3758
Paul Elliott588f8ed2022-12-02 18:10:26 +00003759uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003760 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003761{
3762#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3763 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3764 defined(MBEDTLS_ECP_RESTARTABLE)
3765
Paul Elliott93d9ca82023-02-15 18:14:21 +00003766 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003767#else
3768 (void) operation;
3769 return 0;
3770#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3771 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3772 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3773}
3774
3775uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003776 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003777{
3778 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3779 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3780 defined(MBEDTLS_ECP_RESTARTABLE)
3781
Paul Elliott93d9ca82023-02-15 18:14:21 +00003782 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003783#else
3784 (void) operation;
3785 return 0;
3786#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3787 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3788 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3789}
3790
3791psa_status_t mbedtls_psa_sign_hash_start(
3792 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3793 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3794 size_t key_buffer_size, psa_algorithm_t alg,
3795 const uint8_t *hash, size_t hash_length)
3796{
3797 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003798 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003799
Paul Elliott068fe072023-01-16 13:59:15 +00003800 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3801 return PSA_ERROR_NOT_SUPPORTED;
3802 }
3803
3804 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003805 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003806 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003807
3808#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003809 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3810 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003811
Paul Elliotta1c94092023-02-15 16:38:04 +00003812 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3813
Paul Elliott93d9ca82023-02-15 18:14:21 +00003814 /* Ensure num_ops is zero'ed in case of context re-use. */
3815 operation->num_ops = 0;
3816
Paul Elliott068fe072023-01-16 13:59:15 +00003817 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3818 attributes->core.bits,
3819 key_buffer,
3820 key_buffer_size,
3821 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003822
Paul Elliott068fe072023-01-16 13:59:15 +00003823 if (status != PSA_SUCCESS) {
3824 return status;
3825 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003826
Paul Elliott1bc59df2023-02-05 13:41:57 +00003827 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003828 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003829
Paul Elliott068fe072023-01-16 13:59:15 +00003830 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003831 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003832 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003833
Paul Elliott0290a762023-02-09 14:30:24 +00003834 /* We only need to store the same length of hash as the private key size
3835 * here, it would be truncated by the internal implementation anyway. */
3836 required_hash_length = (hash_length < operation->coordinate_bytes ?
3837 hash_length : operation->coordinate_bytes);
3838
Paul Elliottba70ad42023-02-15 18:23:53 +00003839 if (required_hash_length > sizeof(operation->hash)) {
3840 /* Shouldn't happen, but better safe than sorry. */
3841 return PSA_ERROR_CORRUPTION_DETECTED;
3842 }
3843
Paul Elliott0290a762023-02-09 14:30:24 +00003844 memcpy(operation->hash, hash, required_hash_length);
3845 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003846
3847 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003848
3849#else
Paul Elliott068fe072023-01-16 13:59:15 +00003850 (void) operation;
3851 (void) key_buffer;
3852 (void) key_buffer_size;
3853 (void) alg;
3854 (void) hash;
3855 (void) hash_length;
3856 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003857 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003858
Paul Elliott068fe072023-01-16 13:59:15 +00003859 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003860#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3861 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3862 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003863}
3864
3865psa_status_t mbedtls_psa_sign_hash_complete(
3866 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3867 uint8_t *signature, size_t signature_size,
3868 size_t *signature_length)
3869{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003870#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3871 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3872 defined(MBEDTLS_ECP_RESTARTABLE)
3873
Paul Elliotta1c94092023-02-15 16:38:04 +00003874 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003875 mbedtls_mpi r;
3876 mbedtls_mpi s;
3877
Paul Elliott46845252023-02-03 14:59:11 +00003878 mbedtls_mpi_init(&r);
3879 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003880
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003881 /* Ensure max_ops is set to the current value (or default). */
3882 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3883
Paul Elliotta1c94092023-02-15 16:38:04 +00003884 if (signature_size < 2 * operation->coordinate_bytes) {
3885 status = PSA_ERROR_BUFFER_TOO_SMALL;
3886 goto exit;
3887 }
3888
Paul Elliott588f8ed2022-12-02 18:10:26 +00003889 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003890
Paul Elliott588f8ed2022-12-02 18:10:26 +00003891#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3892 status = mbedtls_to_psa_error(
3893 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003894 &r,
3895 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003896 &operation->ctx->d,
3897 operation->hash,
3898 operation->hash_length,
3899 operation->md_alg,
3900 mbedtls_psa_get_random,
3901 MBEDTLS_PSA_RANDOM_STATE,
3902 &operation->restart_ctx));
3903#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003904 status = PSA_ERROR_NOT_SUPPORTED;
3905 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003906#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3907 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003908 status = mbedtls_to_psa_error(
3909 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003910 &r,
3911 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003912 &operation->ctx->d,
3913 operation->hash,
3914 operation->hash_length,
3915 mbedtls_psa_get_random,
3916 MBEDTLS_PSA_RANDOM_STATE,
3917 mbedtls_psa_get_random,
3918 MBEDTLS_PSA_RANDOM_STATE,
3919 &operation->restart_ctx));
3920 }
3921
Paul Elliottf8e5b562023-02-19 18:43:45 +00003922 /* Hide the fact that the restart context only holds a delta of number of
3923 * ops done during the last operation, not an absolute value. */
3924 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3925
Paul Elliott724bd252023-02-08 12:35:08 +00003926 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003927 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003928 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003929 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003930 operation->coordinate_bytes)
3931 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003932
3933 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003934 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003935 }
3936
3937 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003938 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003939 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003940 operation->coordinate_bytes,
3941 operation->coordinate_bytes)
3942 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003943
3944 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003945 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003946 }
3947
Paul Elliott1bc59df2023-02-05 13:41:57 +00003948 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003949
Paul Elliott724bd252023-02-08 12:35:08 +00003950 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003951 }
Paul Elliott724bd252023-02-08 12:35:08 +00003952
3953exit:
3954
3955 mbedtls_mpi_free(&r);
3956 mbedtls_mpi_free(&s);
3957 return status;
3958
Paul Elliott588f8ed2022-12-02 18:10:26 +00003959 #else
3960
3961 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003962 (void) signature;
3963 (void) signature_size;
3964 (void) signature_length;
3965
3966 return PSA_ERROR_NOT_SUPPORTED;
3967
3968#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3969 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3970 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3971}
3972
3973psa_status_t mbedtls_psa_sign_hash_abort(
3974 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3975{
3976
3977#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3978 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3979 defined(MBEDTLS_ECP_RESTARTABLE)
3980
3981 if (operation->ctx) {
3982 mbedtls_ecdsa_free(operation->ctx);
3983 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003984 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003985 }
3986
3987 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3988
Paul Elliott93d9ca82023-02-15 18:14:21 +00003989 operation->num_ops = 0;
3990
Paul Elliott588f8ed2022-12-02 18:10:26 +00003991 return PSA_SUCCESS;
3992
3993#else
3994
3995 (void) operation;
3996
3997 return PSA_ERROR_NOT_SUPPORTED;
3998
3999#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4000 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4001 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4002}
4003
4004psa_status_t mbedtls_psa_verify_hash_start(
4005 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4006 const psa_key_attributes_t *attributes,
4007 const uint8_t *key_buffer, size_t key_buffer_size,
4008 psa_algorithm_t alg,
4009 const uint8_t *hash, size_t hash_length,
4010 const uint8_t *signature, size_t signature_length)
4011{
4012 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004013 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004014 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004015
Paul Elliott068fe072023-01-16 13:59:15 +00004016 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4017 return PSA_ERROR_NOT_SUPPORTED;
4018 }
4019
4020 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004021 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004022 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004023
4024#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004025 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4026 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004027
Paul Elliotta1c94092023-02-15 16:38:04 +00004028 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4029 mbedtls_mpi_init(&operation->r);
4030 mbedtls_mpi_init(&operation->s);
4031
Paul Elliott93d9ca82023-02-15 18:14:21 +00004032 /* Ensure num_ops is zero'ed in case of context re-use. */
4033 operation->num_ops = 0;
4034
Paul Elliott068fe072023-01-16 13:59:15 +00004035 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4036 attributes->core.bits,
4037 key_buffer,
4038 key_buffer_size,
4039 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004040
Paul Elliott068fe072023-01-16 13:59:15 +00004041 if (status != PSA_SUCCESS) {
4042 return status;
4043 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004044
Paul Elliottc569fc22023-02-10 13:02:54 +00004045 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004046
Paul Elliott1bc59df2023-02-05 13:41:57 +00004047 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004048 return PSA_ERROR_INVALID_SIGNATURE;
4049 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004050
Paul Elliott068fe072023-01-16 13:59:15 +00004051 status = mbedtls_to_psa_error(
4052 mbedtls_mpi_read_binary(&operation->r,
4053 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004054 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004055
Paul Elliott068fe072023-01-16 13:59:15 +00004056 if (status != PSA_SUCCESS) {
4057 return status;
4058 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004059
Paul Elliott068fe072023-01-16 13:59:15 +00004060 status = mbedtls_to_psa_error(
4061 mbedtls_mpi_read_binary(&operation->s,
4062 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004063 coordinate_bytes,
4064 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004065
Paul Elliott068fe072023-01-16 13:59:15 +00004066 if (status != PSA_SUCCESS) {
4067 return status;
4068 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004069
Paul Elliott2c9843f2023-02-15 17:32:42 +00004070 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004071
Paul Elliott2c9843f2023-02-15 17:32:42 +00004072 if (status != PSA_SUCCESS) {
4073 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004074 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004075
Paul Elliott0290a762023-02-09 14:30:24 +00004076 /* We only need to store the same length of hash as the private key size
4077 * here, it would be truncated by the internal implementation anyway. */
4078 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4079 coordinate_bytes);
4080
Paul Elliottba70ad42023-02-15 18:23:53 +00004081 if (required_hash_length > sizeof(operation->hash)) {
4082 /* Shouldn't happen, but better safe than sorry. */
4083 return PSA_ERROR_CORRUPTION_DETECTED;
4084 }
4085
Paul Elliott0290a762023-02-09 14:30:24 +00004086 memcpy(operation->hash, hash, required_hash_length);
4087 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004088
4089 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004090#else
Paul Elliott068fe072023-01-16 13:59:15 +00004091 (void) operation;
4092 (void) key_buffer;
4093 (void) key_buffer_size;
4094 (void) alg;
4095 (void) hash;
4096 (void) hash_length;
4097 (void) signature;
4098 (void) signature_length;
4099 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004100 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004101 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004102
Paul Elliott068fe072023-01-16 13:59:15 +00004103 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004104#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4105 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4106 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004107}
4108
4109psa_status_t mbedtls_psa_verify_hash_complete(
4110 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4111{
4112
4113#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4114 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4115 defined(MBEDTLS_ECP_RESTARTABLE)
4116
Paul Elliottf8e5b562023-02-19 18:43:45 +00004117 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4118
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004119 /* Ensure max_ops is set to the current value (or default). */
4120 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4121
Paul Elliottf8e5b562023-02-19 18:43:45 +00004122 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004123 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4124 operation->hash,
4125 operation->hash_length,
4126 &operation->ctx->Q,
4127 &operation->r,
4128 &operation->s,
4129 &operation->restart_ctx));
4130
Paul Elliottf8e5b562023-02-19 18:43:45 +00004131 /* Hide the fact that the restart context only holds a delta of number of
4132 * ops done during the last operation, not an absolute value. */
4133 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4134
4135 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004136#else
4137 (void) operation;
4138
4139 return PSA_ERROR_NOT_SUPPORTED;
4140
4141#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4142 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4143 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4144}
4145
4146psa_status_t mbedtls_psa_verify_hash_abort(
4147 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4148{
4149
4150#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4151 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4152 defined(MBEDTLS_ECP_RESTARTABLE)
4153
4154 if (operation->ctx) {
4155 mbedtls_ecdsa_free(operation->ctx);
4156 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004157 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004158 }
4159
4160 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4161
Paul Elliott93d9ca82023-02-15 18:14:21 +00004162 operation->num_ops = 0;
4163
Paul Elliott588f8ed2022-12-02 18:10:26 +00004164 mbedtls_mpi_free(&operation->r);
4165 mbedtls_mpi_free(&operation->s);
4166
4167 return PSA_SUCCESS;
4168
4169#else
4170 (void) operation;
4171
4172 return PSA_ERROR_NOT_SUPPORTED;
4173
4174#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4175 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4176 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4177}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004178
mohammad1603503973b2018-03-12 15:59:30 +02004179/****************************************************************/
4180/* Symmetric cryptography */
4181/****************************************************************/
4182
Gilles Peskine449bd832023-01-11 14:50:10 +01004183static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4184 mbedtls_svc_key_id_t key,
4185 psa_algorithm_t alg,
4186 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004187{
4188 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4189 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004190 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4192 PSA_KEY_USAGE_ENCRYPT :
4193 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004194 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004195
4196 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004198 status = PSA_ERROR_BAD_STATE;
4199 goto exit;
4200 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004201
Gilles Peskine449bd832023-01-11 14:50:10 +01004202 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004203 status = PSA_ERROR_INVALID_ARGUMENT;
4204 goto exit;
4205 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4208 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004209 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004211
Ronald Cron49fafa92021-03-10 08:34:23 +01004212 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004213 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004214 * so we only set it (in the driver wrapper) after resources have been
4215 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004216 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004218 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004220 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 }
4222 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004223
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004224 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004226 };
4227
Ronald Cronab99ac22020-10-01 16:38:28 +02004228 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 if (cipher_operation == MBEDTLS_ENCRYPT) {
4230 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4231 &attributes,
4232 slot->key.data,
4233 slot->key.bytes,
4234 alg);
4235 } else {
4236 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4237 &attributes,
4238 slot->key.data,
4239 slot->key.bytes,
4240 alg);
4241 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004242
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004243exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 if (status != PSA_SUCCESS) {
4245 psa_cipher_abort(operation);
4246 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004247
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004249
Gilles Peskine449bd832023-01-11 14:50:10 +01004250 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004251}
4252
Gilles Peskine449bd832023-01-11 14:50:10 +01004253psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4254 mbedtls_svc_key_id_t key,
4255 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004256{
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004258}
4259
Gilles Peskine449bd832023-01-11 14:50:10 +01004260psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4261 mbedtls_svc_key_id_t key,
4262 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004263{
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004265}
4266
Gilles Peskine449bd832023-01-11 14:50:10 +01004267psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4268 uint8_t *iv,
4269 size_t iv_size,
4270 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004271{
Ronald Cron6d051732020-10-01 14:10:20 +02004272 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004273 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004274 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004275
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004277 status = PSA_ERROR_BAD_STATE;
4278 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004279 }
4280
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004282 status = PSA_ERROR_BAD_STATE;
4283 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004284 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004285
Ronald Cron2fb90522021-07-05 12:31:44 +02004286 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004288 status = PSA_ERROR_BUFFER_TOO_SMALL;
4289 goto exit;
4290 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004291
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004293 status = PSA_ERROR_GENERIC_ERROR;
4294 goto exit;
4295 }
4296
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 status = psa_generate_random(local_iv, default_iv_length);
4298 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004299 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 }
Ronald Cron5618a392021-03-26 09:52:26 +01004301
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 status = psa_driver_wrapper_cipher_set_iv(operation,
4303 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004304
4305exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 if (status == PSA_SUCCESS) {
4307 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004308 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004309 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004311 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004313 }
Ronald Cron6d051732020-10-01 14:10:20 +02004314
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004316}
4317
Gilles Peskine449bd832023-01-11 14:50:10 +01004318psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4319 const uint8_t *iv,
4320 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004321{
Ronald Cron6d051732020-10-01 14:10:20 +02004322 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004323
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004325 status = PSA_ERROR_BAD_STATE;
4326 goto exit;
4327 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004328
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004330 status = PSA_ERROR_BAD_STATE;
4331 goto exit;
4332 }
Ronald Crona0d68172021-03-26 10:15:08 +01004333
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004335 status = PSA_ERROR_INVALID_ARGUMENT;
4336 goto exit;
4337 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004338
Gilles Peskine449bd832023-01-11 14:50:10 +01004339 status = psa_driver_wrapper_cipher_set_iv(operation,
4340 iv,
4341 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004342
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004343exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004345 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 } else {
4347 psa_cipher_abort(operation);
4348 }
4349 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004350}
4351
Gilles Peskine449bd832023-01-11 14:50:10 +01004352psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4353 const uint8_t *input,
4354 size_t input_length,
4355 uint8_t *output,
4356 size_t output_size,
4357 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004358{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004359 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004360
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004362 status = PSA_ERROR_BAD_STATE;
4363 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004364 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004365
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004367 status = PSA_ERROR_BAD_STATE;
4368 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004369 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004370
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 status = psa_driver_wrapper_cipher_update(operation,
4372 input,
4373 input_length,
4374 output,
4375 output_size,
4376 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004377
4378exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 if (status != PSA_SUCCESS) {
4380 psa_cipher_abort(operation);
4381 }
Ronald Cron6d051732020-10-01 14:10:20 +02004382
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004384}
4385
Gilles Peskine449bd832023-01-11 14:50:10 +01004386psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4387 uint8_t *output,
4388 size_t output_size,
4389 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004390{
David Saadab4ecc272019-02-14 13:48:10 +02004391 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004392
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004394 status = PSA_ERROR_BAD_STATE;
4395 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004396 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004397
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004399 status = PSA_ERROR_BAD_STATE;
4400 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004401 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004402
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 status = psa_driver_wrapper_cipher_finish(operation,
4404 output,
4405 output_size,
4406 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004407
4408exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 if (status == PSA_SUCCESS) {
4410 return psa_cipher_abort(operation);
4411 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004412 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004414
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004416 }
mohammad1603503973b2018-03-12 15:59:30 +02004417}
4418
Gilles Peskine449bd832023-01-11 14:50:10 +01004419psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004420{
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004422 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004423 * in use. It's ok to call abort on such an object, and there's
4424 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004426 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004427
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004429
Ronald Cron49fafa92021-03-10 08:34:23 +01004430 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004431 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004432 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004433
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004435}
4436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4438 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004439 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004441 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 size_t output_size,
4443 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004444{
4445 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004446 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004447 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004448 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4449 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004450 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004451
David Horstmann36df4b22023-12-13 15:55:25 +00004452 LOCAL_INPUT_DECLARE(input_external);
4453 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4454 LOCAL_OUTPUT_DECLARE(output_external);
4455 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004456
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004458 status = PSA_ERROR_INVALID_ARGUMENT;
4459 goto exit;
4460 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004461
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4463 PSA_KEY_USAGE_ENCRYPT,
4464 alg);
4465 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004466 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004468
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004469 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004471 };
4472
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4474 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004475 status = PSA_ERROR_GENERIC_ERROR;
4476 goto exit;
4477 }
4478
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 if (default_iv_length > 0) {
4480 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004481 status = PSA_ERROR_BUFFER_TOO_SMALL;
4482 goto exit;
4483 }
4484
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 status = psa_generate_random(local_iv, default_iv_length);
4486 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004487 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004489 }
4490
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004491 status = psa_driver_wrapper_cipher_encrypt(
4492 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004493 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004494 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004496
4497exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 unlock_status = psa_unlock_key_slot(slot);
4499 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004500 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004501 }
Ronald Cron23919522021-07-08 19:00:07 +02004502
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 if (status == PSA_SUCCESS) {
4504 if (default_iv_length > 0) {
4505 memcpy(output, local_iv, default_iv_length);
4506 }
4507 *output_length += default_iv_length;
4508 } else {
4509 *output_length = 0;
4510 }
4511
David Horstmann36df4b22023-12-13 15:55:25 +00004512 LOCAL_INPUT_FREE(input, input_external);
4513 LOCAL_OUTPUT_FREE(output, output_external);
David Horstmannc6977b42023-11-27 17:43:05 +00004514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004516}
4517
Gilles Peskine449bd832023-01-11 14:50:10 +01004518psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4519 psa_algorithm_t alg,
4520 const uint8_t *input,
4521 size_t input_length,
4522 uint8_t *output,
4523 size_t output_size,
4524 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004525{
4526 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004527 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004528 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004529 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004532 status = PSA_ERROR_INVALID_ARGUMENT;
4533 goto exit;
4534 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004535
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4537 PSA_KEY_USAGE_DECRYPT,
4538 alg);
4539 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004540 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004542
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004543 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004545 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4548 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004549 status = PSA_ERROR_INVALID_ARGUMENT;
4550 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004552 status = PSA_ERROR_INVALID_ARGUMENT;
4553 goto exit;
4554 }
4555
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004556 status = psa_driver_wrapper_cipher_decrypt(
4557 &attributes, slot->key.data, slot->key.bytes,
4558 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004560
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004561exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 unlock_status = psa_unlock_key_slot(slot);
4563 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004564 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004566
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004568 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 }
Ronald Cron23919522021-07-08 19:00:07 +02004570
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004572}
4573
4574
mohammad16035955c982018-04-26 00:53:03 +03004575/****************************************************************/
4576/* AEAD */
4577/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004578
Paul Elliottbaff51c2021-09-28 17:44:45 +01004579/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004580static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004581{
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004583}
4584
4585/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004586static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4587 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004588{
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004590
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004592#if defined(PSA_WANT_ALG_GCM)
4593 case PSA_ALG_GCM:
4594 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 * arbitrarily large nonces. Please note that we do not generally
4596 * recommend the usage of nonces of greater length than
4597 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4598 * size, which can then lead to collisions if you encrypt a very
4599 * large number of messages.*/
4600 if (nonce_length != 0) {
4601 return PSA_SUCCESS;
4602 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004603 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004604#endif /* PSA_WANT_ALG_GCM */
4605#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004606 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 if (nonce_length >= 7 && nonce_length <= 13) {
4608 return PSA_SUCCESS;
4609 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004610 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004611#endif /* PSA_WANT_ALG_CCM */
4612#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004613 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 if (nonce_length == 12) {
4615 return PSA_SUCCESS;
4616 } else if (nonce_length == 8) {
4617 return PSA_ERROR_NOT_SUPPORTED;
4618 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004619 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004620#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004621 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004622 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004624 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004625
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004627}
4628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004630{
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4632 return PSA_ERROR_INVALID_ARGUMENT;
4633 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004634
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004636}
4637
Gilles Peskine449bd832023-01-11 14:50:10 +01004638psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4639 psa_algorithm_t alg,
4640 const uint8_t *nonce,
4641 size_t nonce_length,
4642 const uint8_t *additional_data,
4643 size_t additional_data_length,
4644 const uint8_t *plaintext,
4645 size_t plaintext_length,
4646 uint8_t *ciphertext,
4647 size_t ciphertext_size,
4648 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004649{
Ronald Cron215633c2021-03-16 17:15:37 +01004650 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4651 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004652
mohammad1603f08a5502018-06-03 15:05:47 +03004653 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004654
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 status = psa_aead_check_algorithm(alg);
4656 if (status != PSA_SUCCESS) {
4657 return status;
4658 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004659
Ronald Cron9a986162021-03-26 12:40:07 +01004660 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4662 if (status != PSA_SUCCESS) {
4663 return status;
4664 }
mohammad16035955c982018-04-26 00:53:03 +03004665
Ronald Cron215633c2021-03-16 17:15:37 +01004666 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004668 };
mohammad16035955c982018-04-26 00:53:03 +03004669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 status = psa_aead_check_nonce_length(alg, nonce_length);
4671 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004672 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004674
Ronald Cronde822812021-03-17 16:08:20 +01004675 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004676 &attributes, slot->key.data, slot->key.bytes,
4677 alg,
4678 nonce, nonce_length,
4679 additional_data, additional_data_length,
4680 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004682
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4684 memset(ciphertext, 0, ciphertext_size);
4685 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004686
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004687exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004689
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004691}
4692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4694 psa_algorithm_t alg,
4695 const uint8_t *nonce,
4696 size_t nonce_length,
4697 const uint8_t *additional_data,
4698 size_t additional_data_length,
4699 const uint8_t *ciphertext,
4700 size_t ciphertext_length,
4701 uint8_t *plaintext,
4702 size_t plaintext_size,
4703 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004704{
Ronald Cron215633c2021-03-16 17:15:37 +01004705 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4706 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004707
Gilles Peskineee652a32018-06-01 19:23:52 +02004708 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004709
Gilles Peskine449bd832023-01-11 14:50:10 +01004710 status = psa_aead_check_algorithm(alg);
4711 if (status != PSA_SUCCESS) {
4712 return status;
4713 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004714
Ronald Cron9a986162021-03-26 12:40:07 +01004715 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4717 if (status != PSA_SUCCESS) {
4718 return status;
4719 }
mohammad16035955c982018-04-26 00:53:03 +03004720
Ronald Cron215633c2021-03-16 17:15:37 +01004721 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004723 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004724
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 status = psa_aead_check_nonce_length(alg, nonce_length);
4726 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004727 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004729
Ronald Cronde822812021-03-17 16:08:20 +01004730 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004731 &attributes, slot->key.data, slot->key.bytes,
4732 alg,
4733 nonce, nonce_length,
4734 additional_data, additional_data_length,
4735 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004737
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 if (status != PSA_SUCCESS && plaintext_size != 0) {
4739 memset(plaintext, 0, plaintext_size);
4740 }
mohammad160360a64d02018-06-03 17:20:42 +03004741
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004742exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004744
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 return status;
mohammad16035955c982018-04-26 00:53:03 +03004746}
4747
Gilles Peskine449bd832023-01-11 14:50:10 +01004748static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4749{
4750 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004751
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004753#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004755 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4757 return PSA_ERROR_INVALID_ARGUMENT;
4758 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004759 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004760#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004761
Przemek Stekiel86679c72022-10-06 17:06:56 +02004762#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004764 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4766 return PSA_ERROR_INVALID_ARGUMENT;
4767 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004768 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004769#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004770
Przemek Stekiel86679c72022-10-06 17:06:56 +02004771#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004773 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 if (tag_len != 16) {
4775 return PSA_ERROR_INVALID_ARGUMENT;
4776 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004777 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004778#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004779
4780 default:
4781 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004783 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004785}
4786
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004787/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004788static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4789 int is_encrypt,
4790 mbedtls_svc_key_id_t key,
4791 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004792{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004793 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4794 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4795 psa_key_slot_t *slot = NULL;
4796 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004797 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004798
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 status = psa_aead_check_algorithm(alg);
4800 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004801 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004803
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004805 status = PSA_ERROR_BAD_STATE;
4806 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004807 }
4808
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 if (operation->nonce_set || operation->lengths_set ||
4810 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004811 status = PSA_ERROR_BAD_STATE;
4812 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004813 }
4814
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004816 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004818 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004820
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4822 alg);
4823 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004824 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004826
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004827 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004828 .core = slot->attr
4829 };
4830
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004832 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004834
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 if (is_encrypt) {
4836 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4837 &attributes,
4838 slot->key.data,
4839 slot->key.bytes,
4840 alg);
4841 } else {
4842 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4843 &attributes,
4844 slot->key.data,
4845 slot->key.bytes,
4846 alg);
4847 }
4848 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004849 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004851
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004853
4854exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004856
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004858 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004860 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 } else {
4862 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004863 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004864
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004866}
4867
Paul Elliott302ff6b2021-04-20 18:10:30 +01004868/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004869psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4870 mbedtls_svc_key_id_t key,
4871 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004872{
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004874}
4875
4876/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004877psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4878 mbedtls_svc_key_id_t key,
4879 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004880{
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004882}
4883
4884/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004885psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4886 uint8_t *nonce,
4887 size_t nonce_size,
4888 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004889{
4890 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004891 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004892 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004893
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004894 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004897 status = PSA_ERROR_BAD_STATE;
4898 goto exit;
4899 }
4900
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004902 status = PSA_ERROR_BAD_STATE;
4903 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004904 }
4905
Paul Elliotte193ea82021-10-01 13:00:16 +01004906 /* For CCM, this size may not be correct according to the PSA
4907 * specification. The PSA Crypto 1.0.1 specification states:
4908 *
4909 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4910 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4911 *
4912 * However this restriction that L has to be the smallest integer is not
4913 * applied in practice, and it is not implementable here since the
4914 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4916 operation->alg);
4917 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004918 status = PSA_ERROR_BUFFER_TOO_SMALL;
4919 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004920 }
4921
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 status = psa_generate_random(local_nonce, required_nonce_size);
4923 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004924 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004926
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004928
Paul Elliott39dc6b82021-05-11 19:16:09 +01004929exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 if (status == PSA_SUCCESS) {
4931 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004932 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 } else {
4934 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004935 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004936
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004938}
4939
4940/* Set the nonce for a multipart authenticated encryption or decryption
4941 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004942psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4943 const uint8_t *nonce,
4944 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004945{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004946 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4947
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004949 status = PSA_ERROR_BAD_STATE;
4950 goto exit;
4951 }
4952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004954 status = PSA_ERROR_BAD_STATE;
4955 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004956 }
4957
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4959 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004960 status = PSA_ERROR_INVALID_ARGUMENT;
4961 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004962 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004963
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4965 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004966
Paul Elliott39dc6b82021-05-11 19:16:09 +01004967exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004969 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 } else {
4971 psa_aead_abort(operation);
4972 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004973
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004975}
4976
4977/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004978psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4979 size_t ad_length,
4980 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004981{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004982 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4983
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004985 status = PSA_ERROR_BAD_STATE;
4986 goto exit;
4987 }
4988
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 if (operation->lengths_set || operation->ad_started ||
4990 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004991 status = PSA_ERROR_BAD_STATE;
4992 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004993 }
4994
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004996#if defined(PSA_WANT_ALG_GCM)
4997 case PSA_ALG_GCM:
4998 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 * bits. Without the guard this code will generate warnings on 32bit
5000 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005001#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 if (((uint64_t) ad_length) >> 61 != 0 ||
5003 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005004 status = PSA_ERROR_INVALID_ARGUMENT;
5005 goto exit;
5006 }
Paul Elliott325d3742021-09-27 17:56:28 +01005007#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005008 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005009#endif /* PSA_WANT_ALG_GCM */
5010#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005011 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005012 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005013 status = PSA_ERROR_INVALID_ARGUMENT;
5014 goto exit;
5015 }
5016 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005017#endif /* PSA_WANT_ALG_CCM */
5018#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005019 case PSA_ALG_CHACHA20_POLY1305:
5020 /* No length restrictions for ChaChaPoly. */
5021 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005022#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005023 default:
5024 break;
5025 }
Paul Elliott325d3742021-09-27 17:56:28 +01005026
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5028 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005029
Paul Elliott39dc6b82021-05-11 19:16:09 +01005030exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005032 operation->ad_remaining = ad_length;
5033 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005034 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 } else {
5036 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005037 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005038
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005040}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005041
5042/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005043psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5044 const uint8_t *input,
5045 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005046{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005047 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5048
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005050 status = PSA_ERROR_BAD_STATE;
5051 goto exit;
5052 }
5053
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005055 status = PSA_ERROR_BAD_STATE;
5056 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005057 }
5058
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 if (operation->lengths_set) {
5060 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005061 status = PSA_ERROR_INVALID_ARGUMENT;
5062 goto exit;
5063 }
5064
5065 operation->ad_remaining -= input_length;
5066 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005067#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005069 status = PSA_ERROR_BAD_STATE;
5070 goto exit;
5071 }
5072#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005073
Gilles Peskine449bd832023-01-11 14:50:10 +01005074 status = psa_driver_wrapper_aead_update_ad(operation, input,
5075 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005076
Paul Elliott39dc6b82021-05-11 19:16:09 +01005077exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005079 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 } else {
5081 psa_aead_abort(operation);
5082 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005083
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005085}
5086
5087/* Encrypt or decrypt a message fragment in an active multipart AEAD
5088 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005089psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5090 const uint8_t *input,
5091 size_t input_length,
5092 uint8_t *output,
5093 size_t output_size,
5094 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005095{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005096 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005097
5098 *output_length = 0;
5099
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005101 status = PSA_ERROR_BAD_STATE;
5102 goto exit;
5103 }
5104
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005106 status = PSA_ERROR_BAD_STATE;
5107 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005108 }
5109
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005111 /* Additional data length was supplied, but not all the additional
5112 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005114 status = PSA_ERROR_INVALID_ARGUMENT;
5115 goto exit;
5116 }
5117
5118 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005120 status = PSA_ERROR_INVALID_ARGUMENT;
5121 goto exit;
5122 }
5123
5124 operation->body_remaining -= input_length;
5125 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005126#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005128 status = PSA_ERROR_BAD_STATE;
5129 goto exit;
5130 }
5131#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005132
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5134 output, output_size,
5135 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005136
Paul Elliott39dc6b82021-05-11 19:16:09 +01005137exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005139 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 } else {
5141 psa_aead_abort(operation);
5142 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005143
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005145}
5146
Gilles Peskine449bd832023-01-11 14:50:10 +01005147static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005148{
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 if (operation->id == 0 || !operation->nonce_set) {
5150 return PSA_ERROR_BAD_STATE;
5151 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005152
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5154 operation->body_remaining != 0)) {
5155 return PSA_ERROR_INVALID_ARGUMENT;
5156 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005157
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005159}
5160
Paul Elliott302ff6b2021-04-20 18:10:30 +01005161/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005162psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5163 uint8_t *ciphertext,
5164 size_t ciphertext_size,
5165 size_t *ciphertext_length,
5166 uint8_t *tag,
5167 size_t tag_size,
5168 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005169{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005170 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5171
Paul Elliott302ff6b2021-04-20 18:10:30 +01005172 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005173 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005174
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 status = psa_aead_final_checks(operation);
5176 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005177 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005179
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005181 status = PSA_ERROR_BAD_STATE;
5182 goto exit;
5183 }
5184
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5186 ciphertext_size,
5187 ciphertext_length,
5188 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005189
Paul Elliott39dc6b82021-05-11 19:16:09 +01005190exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005191
5192
Paul Elliottf47b0952021-05-21 18:02:33 +01005193 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005194 * the zero tag size, make sure the tag is set to something implausible.
5195 * Even if the operation succeeds, make sure we clear the rest of the
5196 * buffer to prevent potential leakage of anything previously placed in
5197 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005198 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005199
Gilles Peskine449bd832023-01-11 14:50:10 +01005200 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005201
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005203}
5204
5205/* Finish authenticating and decrypting a message in a multipart AEAD
5206 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005207psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5208 uint8_t *plaintext,
5209 size_t plaintext_size,
5210 size_t *plaintext_length,
5211 const uint8_t *tag,
5212 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005213{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005214 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5215
Paul Elliott302ff6b2021-04-20 18:10:30 +01005216 *plaintext_length = 0;
5217
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 status = psa_aead_final_checks(operation);
5219 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005220 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005222
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005224 status = PSA_ERROR_BAD_STATE;
5225 goto exit;
5226 }
5227
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5229 plaintext_size,
5230 plaintext_length,
5231 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005232
5233exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005235
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005237}
5238
5239/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005240psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005241{
5242 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5243
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005245 /* The object has (apparently) been initialized but it is not (yet)
5246 * in use. It's ok to call abort on such an object, and there's
5247 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005249 }
5250
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005252
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005254
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005256}
5257
Gilles Peskinee59236f2018-01-27 23:32:46 +01005258/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005259/* Generators */
5260/****************************************************************/
5261
Przemek Stekiel69c46792022-06-10 12:59:51 +02005262#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005263 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005264 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305265 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305266 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005267#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005268#endif /* At least one builtin KDF */
5269
Przemek Stekiel69c46792022-06-10 12:59:51 +02005270#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005271 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5272 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5273static psa_status_t psa_key_derivation_start_hmac(
5274 psa_mac_operation_t *operation,
5275 psa_algorithm_t hash_alg,
5276 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005277 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005278{
5279 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5280 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5282 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5283 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005284
Steven Cooreman72f736a2021-05-07 14:14:37 +02005285 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005287
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 status = psa_driver_wrapper_mac_sign_setup(operation,
5289 &attributes,
5290 hmac_key, hmac_key_length,
5291 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005292
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 psa_reset_key_attributes(&attributes);
5294 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005295}
5296#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005297
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005298#define HKDF_STATE_INIT 0 /* no input yet */
5299#define HKDF_STATE_STARTED 1 /* got salt */
5300#define HKDF_STATE_KEYED 2 /* got key */
5301#define HKDF_STATE_OUTPUT 3 /* output started */
5302
Gilles Peskinecbe66502019-05-16 16:59:18 +02005303static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005305{
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5307 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5308 } else {
5309 return operation->alg;
5310 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005311}
5312
Gilles Peskine449bd832023-01-11 14:50:10 +01005313psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005314{
5315 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5317 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005318 /* The object has (apparently) been initialized but it is not
5319 * in use. It's ok to call abort on such an object, and there's
5320 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005322#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5324 mbedtls_free(operation->ctx.hkdf.info);
5325 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5326 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005327#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005328#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5329 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5331 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5332 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5333 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005334 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005336 }
5337
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005339 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005341 }
5342
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005344 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005346 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005347#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005349 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005351 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005352#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005353 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005354
5355 /* We leave the fields Ai and output_block to be erased safely by the
5356 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005358#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5359 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005360#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5362 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5363 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5364 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005365#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305366#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305367 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305368 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005369 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305370 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305371 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305372
5373 status = PSA_SUCCESS;
5374 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305375#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005376 {
5377 status = PSA_ERROR_BAD_STATE;
5378 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 mbedtls_platform_zeroize(operation, sizeof(*operation));
5380 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005381}
5382
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005383psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005385{
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005387 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005389 }
5390
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005391 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005393}
5394
Gilles Peskine449bd832023-01-11 14:50:10 +01005395psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5396 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005397{
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 if (operation->alg == 0) {
5399 return PSA_ERROR_BAD_STATE;
5400 }
5401 if (capacity > operation->capacity) {
5402 return PSA_ERROR_INVALID_ARGUMENT;
5403 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005404 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005406}
5407
Przemek Stekiel69c46792022-06-10 12:59:51 +02005408#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005409/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005410static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5411 psa_algorithm_t kdf_alg,
5412 uint8_t *output,
5413 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005414{
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5416 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005417 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005418 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005419#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005421#else
5422 const uint8_t last_block = 0xff;
5423#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005424
Gilles Peskine449bd832023-01-11 14:50:10 +01005425 if (hkdf->state < HKDF_STATE_KEYED ||
5426 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005427#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005429#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 )) {
5431 return PSA_ERROR_BAD_STATE;
5432 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005433 hkdf->state = HKDF_STATE_OUTPUT;
5434
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005436 /* Copy what remains of the current block */
5437 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005439 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 }
5441 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005442 output += n;
5443 output_length -= n;
5444 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005446 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005447 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005448 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005449 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005450 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005451 * object was corrupted or if this function is called directly
5452 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 if (hkdf->block_number == last_block) {
5454 return PSA_ERROR_BAD_STATE;
5455 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005456
5457 /* We need a new block */
5458 ++hkdf->block_number;
5459 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005460
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5462 hash_alg,
5463 hkdf->prk,
5464 hash_length);
5465 if (status != PSA_SUCCESS) {
5466 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005467 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005468
5469 if (hkdf->block_number != 1) {
5470 status = psa_mac_update(&hkdf->hmac,
5471 hkdf->output_block,
5472 hash_length);
5473 if (status != PSA_SUCCESS) {
5474 return status;
5475 }
5476 }
5477 status = psa_mac_update(&hkdf->hmac,
5478 hkdf->info,
5479 hkdf->info_length);
5480 if (status != PSA_SUCCESS) {
5481 return status;
5482 }
5483 status = psa_mac_update(&hkdf->hmac,
5484 &hkdf->block_number, 1);
5485 if (status != PSA_SUCCESS) {
5486 return status;
5487 }
5488 status = psa_mac_sign_finish(&hkdf->hmac,
5489 hkdf->output_block,
5490 sizeof(hkdf->output_block),
5491 &hmac_output_length);
5492 if (status != PSA_SUCCESS) {
5493 return status;
5494 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005495 }
5496
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005498}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005499#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005500
John Durkop07cc04a2020-11-16 22:08:34 -08005501#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5502 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005503static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5504 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005506{
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5508 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005509 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5510 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005511 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005512
Janos Follath7742fee2019-06-17 12:58:10 +01005513 /* We can't be wanting more output after block 0xff, otherwise
5514 * the capacity check in psa_key_derivation_output_bytes() would have
5515 * prevented this call. It could happen only if the operation
5516 * object was corrupted or if this function is called directly
5517 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 if (tls12_prf->block_number == 0xff) {
5519 return PSA_ERROR_CORRUPTION_DETECTED;
5520 }
Janos Follath7742fee2019-06-17 12:58:10 +01005521
5522 /* We need a new block */
5523 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005524 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005525
5526 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5527 *
5528 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5529 *
5530 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5531 * HMAC_hash(secret, A(2) + seed) +
5532 * HMAC_hash(secret, A(3) + seed) + ...
5533 *
5534 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005535 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005536 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005537 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005538 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005539 * is currently extracted as `output_block` and where i is
5540 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005541 */
5542
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 status = psa_key_derivation_start_hmac(&hmac,
5544 hash_alg,
5545 tls12_prf->secret,
5546 tls12_prf->secret_length);
5547 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005548 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005549 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005550
5551 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005553 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5554 * the variable seed and in this instance means it in the context of the
5555 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 status = psa_mac_update(&hmac,
5557 tls12_prf->label,
5558 tls12_prf->label_length);
5559 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005560 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005561 }
5562 status = psa_mac_update(&hmac,
5563 tls12_prf->seed,
5564 tls12_prf->seed_length);
5565 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005566 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 }
5568 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005569 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5571 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005572 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005574 }
5575
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 status = psa_mac_sign_finish(&hmac,
5577 tls12_prf->Ai, hash_length,
5578 &hmac_output_length);
5579 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005580 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 }
5582 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005583 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005585
5586 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 status = psa_key_derivation_start_hmac(&hmac,
5588 hash_alg,
5589 tls12_prf->secret,
5590 tls12_prf->secret_length);
5591 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005592 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 }
5594 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5595 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005596 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 }
5598 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5599 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005600 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 }
5602 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5603 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005604 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 }
5606 status = psa_mac_sign_finish(&hmac,
5607 tls12_prf->output_block, hash_length,
5608 &hmac_output_length);
5609 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005610 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005612
Janos Follath7742fee2019-06-17 12:58:10 +01005613
5614cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 cleanup_status = psa_mac_abort(&hmac);
5616 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005617 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005619
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005621}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005622
Janos Follath844eb0e2019-06-19 12:10:49 +01005623static psa_status_t psa_key_derivation_tls12_prf_read(
5624 psa_tls12_prf_key_derivation_t *tls12_prf,
5625 psa_algorithm_t alg,
5626 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005627 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005628{
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5630 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005631 psa_status_t status;
5632 uint8_t offset, length;
5633
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005635 case PSA_TLS12_PRF_STATE_LABEL_SET:
5636 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5637 break;
5638 case PSA_TLS12_PRF_STATE_OUTPUT:
5639 break;
5640 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005641 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005642 }
5643
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005645 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 if (tls12_prf->left_in_block == 0) {
5647 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5648 alg);
5649 if (status != PSA_SUCCESS) {
5650 return status;
5651 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005652
5653 continue;
5654 }
5655
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005657 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005659 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005661
5662 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005663 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005664 output += length;
5665 output_length -= length;
5666 tls12_prf->left_in_block -= length;
5667 }
5668
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005670}
John Durkop07cc04a2020-11-16 22:08:34 -08005671#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5672 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005673
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005674#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5675static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5676 psa_tls12_ecjpake_to_pms_t *ecjpake,
5677 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005679{
5680 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005681 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005682
Gilles Peskine449bd832023-01-11 14:50:10 +01005683 if (output_length != 32) {
5684 return PSA_ERROR_INVALID_ARGUMENT;
5685 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005686
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5688 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5689 &output_size);
5690 if (status != PSA_SUCCESS) {
5691 return status;
5692 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005693
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 if (output_size != output_length) {
5695 return PSA_ERROR_GENERIC_ERROR;
5696 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005697
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005699}
5700#endif
5701
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305702#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305703static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5704 psa_pbkdf2_key_derivation_t *pbkdf2,
5705 psa_algorithm_t prf_alg,
5706 uint8_t prf_output_length,
5707 psa_key_attributes_t *attributes)
5708{
5709 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305710 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305711 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305712 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305713 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305714 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305715 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305716
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305717 mac_operation.is_sign = 1;
5718 mac_operation.mac_size = prf_output_length;
5719 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305720
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305721 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5722 attributes,
5723 pbkdf2->password,
5724 pbkdf2->password_length,
5725 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305726 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305727 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305728 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305729 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5730 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305731 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305732 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305733 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305734 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305735 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305736 }
5737 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5738 &mac_output_length);
5739 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305740 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305741 }
5742
5743 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305744 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305745 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305746 }
5747
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305748 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305749
5750 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305751 /* We are passing prf_output_length as mac_size because the driver
5752 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305753 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305754 status = psa_driver_wrapper_mac_compute(attributes,
5755 pbkdf2->password,
5756 pbkdf2->password_length,
5757 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305758 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305759 &mac_output_length);
5760 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305761 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305762 }
5763
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305764 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305765 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305766
5767cleanup:
5768 /* Zeroise buffers to clear sensitive data from memory. */
5769 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5770 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305771}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305772
5773static psa_status_t psa_key_derivation_pbkdf2_read(
5774 psa_pbkdf2_key_derivation_t *pbkdf2,
5775 psa_algorithm_t kdf_alg,
5776 uint8_t *output,
5777 size_t output_length)
5778{
5779 psa_status_t status;
5780 psa_algorithm_t prf_alg;
5781 uint8_t prf_output_length;
5782 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5783 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5784 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5785
5786 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5787 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5788 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5789 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305790 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5791 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305792 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305793 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305794 } else {
5795 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305796 }
5797
5798 switch (pbkdf2->state) {
5799 case PSA_PBKDF2_STATE_PASSWORD_SET:
5800 /* Initially we need a new block so bytes_used is equal to block size*/
5801 pbkdf2->bytes_used = prf_output_length;
5802 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5803 break;
5804 case PSA_PBKDF2_STATE_OUTPUT:
5805 break;
5806 default:
5807 return PSA_ERROR_BAD_STATE;
5808 }
5809
5810 while (output_length != 0) {
5811 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5812 if (n > output_length) {
5813 n = (uint8_t) output_length;
5814 }
5815 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5816 output += n;
5817 output_length -= n;
5818 pbkdf2->bytes_used += n;
5819
5820 if (output_length == 0) {
5821 break;
5822 }
5823
5824 /* We need a new block */
5825 pbkdf2->bytes_used = 0;
5826 pbkdf2->block_number++;
5827
5828 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5829 prf_output_length,
5830 &attributes);
5831 if (status != PSA_SUCCESS) {
5832 return status;
5833 }
5834 }
5835
5836 return PSA_SUCCESS;
5837}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305838#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305839
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005840psa_status_t psa_key_derivation_output_bytes(
5841 psa_key_derivation_operation_t *operation,
5842 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005844{
5845 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005847
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005849 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005851 }
5852
Gilles Peskine449bd832023-01-11 14:50:10 +01005853 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005854 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005855 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005856 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005857 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005858 goto exit;
5859 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005860 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005861 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005862 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005863 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5864 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005865 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005866 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005868 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005869 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005870
Przemek Stekiel69c46792022-06-10 12:59:51 +02005871#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5873 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5874 output, output_length);
5875 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005876#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005877#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5878 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5880 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5881 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5882 kdf_alg, output,
5883 output_length);
5884 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005885#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5886 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005887#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005889 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005890 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5891 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005892#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305893#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305894 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305895 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5896 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305897 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305898#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005899
Gilles Peskineeab56e42018-07-12 17:12:33 +02005900 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005901 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005903 }
5904
5905exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005907 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005908 * This allows us to differentiate between exhausted operations and
5909 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5910 * operations. */
5911 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005913 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005914 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005915 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005917}
5918
David Brown7807bf72021-02-09 16:28:23 -07005919#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005920static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005921{
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 if (data_size >= 8) {
5923 mbedtls_des_key_set_parity(data);
5924 }
5925 if (data_size >= 16) {
5926 mbedtls_des_key_set_parity(data + 8);
5927 }
5928 if (data_size >= 24) {
5929 mbedtls_des_key_set_parity(data + 16);
5930 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005931}
David Brown7807bf72021-02-09 16:28:23 -07005932#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005933
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005934/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005935 * ECC keys on a Weierstrass elliptic curve require the generation
5936 * of a private key which is an integer
5937 * in the range [1, N - 1], where N is the boundary of the private key domain:
5938 * N is the prime p for Diffie-Hellman, or the order of the
5939 * curve’s base point for ECC.
5940 *
5941 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5942 * This function generates the private key using the following process:
5943 *
5944 * 1. Draw a byte string of length ceiling(m/8) bytes.
5945 * 2. If m is not a multiple of 8, set the most significant
5946 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5947 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5948 * 4. If k > N - 2, discard the result and return to step 1.
5949 * 5. Output k + 1 as the private key.
5950 *
5951 * This method allows compliance to NIST standards, specifically the methods titled
5952 * Key-Pair Generation by Testing Candidates in the following publications:
5953 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5954 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5955 * Diffie-Hellman keys.
5956 *
5957 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5958 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5959 *
5960 * Note: Function allocates memory for *data buffer, so given *data should be
5961 * always NULL.
5962 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005963#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5964#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005965static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005966 psa_key_slot_t *slot,
5967 size_t bits,
5968 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005969 uint8_t **data
5970 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005971{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005972 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005973 mbedtls_mpi k;
5974 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005975 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005976 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005977 size_t m;
5978 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005979
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 mbedtls_mpi_init(&k);
5981 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005982
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005983 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005985 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005987
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005989 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005990 goto cleanup;
5991 }
5992
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005993 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005995
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005997
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005998 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005999 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006000 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006001
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006002 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006003
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006004 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006006
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006007 /* Note: This function is always called with *data == NULL and it
6008 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 *data = mbedtls_calloc(1, m_bytes);
6010 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006011 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006012 goto cleanup;
6013 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006014
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006016 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006018 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006020
6021 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006023 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006024 * (8 * ceiling(m/8) - m) bits of the first byte in
6025 * the string to zero.
6026 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006028 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006029 }
6030
6031 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 * big-endian byte string.
6033 */
6034 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006035
6036 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 * Result of comparison is returned. When it indicates error
6038 * then this function is called again.
6039 */
6040 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006041 }
6042
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006043 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6045 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006046cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 if (ret != 0) {
6048 status = mbedtls_to_psa_error(ret);
6049 }
6050 if (status != PSA_SUCCESS) {
6051 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006052 *data = NULL;
6053 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 mbedtls_mpi_free(&k);
6055 mbedtls_mpi_free(&diff_N_2);
6056 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006057}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006058
6059/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6060 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6061 *
6062 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6063 * draw a 32-byte string and process it as specified in
6064 * Elliptic Curves for Security [RFC7748] §5.
6065 *
6066 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6067 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6068 *
6069 * Note: Function allocates memory for *data buffer, so given *data should be
6070 * always NULL.
6071 */
6072
6073static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6074 size_t bits,
6075 psa_key_derivation_operation_t *operation,
6076 uint8_t **data
6077 )
6078{
6079 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006080 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006081
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006083 case 255:
6084 output_length = 32;
6085 break;
6086 case 448:
6087 output_length = 56;
6088 break;
6089 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006091 break;
6092 }
6093
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006095
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 if (*data == NULL) {
6097 return PSA_ERROR_INSUFFICIENT_MEMORY;
6098 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006099
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006101
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006103 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006105
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006107 case 255:
6108 (*data)[0] &= 248;
6109 (*data)[31] &= 127;
6110 (*data)[31] |= 64;
6111 break;
6112 case 448:
6113 (*data)[0] &= 252;
6114 (*data)[55] |= 128;
6115 break;
6116 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006118 break;
6119 }
6120
6121 return status;
6122}
Valerio Setti86587ab2023-06-27 13:09:30 +02006123#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6124static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6125 psa_key_slot_t *slot, size_t bits,
6126 psa_key_derivation_operation_t *operation, uint8_t **data)
6127{
6128 (void) slot;
6129 (void) bits;
6130 (void) operation;
6131 (void) data;
6132 return PSA_ERROR_NOT_SUPPORTED;
6133}
6134
6135static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6136 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6137{
6138 (void) bits;
6139 (void) operation;
6140 (void) data;
6141 return PSA_ERROR_NOT_SUPPORTED;
6142}
6143#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6144#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006145
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006146static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006147 psa_key_slot_t *slot,
6148 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006150{
6151 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306153 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006154 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006155 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006156
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6158 return PSA_ERROR_INVALID_ARGUMENT;
6159 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006160
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006161#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006162 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6164 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6165 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006166 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6168 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006169 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 }
6171 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006172 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6174 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006175 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006177 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006178 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006179#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006180 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006181 if (key_type_is_raw_bytes(slot->attr.type)) {
6182 if (bits % 8 != 0) {
6183 return PSA_ERROR_INVALID_ARGUMENT;
6184 }
6185 data = mbedtls_calloc(1, bytes);
6186 if (data == NULL) {
6187 return PSA_ERROR_INSUFFICIENT_MEMORY;
6188 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006189
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 status = psa_key_derivation_output_bytes(operation, data, bytes);
6191 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006192 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 }
David Brown12ca5032021-02-11 11:02:00 -07006194#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6196 psa_des_set_key_parity(data, bytes);
6197 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006198#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 } else {
6200 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006201 }
Ronald Crondd04d422020-11-28 15:14:42 +01006202
Ronald Cronbf33c932020-11-28 18:06:53 +01006203 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006204 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006206 };
6207
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6209 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6210 &storage_size);
6211 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306212 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 }
Archanad8a83dc2021-06-14 10:04:16 +05306214 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 status = psa_allocate_buffer_to_slot(slot, storage_size);
6216 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306217 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 }
Archanad8a83dc2021-06-14 10:04:16 +05306219
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 status = psa_driver_wrapper_import_key(&attributes,
6221 data, bytes,
6222 slot->key.data,
6223 slot->key.bytes,
6224 &slot->key.bytes, &bits);
6225 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006226 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006228
6229exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 mbedtls_free(data);
6231 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006232}
6233
Gilles Peskine449bd832023-01-11 14:50:10 +01006234psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6235 psa_key_derivation_operation_t *operation,
6236 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006237{
6238 psa_status_t status;
6239 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006240 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006241
Ronald Cron81709fc2020-11-14 12:10:32 +01006242 *key = MBEDTLS_SVC_KEY_ID_INIT;
6243
Gilles Peskine0f84d622019-09-12 19:03:13 +02006244 /* Reject any attempt to create a zero-length key so that we don't
6245 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 if (psa_get_key_bits(attributes) == 0) {
6247 return PSA_ERROR_INVALID_ARGUMENT;
6248 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006249
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 if (operation->alg == PSA_ALG_NONE) {
6251 return PSA_ERROR_BAD_STATE;
6252 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006253
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 if (!operation->can_output_key) {
6255 return PSA_ERROR_NOT_PERMITTED;
6256 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006257
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6259 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006260#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006262 /* Deriving a key in a secure element is not implemented yet. */
6263 status = PSA_ERROR_NOT_SUPPORTED;
6264 }
6265#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 if (status == PSA_SUCCESS) {
6267 status = psa_generate_derived_key_internal(slot,
6268 attributes->core.bits,
6269 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006270 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 if (status == PSA_SUCCESS) {
6272 status = psa_finish_key_creation(slot, driver, key);
6273 }
6274 if (status != PSA_SUCCESS) {
6275 psa_fail_key_creation(slot, driver);
6276 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006277
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006279}
6280
Gilles Peskineeab56e42018-07-12 17:12:33 +02006281
6282
6283/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006284/* Key derivation */
6285/****************************************************************/
6286
Steven Cooreman932ffb72021-02-15 12:14:32 +01006287#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006288static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006289{
6290#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6292 return 1;
6293 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006294#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006295#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6297 return 1;
6298 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006299#endif
6300#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6302 return 1;
6303 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006304#endif
6305#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6307 return 1;
6308 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006309#endif
6310#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6312 return 1;
6313 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006314#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006315#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6317 return 1;
6318 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006319#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306320#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6321 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6322 return 1;
6323 }
6324#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306325#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6326 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6327 return 1;
6328 }
6329#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006331}
6332
Gilles Peskine449bd832023-01-11 14:50:10 +01006333static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006334{
6335 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 psa_status_t status = psa_hash_setup(&operation, alg);
6337 psa_hash_abort(&operation);
6338 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006339}
6340
Gilles Peskine969c5d62019-01-16 15:53:06 +01006341static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006342 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006344{
Janos Follath5fe19732019-06-20 15:09:30 +01006345 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6346 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006348
Gilles Peskine969c5d62019-01-16 15:53:06 +01006349 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 if (!is_kdf_alg_supported(kdf_alg)) {
6351 return PSA_ERROR_NOT_SUPPORTED;
6352 }
John Durkop07cc04a2020-11-16 22:08:34 -08006353
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006354 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306355 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6357 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306358 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6359 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6360 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306361 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306362 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006363 if (hash_size == 0) {
6364 return PSA_ERROR_NOT_SUPPORTED;
6365 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006366
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006367 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6368 * we might fail later, which is somewhat unfriendly and potentially
6369 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 psa_status_t status = psa_hash_try_support(hash_alg);
6371 if (status != PSA_SUCCESS) {
6372 return status;
6373 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006374 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006375
Gilles Peskine449bd832023-01-11 14:50:10 +01006376 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6377 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6378 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6379 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006380 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006381#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006382 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6384 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006385 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006387#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6388 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 operation->capacity = 255 * hash_size;
6390 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006391}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006392
Gilles Peskine449bd832023-01-11 14:50:10 +01006393static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006394{
6395#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 if (alg == PSA_ALG_ECDH) {
6397 return PSA_SUCCESS;
6398 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006399#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006400#if defined(PSA_WANT_ALG_FFDH)
6401 if (alg == PSA_ALG_FFDH) {
6402 return PSA_SUCCESS;
6403 }
6404#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006405 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006407}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006408
6409static int psa_key_derivation_allows_free_form_secret_input(
6410 psa_algorithm_t kdf_alg)
6411{
6412#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6413 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6414 return 0;
6415 }
6416#endif
6417 (void) kdf_alg;
6418 return 1;
6419}
John Durkop07cc04a2020-11-16 22:08:34 -08006420#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006421
Gilles Peskine449bd832023-01-11 14:50:10 +01006422psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6423 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006424{
6425 psa_status_t status;
6426
Gilles Peskine449bd832023-01-11 14:50:10 +01006427 if (operation->alg != 0) {
6428 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006429 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006430
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6432 return PSA_ERROR_INVALID_ARGUMENT;
6433 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6434#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6435 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6436 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6437 status = psa_key_agreement_try_support(ka_alg);
6438 if (status != PSA_SUCCESS) {
6439 return status;
6440 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006441 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6442 return PSA_ERROR_INVALID_ARGUMENT;
6443 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6445#else
6446 return PSA_ERROR_NOT_SUPPORTED;
6447#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6448 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6449#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6450 status = psa_key_derivation_setup_kdf(operation, alg);
6451#else
6452 return PSA_ERROR_NOT_SUPPORTED;
6453#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6454 } else {
6455 return PSA_ERROR_INVALID_ARGUMENT;
6456 }
6457
6458 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006459 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 }
6461 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006462}
6463
Przemek Stekiel69c46792022-06-10 12:59:51 +02006464#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006465static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6466 psa_algorithm_t kdf_alg,
6467 psa_key_derivation_step_t step,
6468 const uint8_t *data,
6469 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006470{
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006472 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006473 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006474 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006475#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6477 return PSA_ERROR_INVALID_ARGUMENT;
6478 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006479#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 if (hkdf->state != HKDF_STATE_INIT) {
6481 return PSA_ERROR_BAD_STATE;
6482 } else {
6483 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6484 hash_alg,
6485 data, data_length);
6486 if (status != PSA_SUCCESS) {
6487 return status;
6488 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006489 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006491 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006492 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006493#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006495 /* We shouldn't be in different state as HKDF_EXPAND only allows
6496 * two inputs: SECRET (this case) and INFO which does not modify
6497 * the state. It could happen only if the hkdf
6498 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006499 if (hkdf->state != HKDF_STATE_INIT) {
6500 return PSA_ERROR_BAD_STATE;
6501 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006502
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006503 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6505 return PSA_ERROR_INVALID_ARGUMENT;
6506 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006507
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 memcpy(hkdf->prk, data, data_length);
6509 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006510#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006511 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006512 /* HKDF: If no salt was provided, use an empty salt.
6513 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006515#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6517 return PSA_ERROR_BAD_STATE;
6518 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006519#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6521 hash_alg,
6522 NULL, 0);
6523 if (status != PSA_SUCCESS) {
6524 return status;
6525 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006526 hkdf->state = HKDF_STATE_STARTED;
6527 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 if (hkdf->state != HKDF_STATE_STARTED) {
6529 return PSA_ERROR_BAD_STATE;
6530 }
6531 status = psa_mac_update(&hkdf->hmac,
6532 data, data_length);
6533 if (status != PSA_SUCCESS) {
6534 return status;
6535 }
6536 status = psa_mac_sign_finish(&hkdf->hmac,
6537 hkdf->prk,
6538 sizeof(hkdf->prk),
6539 &data_length);
6540 if (status != PSA_SUCCESS) {
6541 return status;
6542 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006543 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006544
Gilles Peskine2b522db2019-04-12 15:11:49 +02006545 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006546 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006547#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006549 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006551 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006553#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006554 {
6555 /* Block 0 is empty, and the next block will be
6556 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006558 }
6559
Gilles Peskine449bd832023-01-11 14:50:10 +01006560 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006561 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006562#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6564 return PSA_ERROR_INVALID_ARGUMENT;
6565 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006566#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006567#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6569 hkdf->state == HKDF_STATE_INIT) {
6570 return PSA_ERROR_BAD_STATE;
6571 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006572#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006573 if (hkdf->state == HKDF_STATE_OUTPUT) {
6574 return PSA_ERROR_BAD_STATE;
6575 }
6576 if (hkdf->info_set) {
6577 return PSA_ERROR_BAD_STATE;
6578 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006579 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 if (data_length != 0) {
6581 hkdf->info = mbedtls_calloc(1, data_length);
6582 if (hkdf->info == NULL) {
6583 return PSA_ERROR_INSUFFICIENT_MEMORY;
6584 }
6585 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006586 }
6587 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006588 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006589 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006591 }
6592}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006593#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006594
John Durkop07cc04a2020-11-16 22:08:34 -08006595#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6596 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006597static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6598 const uint8_t *data,
6599 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006600{
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6602 return PSA_ERROR_BAD_STATE;
6603 }
Janos Follathf08e2652019-06-13 09:05:41 +01006604
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 if (data_length != 0) {
6606 prf->seed = mbedtls_calloc(1, data_length);
6607 if (prf->seed == NULL) {
6608 return PSA_ERROR_INSUFFICIENT_MEMORY;
6609 }
Janos Follathf08e2652019-06-13 09:05:41 +01006610
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006612 prf->seed_length = data_length;
6613 }
Janos Follathf08e2652019-06-13 09:05:41 +01006614
Gilles Peskine43f958b2020-12-13 14:55:14 +01006615 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006616
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006618}
6619
Gilles Peskine449bd832023-01-11 14:50:10 +01006620static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6621 const uint8_t *data,
6622 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006623{
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6625 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6626 return PSA_ERROR_BAD_STATE;
6627 }
Janos Follath81550542019-06-13 14:26:34 +01006628
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 if (data_length != 0) {
6630 prf->secret = mbedtls_calloc(1, data_length);
6631 if (prf->secret == NULL) {
6632 return PSA_ERROR_INSUFFICIENT_MEMORY;
6633 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006634
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006636 prf->secret_length = data_length;
6637 }
Janos Follath81550542019-06-13 14:26:34 +01006638
Gilles Peskine43f958b2020-12-13 14:55:14 +01006639 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006640
Gilles Peskine449bd832023-01-11 14:50:10 +01006641 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006642}
6643
Gilles Peskine449bd832023-01-11 14:50:10 +01006644static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6645 const uint8_t *data,
6646 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006647{
Gilles Peskine449bd832023-01-11 14:50:10 +01006648 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6649 return PSA_ERROR_BAD_STATE;
6650 }
Janos Follath63028dd2019-06-13 09:15:47 +01006651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 if (data_length != 0) {
6653 prf->label = mbedtls_calloc(1, data_length);
6654 if (prf->label == NULL) {
6655 return PSA_ERROR_INSUFFICIENT_MEMORY;
6656 }
Janos Follath63028dd2019-06-13 09:15:47 +01006657
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006659 prf->label_length = data_length;
6660 }
Janos Follath63028dd2019-06-13 09:15:47 +01006661
Gilles Peskine43f958b2020-12-13 14:55:14 +01006662 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006663
Gilles Peskine449bd832023-01-11 14:50:10 +01006664 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006665}
6666
Gilles Peskine449bd832023-01-11 14:50:10 +01006667static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6668 psa_key_derivation_step_t step,
6669 const uint8_t *data,
6670 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006671{
Gilles Peskine449bd832023-01-11 14:50:10 +01006672 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006673 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006675 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006676 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006677 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006678 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006679 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006680 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006681 }
6682}
John Durkop07cc04a2020-11-16 22:08:34 -08006683#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6684 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6685
6686#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6687static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6688 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006689 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006690 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006691{
6692 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006693 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6694 4 + data_length + prf->other_secret_length :
6695 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006696
Gilles Peskine449bd832023-01-11 14:50:10 +01006697 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6698 return PSA_ERROR_INVALID_ARGUMENT;
6699 }
John Durkop07cc04a2020-11-16 22:08:34 -08006700
Gilles Peskine449bd832023-01-11 14:50:10 +01006701 uint8_t *pms = mbedtls_calloc(1, pms_len);
6702 if (pms == NULL) {
6703 return PSA_ERROR_INSUFFICIENT_MEMORY;
6704 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006705 uint8_t *cur = pms;
6706
6707 /* pure-PSK:
6708 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006709 *
6710 * The premaster secret is formed as follows: if the PSK is N octets
6711 * long, concatenate a uint16 with the value N, N zero octets, a second
6712 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006713 *
6714 * mixed-PSK:
6715 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6716 * follows: concatenate a uint16 with the length of the other secret,
6717 * the other secret itself, uint16 with the length of PSK, and the
6718 * PSK itself.
6719 * For details please check:
6720 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6721 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6722 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006723 */
6724
Gilles Peskine449bd832023-01-11 14:50:10 +01006725 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6726 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6727 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6728 if (prf->other_secret_length != 0) {
6729 memcpy(cur, prf->other_secret, prf->other_secret_length);
6730 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006731 cur += prf->other_secret_length;
6732 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 } else {
6734 *cur++ = MBEDTLS_BYTE_1(data_length);
6735 *cur++ = MBEDTLS_BYTE_0(data_length);
6736 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006737 cur += data_length;
6738 }
6739
Gilles Peskine449bd832023-01-11 14:50:10 +01006740 *cur++ = MBEDTLS_BYTE_1(data_length);
6741 *cur++ = MBEDTLS_BYTE_0(data_length);
6742 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006743 cur += data_length;
6744
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006745 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006746
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006747 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006748 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006749}
Janos Follath6660f0e2019-06-17 08:44:03 +01006750
Przemek Stekiele47201b2022-04-19 13:53:28 +02006751static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6752 psa_tls12_prf_key_derivation_t *prf,
6753 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006755{
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6757 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006758 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006759
6760 if (data_length != 0) {
6761 prf->other_secret = mbedtls_calloc(1, data_length);
6762 if (prf->other_secret == NULL) {
6763 return PSA_ERROR_INSUFFICIENT_MEMORY;
6764 }
6765
6766 memcpy(prf->other_secret, data, data_length);
6767 prf->other_secret_length = data_length;
6768 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006769 prf->other_secret_length = 0;
6770 }
6771
6772 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6773
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006775}
6776
Janos Follath6660f0e2019-06-17 08:44:03 +01006777static psa_status_t psa_tls12_prf_psk_to_ms_input(
6778 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006779 psa_key_derivation_step_t step,
6780 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006782{
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006784 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 return psa_tls12_prf_psk_to_ms_set_key(prf,
6786 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006787 break;
6788 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6790 data,
6791 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006792 break;
6793 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006795 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006796
Przemek Stekiele47201b2022-04-19 13:53:28 +02006797 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006798}
John Durkop07cc04a2020-11-16 22:08:34 -08006799#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006800
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006801#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6802static psa_status_t psa_tls12_ecjpake_to_pms_input(
6803 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006804 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006805 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006807{
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6809 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6810 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006811 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006812
6813 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 if (data[0] != 0x04) {
6815 return PSA_ERROR_INVALID_ARGUMENT;
6816 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006817
6818 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006822}
6823#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306824
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306825#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306826static psa_status_t psa_pbkdf2_set_input_cost(
6827 psa_pbkdf2_key_derivation_t *pbkdf2,
6828 psa_key_derivation_step_t step,
6829 uint64_t data)
6830{
6831 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6832 return PSA_ERROR_INVALID_ARGUMENT;
6833 }
6834
6835 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6836 return PSA_ERROR_BAD_STATE;
6837 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306838
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306839 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306840 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306841 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306842
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306843 if (data == 0) {
6844 return PSA_ERROR_INVALID_ARGUMENT;
6845 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306846
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306847 pbkdf2->input_cost = data;
6848 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6849
6850 return PSA_SUCCESS;
6851}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306852
6853static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6854 const uint8_t *data,
6855 size_t data_length)
6856{
Gilles Peskineead17662023-08-20 22:02:51 +02006857 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6858 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6859 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6860 /* Appending to existing salt. No state change. */
6861 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306862 return PSA_ERROR_BAD_STATE;
6863 }
6864
Gilles Peskineca57d782023-07-20 19:08:06 +02006865 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006866 /* Appending an empty string, nothing to do. */
6867 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306868 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306869
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306870 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6871 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306872 return PSA_ERROR_INSUFFICIENT_MEMORY;
6873 }
6874
Gilles Peskineead17662023-08-20 22:02:51 +02006875 if (pbkdf2->salt_length != 0) {
6876 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6877 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306878 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306879 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306880 mbedtls_free(pbkdf2->salt);
6881 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306882 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306883 return PSA_SUCCESS;
6884}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306885
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306886#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306887static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306888 const uint8_t *input,
6889 size_t input_len,
6890 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306891 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306892{
6893 psa_status_t status = PSA_SUCCESS;
6894 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6895 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306896 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306897 } else {
6898 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306899 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306900 }
6901 return status;
6902}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306903#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306904
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306905#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306906static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6907 size_t input_len,
6908 uint8_t *output,
6909 size_t *output_len)
6910{
6911 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306912 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306913 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306914 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306915 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6916 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6917 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306918 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306919 * mac_size as the driver function sets mac_output_length = mac_size
6920 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306921 status = psa_driver_wrapper_mac_compute(&attributes,
6922 zeros, sizeof(zeros),
6923 PSA_ALG_CMAC, input, input_len,
6924 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306925 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6926 128U,
6927 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306928 output_len);
6929 } else {
6930 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306931 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306932 }
6933 return status;
6934}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306935#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306936
6937static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306938 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306939 const uint8_t *data,
6940 size_t data_length)
6941{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306942 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306943 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6944 return PSA_ERROR_BAD_STATE;
6945 }
6946
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306947#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306948 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6949 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6950 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6951 pbkdf2->password,
6952 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306953 } else
6954#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6955#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6956 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306957 status = psa_pbkdf2_cmac_set_password(data, data_length,
6958 pbkdf2->password,
6959 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306960 } else
6961#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6962 {
6963 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306964 }
6965
6966 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6967
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306968 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306969}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306970
6971static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306972 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306973 psa_key_derivation_step_t step,
6974 const uint8_t *data,
6975 size_t data_length)
6976{
6977 switch (step) {
6978 case PSA_KEY_DERIVATION_INPUT_SALT:
6979 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6980 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306981 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306982 default:
6983 return PSA_ERROR_INVALID_ARGUMENT;
6984 }
6985}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306986#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306987
Gilles Peskineb8965192019-09-24 16:21:10 +02006988/** Check whether the given key type is acceptable for the given
6989 * input step of a key derivation.
6990 *
6991 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6992 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6993 * Both secret and non-secret inputs can alternatively have the type
6994 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6995 * that the input was passed as a buffer rather than via a key object.
6996 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006997static int psa_key_derivation_check_input_type(
6998 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007000{
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007002 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007003 if (key_type == PSA_KEY_TYPE_DERIVE) {
7004 return PSA_SUCCESS;
7005 }
7006 if (key_type == PSA_KEY_TYPE_NONE) {
7007 return PSA_SUCCESS;
7008 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007009 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007010 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 if (key_type == PSA_KEY_TYPE_DERIVE) {
7012 return PSA_SUCCESS;
7013 }
7014 if (key_type == PSA_KEY_TYPE_NONE) {
7015 return PSA_SUCCESS;
7016 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007017 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007018 case PSA_KEY_DERIVATION_INPUT_LABEL:
7019 case PSA_KEY_DERIVATION_INPUT_SALT:
7020 case PSA_KEY_DERIVATION_INPUT_INFO:
7021 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7023 return PSA_SUCCESS;
7024 }
7025 if (key_type == PSA_KEY_TYPE_NONE) {
7026 return PSA_SUCCESS;
7027 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007028 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307029 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7030 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7031 return PSA_SUCCESS;
7032 }
7033 if (key_type == PSA_KEY_TYPE_DERIVE) {
7034 return PSA_SUCCESS;
7035 }
7036 if (key_type == PSA_KEY_TYPE_NONE) {
7037 return PSA_SUCCESS;
7038 }
7039 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007040 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007042}
7043
Janos Follathb80a94e2019-06-12 15:54:46 +01007044static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007045 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007046 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007047 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007048 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007050{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007051 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007053
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 status = psa_key_derivation_check_input_type(step, key_type);
7055 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007056 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007058
Przemek Stekiel69c46792022-06-10 12:59:51 +02007059#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7061 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7062 step, data, data_length);
7063 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007064#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007065#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007066 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7067 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7068 step, data, data_length);
7069 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007070#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7071#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007072 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7073 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7074 step, data, data_length);
7075 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007076#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007077#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007079 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7081 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007082#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307083#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307084 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307085 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7086 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307087 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307088#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007089 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007090 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007091 (void) data;
7092 (void) data_length;
7093 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007095 }
7096
Gilles Peskine224b0d62019-09-23 18:13:17 +02007097exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 if (status != PSA_SUCCESS) {
7099 psa_key_derivation_abort(operation);
7100 }
7101 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007102}
7103
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307104static psa_status_t psa_key_derivation_input_integer_internal(
7105 psa_key_derivation_operation_t *operation,
7106 psa_key_derivation_step_t step,
7107 uint64_t value)
7108{
7109 psa_status_t status;
7110 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7111
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307112#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307113 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307114 status = psa_pbkdf2_set_input_cost(
7115 &operation->ctx.pbkdf2, step, value);
7116 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307117#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307118 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307119 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307120 (void) value;
7121 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307122 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307123 }
7124
7125 if (status != PSA_SUCCESS) {
7126 psa_key_derivation_abort(operation);
7127 }
7128 return status;
7129}
7130
Janos Follath51f4a0f2019-06-14 11:35:55 +01007131psa_status_t psa_key_derivation_input_bytes(
7132 psa_key_derivation_operation_t *operation,
7133 psa_key_derivation_step_t step,
7134 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007136{
Gilles Peskine449bd832023-01-11 14:50:10 +01007137 return psa_key_derivation_input_internal(operation, step,
7138 PSA_KEY_TYPE_NONE,
7139 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007140}
7141
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307142psa_status_t psa_key_derivation_input_integer(
7143 psa_key_derivation_operation_t *operation,
7144 psa_key_derivation_step_t step,
7145 uint64_t value)
7146{
7147 return psa_key_derivation_input_integer_internal(operation, step, value);
7148}
7149
Janos Follath51f4a0f2019-06-14 11:35:55 +01007150psa_status_t psa_key_derivation_input_key(
7151 psa_key_derivation_operation_t *operation,
7152 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007153 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007154{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007155 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007156 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007157 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007158
Ronald Cron5c522922020-11-14 16:35:34 +01007159 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7161 if (status != PSA_SUCCESS) {
7162 psa_key_derivation_abort(operation);
7163 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007164 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007165
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307166 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7167 * permission to output to a key object. */
7168 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7169 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007170 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007172
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 status = psa_key_derivation_input_internal(operation,
7174 step, slot->attr.type,
7175 slot->key.data,
7176 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007177
Gilles Peskine449bd832023-01-11 14:50:10 +01007178 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007179
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007181}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007182
7183
7184
7185/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007186/* Key agreement */
7187/****************************************************************/
7188
Gilles Peskine449bd832023-01-11 14:50:10 +01007189psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7190 const uint8_t *key_buffer,
7191 size_t key_buffer_size,
7192 psa_algorithm_t alg,
7193 const uint8_t *peer_key,
7194 size_t peer_key_length,
7195 uint8_t *shared_secret,
7196 size_t shared_secret_size,
7197 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007198{
Gilles Peskine449bd832023-01-11 14:50:10 +01007199 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007200#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007201 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7203 key_buffer_size, alg,
7204 peer_key, peer_key_length,
7205 shared_secret,
7206 shared_secret_size,
7207 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007208#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007209
7210#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7211 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007212 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007213 peer_key,
7214 peer_key_length,
7215 key_buffer,
7216 key_buffer_size,
7217 shared_secret,
7218 shared_secret_size,
7219 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007220#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7221
Gilles Peskine01d718c2018-09-18 12:01:02 +02007222 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007223 (void) attributes;
7224 (void) key_buffer;
7225 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007226 (void) peer_key;
7227 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007228 (void) shared_secret;
7229 (void) shared_secret_size;
7230 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007231 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007232 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007233}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007234
Aditya Deshpande17845b82022-10-13 17:21:01 +01007235/** Internal function for raw key agreement
7236 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007237 * to the driver's implementation if a driver is present.
7238 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007239 * (psa_key_agreement_raw_builtin).
7240 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007241static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7242 psa_key_slot_t *private_key,
7243 const uint8_t *peer_key,
7244 size_t peer_key_length,
7245 uint8_t *shared_secret,
7246 size_t shared_secret_size,
7247 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007248{
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7250 return PSA_ERROR_NOT_SUPPORTED;
7251 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007252
7253 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007255 };
7256
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 return psa_driver_wrapper_key_agreement(&attributes,
7258 private_key->key.data,
7259 private_key->key.bytes, alg,
7260 peer_key, peer_key_length,
7261 shared_secret,
7262 shared_secret_size,
7263 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007264}
7265
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007266/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007267 * to potentially free embedded data structures and wipe confidential data.
7268 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007269static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7270 psa_key_derivation_step_t step,
7271 psa_key_slot_t *private_key,
7272 const uint8_t *peer_key,
7273 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007274{
7275 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007276 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007277 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007279
7280 /* Step 1: run the secret agreement algorithm to generate the shared
7281 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007282 status = psa_key_agreement_raw_internal(ka_alg,
7283 private_key,
7284 peer_key, peer_key_length,
7285 shared_secret,
7286 sizeof(shared_secret),
7287 &shared_secret_length);
7288 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007289 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007291
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007292 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007293 * the shared secret. A shared secret is permitted wherever a key
7294 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 status = psa_key_derivation_input_internal(operation, step,
7296 PSA_KEY_TYPE_DERIVE,
7297 shared_secret,
7298 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007299exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007300 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7301 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007302}
7303
Gilles Peskine449bd832023-01-11 14:50:10 +01007304psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7305 psa_key_derivation_step_t step,
7306 mbedtls_svc_key_id_t private_key,
7307 const uint8_t *peer_key,
7308 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007309{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007310 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007311 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007312 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007313
Gilles Peskine449bd832023-01-11 14:50:10 +01007314 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7315 return PSA_ERROR_INVALID_ARGUMENT;
7316 }
Ronald Cron5c522922020-11-14 16:35:34 +01007317 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007318 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7319 if (status != PSA_SUCCESS) {
7320 return status;
7321 }
7322 status = psa_key_agreement_internal(operation, step,
7323 slot,
7324 peer_key, peer_key_length);
7325 if (status != PSA_SUCCESS) {
7326 psa_key_derivation_abort(operation);
7327 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007328 /* If a private key has been added as SECRET, we allow the derived
7329 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007330 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007331 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007332 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007333 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007334
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007336
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007338}
7339
Gilles Peskine449bd832023-01-11 14:50:10 +01007340psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7341 mbedtls_svc_key_id_t private_key,
7342 const uint8_t *peer_key,
7343 size_t peer_key_length,
7344 uint8_t *output,
7345 size_t output_size,
7346 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007347{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007348 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007349 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007350 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007351 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007352
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007354 status = PSA_ERROR_INVALID_ARGUMENT;
7355 goto exit;
7356 }
Ronald Cron5c522922020-11-14 16:35:34 +01007357 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7359 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007360 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007362
Gilles Peskine3e561302022-04-14 00:17:15 +02007363 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7364 * for the output size. The PSA specification only guarantees that this
7365 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7366 * but it might be nice to allow smaller buffers if the output fits.
7367 * At the time of writing this comment, with only ECDH implemented,
7368 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7369 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7370 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007371 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7373 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007374 status = PSA_ERROR_BUFFER_TOO_SMALL;
7375 goto exit;
7376 }
7377
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 status = psa_key_agreement_raw_internal(alg, slot,
7379 peer_key, peer_key_length,
7380 output, output_size,
7381 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007382
7383exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007384 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007385 /* If an error happens and is not handled properly, the output
7386 * may be used as a key to protect sensitive data. Arrange for such
7387 * a key to be random, which is likely to result in decryption or
7388 * verification errors. This is better than filling the buffer with
7389 * some constant data such as zeros, which would result in the data
7390 * being protected with a reproducible, easily knowable key.
7391 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007393 *output_length = output_size;
7394 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007395
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007397
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007399}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007400
7401
Gilles Peskine30524eb2020-11-13 17:02:26 +01007402
Gilles Peskine86a440b2018-11-12 18:39:40 +01007403/****************************************************************/
7404/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007405/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007406
Gilles Peskine672a7712023-04-28 21:00:28 +02007407#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7408#include "entropy_poll.h"
7409#endif
7410
Gilles Peskine30524eb2020-11-13 17:02:26 +01007411/** Initialize the PSA random generator.
7412 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007413static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007414{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007415#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007417#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7418
Gilles Peskine30524eb2020-11-13 17:02:26 +01007419 /* Set default configuration if
7420 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007422 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 }
7424 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007425 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007427
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007429#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7430 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7431 /* The PSA entropy injection feature depends on using NV seed as an entropy
7432 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 mbedtls_entropy_add_source(&rng->entropy,
7434 mbedtls_nv_seed_poll, NULL,
7435 MBEDTLS_ENTROPY_BLOCK_SIZE,
7436 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007437#endif
7438
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007440#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007441}
7442
7443/** Deinitialize the PSA random generator.
7444 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007445static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007446{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007447#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007449#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7451 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007452#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007453}
7454
7455/** Seed the PSA random generator.
7456 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007457static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007458{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007459#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7460 /* Do nothing: the external RNG seeds itself. */
7461 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007463#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007464 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7466 drbg_seed, sizeof(drbg_seed) - 1);
7467 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007468#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007469}
7470
Gilles Peskine449bd832023-01-11 14:50:10 +01007471psa_status_t psa_generate_random(uint8_t *output,
7472 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007473{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007474 GUARD_MODULE_INITIALIZED;
7475
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007476#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7477
7478 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7480 output, output_size,
7481 &output_length);
7482 if (status != PSA_SUCCESS) {
7483 return status;
7484 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007485 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007486 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 if (output_length != output_size) {
7488 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7489 }
7490 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007491
7492#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007495 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7497 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7498 output_size);
7499 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7500 output, request_size);
7501 if (ret != 0) {
7502 return mbedtls_to_psa_error(ret);
7503 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007504 output_size -= request_size;
7505 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007506 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007508#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007509}
7510
Gilles Peskine8814fc42020-12-14 15:33:44 +01007511/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007512 *
7513 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7514 * `psa_generate_random(...)`. The state parameter is ignored since the
7515 * PSA API doesn't support passing an explicit state.
7516 *
7517 * In the non-external case, psa_generate_random() calls an
7518 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7519 * and semantics as mbedtls_psa_get_random(). As an optimization,
7520 * instead of doing this back-and-forth between the PSA API and the
7521 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7522 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007523 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007524#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7525int mbedtls_psa_get_random(void *p_rng,
7526 unsigned char *output,
7527 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007528{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007529 /* This function takes a pointer to the RNG state because that's what
7530 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7531 * its own state internally and doesn't let the caller access that state.
7532 * So we just ignore the state parameter, and in practice we'll pass
7533 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007534 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 psa_status_t status = psa_generate_random(output, output_size);
7536 if (status == PSA_SUCCESS) {
7537 return 0;
7538 } else {
7539 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7540 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007541}
7542#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7543
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007544#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007545psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7546 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007547{
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 if (global_data.initialized) {
7549 return PSA_ERROR_NOT_PERMITTED;
7550 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007551
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7553 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7554 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7555 return PSA_ERROR_INVALID_ARGUMENT;
7556 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007557
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007559}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007560#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007561
Ronald Cron3772afe2021-02-08 16:10:05 +01007562/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007563 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007564 * \param type The key type
7565 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007566 *
7567 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007568 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007569 * \retval #PSA_ERROR_INVALID_ARGUMENT
7570 * The size in bits of the key is not valid.
7571 * \retval #PSA_ERROR_NOT_SUPPORTED
7572 * The type and/or the size in bits of the key or the combination of
7573 * the two is not supported.
7574 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007575static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007577{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007578 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 if (key_type_is_raw_bytes(type)) {
7581 status = psa_validate_unstructured_key_bit_size(type, bits);
7582 if (status != PSA_SUCCESS) {
7583 return status;
7584 }
7585 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007586#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7588 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7589 return PSA_ERROR_NOT_SUPPORTED;
7590 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007591 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007592 return PSA_ERROR_NOT_SUPPORTED;
7593 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007594
Ronald Cron01b2aba2020-10-05 09:42:02 +02007595 /* Accept only byte-aligned keys, for the same reasons as
7596 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 if (bits % 8 != 0) {
7598 return PSA_ERROR_NOT_SUPPORTED;
7599 }
7600 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007601#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007602
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007603#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007605 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 return PSA_SUCCESS;
7607 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007608#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007609
Valerio Settia55f0422023-07-10 15:34:41 +02007610#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007611 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007612 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007613 return PSA_ERROR_NOT_SUPPORTED;
7614 }
7615 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007616#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007617 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007619 }
7620
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007622}
7623
Ronald Cron55ed0592020-10-05 10:30:40 +02007624psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007625 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007627{
7628 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007629 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 if ((attributes->domain_parameters == NULL) &&
7632 (attributes->domain_parameters_size != 0)) {
7633 return PSA_ERROR_INVALID_ARGUMENT;
7634 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007635
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 if (key_type_is_raw_bytes(type)) {
7637 status = psa_generate_random(key_buffer, key_buffer_size);
7638 if (status != PSA_SUCCESS) {
7639 return status;
7640 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007641
David Brown12ca5032021-02-11 11:02:00 -07007642#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 if (type == PSA_KEY_TYPE_DES) {
7644 psa_des_set_key_parity(key_buffer, key_buffer_size);
7645 }
David Brown8107e312021-02-12 08:08:46 -07007646#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007648
Valerio Setti76df8c12023-07-11 14:11:28 +02007649#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7651 return mbedtls_psa_rsa_generate_key(attributes,
7652 key_buffer,
7653 key_buffer_size,
7654 key_buffer_length);
7655 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007656#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007657
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007658#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7660 return mbedtls_psa_ecp_generate_key(attributes,
7661 key_buffer,
7662 key_buffer_size,
7663 key_buffer_length);
7664 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007665#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007666
Valerio Settia55f0422023-07-10 15:34:41 +02007667#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007668 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7669 return mbedtls_psa_ffdh_generate_key(attributes,
7670 key_buffer,
7671 key_buffer_size,
7672 key_buffer_length);
7673 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007674#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007675 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 (void) key_buffer_length;
7677 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007678 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007679
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007681}
Darryl Green0c6575a2018-11-07 16:05:30 +00007682
Gilles Peskine449bd832023-01-11 14:50:10 +01007683psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7684 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007685{
7686 psa_status_t status;
7687 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007688 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007689 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007690
Ronald Cron81709fc2020-11-14 12:10:32 +01007691 *key = MBEDTLS_SVC_KEY_ID_INIT;
7692
Gilles Peskine0f84d622019-09-12 19:03:13 +02007693 /* Reject any attempt to create a zero-length key so that we don't
7694 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 if (psa_get_key_bits(attributes) == 0) {
7696 return PSA_ERROR_INVALID_ARGUMENT;
7697 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007698
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007699 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007700 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7701 return PSA_ERROR_INVALID_ARGUMENT;
7702 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007703
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7705 &slot, &driver);
7706 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007707 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007708 }
Gilles Peskine11792082019-08-06 18:36:36 +02007709
Ronald Cron977c2472020-10-13 08:32:21 +02007710 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307711 * storage ( thus not in the case of generating a key in a secure element
7712 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7713 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 if (slot->key.data == NULL) {
7715 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7716 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007717 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 attributes->core.type, attributes->core.bits);
7719 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007720 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007722
7723 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 attributes->core.type,
7725 attributes->core.bits);
7726 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007727 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 attributes, &key_buffer_size);
7729 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007730 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 }
Ronald Cron977c2472020-10-13 08:32:21 +02007732 }
Ronald Cron977c2472020-10-13 08:32:21 +02007733
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7735 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007736 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 }
Ronald Cron977c2472020-10-13 08:32:21 +02007738 }
7739
Gilles Peskine449bd832023-01-11 14:50:10 +01007740 status = psa_driver_wrapper_generate_key(attributes,
7741 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007742
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 if (status != PSA_SUCCESS) {
7744 psa_remove_key_data_from_memory(slot);
7745 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007746
Gilles Peskine11792082019-08-06 18:36:36 +02007747exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007748 if (status == PSA_SUCCESS) {
7749 status = psa_finish_key_creation(slot, driver, key);
7750 }
7751 if (status != PSA_SUCCESS) {
7752 psa_fail_key_creation(slot, driver);
7753 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007754
Gilles Peskine449bd832023-01-11 14:50:10 +01007755 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007756}
7757
Gilles Peskinee59236f2018-01-27 23:32:46 +01007758/****************************************************************/
7759/* Module setup */
7760/****************************************************************/
7761
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007762#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007763psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 void (* entropy_init)(mbedtls_entropy_context *ctx),
7765 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007766{
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7768 return PSA_ERROR_BAD_STATE;
7769 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007770 global_data.rng.entropy_init = entropy_init;
7771 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007772 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007773}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007774#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007775
Gilles Peskine449bd832023-01-11 14:50:10 +01007776void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007777{
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 psa_wipe_all_key_slots();
7779 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7780 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007781 }
7782 /* Wipe all remaining data, including configuration.
7783 * In particular, this sets all state indicator to the value
7784 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007785 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007786
7787 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007789}
7790
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007791#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7792/** Recover a transaction that was interrupted by a power failure.
7793 *
7794 * This function is called during initialization, before psa_crypto_init()
7795 * returns. If this function returns a failure status, the initialization
7796 * fails.
7797 */
7798static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007800{
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007802 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7803 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 /* TODO - fall through to the failure case until this
7805 * is implemented.
7806 * https://github.com/ARMmbed/mbed-crypto/issues/218
7807 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007808 default:
7809 /* We found an unsupported transaction in the storage.
7810 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007811 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007812 }
7813}
7814#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7815
Gilles Peskine449bd832023-01-11 14:50:10 +01007816psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007817{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007818 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007819
Gilles Peskinec6b69072018-11-20 21:42:52 +01007820 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 if (global_data.initialized != 0) {
7822 return PSA_SUCCESS;
7823 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007824
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007825 /* Init drivers */
7826 status = psa_driver_wrapper_init();
7827 if (status != PSA_SUCCESS) {
7828 goto exit;
7829 }
7830 global_data.drivers_initialized = 1;
7831
Gilles Peskine30524eb2020-11-13 17:02:26 +01007832 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007834 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007835 status = mbedtls_psa_random_seed(&global_data.rng);
7836 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007837 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007839 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007840
Gilles Peskine449bd832023-01-11 14:50:10 +01007841 status = psa_initialize_key_slots();
7842 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01007843 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007844 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007845
Gilles Peskine4b734222019-07-24 15:56:31 +02007846#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007847 status = psa_crypto_load_transaction();
7848 if (status == PSA_SUCCESS) {
7849 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7850 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007851 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007852 }
7853 status = psa_crypto_stop_transaction();
7854 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007855 /* There's no transaction to complete. It's all good. */
7856 status = PSA_SUCCESS;
7857 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007858#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007859
Gilles Peskinec6b69072018-11-20 21:42:52 +01007860 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007861 global_data.initialized = 1;
7862
7863exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007864 if (status != PSA_SUCCESS) {
7865 mbedtls_psa_crypto_free();
7866 }
7867 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007868}
7869
Yanray Wangffc3c482023-07-11 12:01:04 +08007870#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007871psa_status_t psa_crypto_driver_pake_get_password_len(
7872 const psa_crypto_driver_pake_inputs_t *inputs,
7873 size_t *password_len)
7874{
7875 if (inputs->password_len == 0) {
7876 return PSA_ERROR_BAD_STATE;
7877 }
7878
7879 *password_len = inputs->password_len;
7880
7881 return PSA_SUCCESS;
7882}
7883
7884psa_status_t psa_crypto_driver_pake_get_password(
7885 const psa_crypto_driver_pake_inputs_t *inputs,
7886 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7887{
7888 if (inputs->password_len == 0) {
7889 return PSA_ERROR_BAD_STATE;
7890 }
7891
7892 if (buffer_size < inputs->password_len) {
7893 return PSA_ERROR_BUFFER_TOO_SMALL;
7894 }
7895
7896 memcpy(buffer, inputs->password, inputs->password_len);
7897 *buffer_length = inputs->password_len;
7898
7899 return PSA_SUCCESS;
7900}
7901
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007902psa_status_t psa_crypto_driver_pake_get_user_len(
7903 const psa_crypto_driver_pake_inputs_t *inputs,
7904 size_t *user_len)
7905{
7906 if (inputs->user_len == 0) {
7907 return PSA_ERROR_BAD_STATE;
7908 }
7909
7910 *user_len = inputs->user_len;
7911
7912 return PSA_SUCCESS;
7913}
7914
7915psa_status_t psa_crypto_driver_pake_get_user(
7916 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007917 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007918{
7919 if (inputs->user_len == 0) {
7920 return PSA_ERROR_BAD_STATE;
7921 }
7922
Przemek Stekielc0e62502023-03-14 11:49:36 +01007923 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007924 return PSA_ERROR_BUFFER_TOO_SMALL;
7925 }
7926
Przemek Stekielc0e62502023-03-14 11:49:36 +01007927 memcpy(user_id, inputs->user, inputs->user_len);
7928 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007929
7930 return PSA_SUCCESS;
7931}
7932
7933psa_status_t psa_crypto_driver_pake_get_peer_len(
7934 const psa_crypto_driver_pake_inputs_t *inputs,
7935 size_t *peer_len)
7936{
7937 if (inputs->peer_len == 0) {
7938 return PSA_ERROR_BAD_STATE;
7939 }
7940
7941 *peer_len = inputs->peer_len;
7942
7943 return PSA_SUCCESS;
7944}
7945
7946psa_status_t psa_crypto_driver_pake_get_peer(
7947 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007948 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007949{
7950 if (inputs->peer_len == 0) {
7951 return PSA_ERROR_BAD_STATE;
7952 }
7953
Przemek Stekielc0e62502023-03-14 11:49:36 +01007954 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007955 return PSA_ERROR_BUFFER_TOO_SMALL;
7956 }
7957
Przemek Stekielc0e62502023-03-14 11:49:36 +01007958 memcpy(peer_id, inputs->peer, inputs->peer_len);
7959 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007960
7961 return PSA_SUCCESS;
7962}
7963
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007964psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7965 const psa_crypto_driver_pake_inputs_t *inputs,
7966 psa_pake_cipher_suite_t *cipher_suite)
7967{
7968 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7969 return PSA_ERROR_BAD_STATE;
7970 }
7971
7972 *cipher_suite = inputs->cipher_suite;
7973
7974 return PSA_SUCCESS;
7975}
7976
Neil Armstronga7d08c32022-06-01 18:21:20 +02007977psa_status_t psa_pake_setup(
7978 psa_pake_operation_t *operation,
7979 const psa_pake_cipher_suite_t *cipher_suite)
7980{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007981 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007982
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007983 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007984 status = PSA_ERROR_BAD_STATE;
7985 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007986 }
7987
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007988 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007989 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007990 status = PSA_ERROR_INVALID_ARGUMENT;
7991 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007992 }
7993
Przemek Stekiel51eac532022-12-07 11:04:51 +01007994 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7995
Przemek Stekiele12ed362022-12-21 12:54:46 +01007996 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007997 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7998 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007999 operation->data.inputs.cipher_suite = *cipher_suite;
8000
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008001#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008002 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008003 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008004 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008005
David Horstmann16f01512023-06-14 17:21:07 +01008006 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008007 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008008 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008009#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008010 {
8011 status = PSA_ERROR_NOT_SUPPORTED;
8012 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008013 }
8014
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008015 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8016
Przemek Stekiel51eac532022-12-07 11:04:51 +01008017 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008018exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008019 psa_pake_abort(operation);
8020 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008021}
8022
8023psa_status_t psa_pake_set_password_key(
8024 psa_pake_operation_t *operation,
8025 mbedtls_svc_key_id_t password)
8026{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008027 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008028 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8029 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008030 psa_key_attributes_t attributes;
8031 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008032
Przemek Stekiel51eac532022-12-07 11:04:51 +01008033 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008034 status = PSA_ERROR_BAD_STATE;
8035 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008036 }
8037
Przemek Stekiel6c764412022-11-22 14:05:12 +01008038 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8039 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008040 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008041 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008042 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008043 }
8044
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008045 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008046 .core = slot->attr
8047 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008048
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008049 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008050
Przemek Stekiel51eac532022-12-07 11:04:51 +01008051 if (type != PSA_KEY_TYPE_PASSWORD &&
8052 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8053 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008054 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008055 }
8056
Przemek Stekiel51eac532022-12-07 11:04:51 +01008057 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8058 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008059 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008060 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008061 }
8062
8063 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8064 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008065 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008066exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008067 if (status != PSA_SUCCESS) {
8068 psa_pake_abort(operation);
8069 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008070 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008071 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008072}
8073
8074psa_status_t psa_pake_set_user(
8075 psa_pake_operation_t *operation,
8076 const uint8_t *user_id,
8077 size_t user_id_len)
8078{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008079 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008080
8081 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008082 status = PSA_ERROR_BAD_STATE;
8083 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008084 }
8085
Przemek Stekiel51eac532022-12-07 11:04:51 +01008086 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008087 status = PSA_ERROR_INVALID_ARGUMENT;
8088 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008089 }
8090
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008091 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008092 status = PSA_ERROR_BAD_STATE;
8093 goto exit;
8094 }
8095
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008096 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8097 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008098 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8099 goto exit;
8100 }
8101
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008102 memcpy(operation->data.inputs.user, user_id, user_id_len);
8103 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008104
8105 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008106exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008107 psa_pake_abort(operation);
8108 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008109}
8110
8111psa_status_t psa_pake_set_peer(
8112 psa_pake_operation_t *operation,
8113 const uint8_t *peer_id,
8114 size_t peer_id_len)
8115{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008116 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008117
8118 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008119 status = PSA_ERROR_BAD_STATE;
8120 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008121 }
8122
Przemek Stekiel51eac532022-12-07 11:04:51 +01008123 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008124 status = PSA_ERROR_INVALID_ARGUMENT;
8125 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008126 }
8127
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008128 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008129 status = PSA_ERROR_BAD_STATE;
8130 goto exit;
8131 }
8132
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008133 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8134 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008135 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8136 goto exit;
8137 }
8138
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008139 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8140 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008141
8142 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008143exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008144 psa_pake_abort(operation);
8145 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008146}
8147
8148psa_status_t psa_pake_set_role(
8149 psa_pake_operation_t *operation,
8150 psa_pake_role_t role)
8151{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008152 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008153
Przemek Stekiel51eac532022-12-07 11:04:51 +01008154 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008155 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008156 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008157 }
8158
Przemek Stekiel09104b82023-03-06 14:11:51 +01008159 switch (operation->alg) {
8160#if defined(PSA_WANT_ALG_JPAKE)
8161 case PSA_ALG_JPAKE:
8162 if (role == PSA_PAKE_ROLE_NONE) {
8163 return PSA_SUCCESS;
8164 }
8165 status = PSA_ERROR_INVALID_ARGUMENT;
8166 break;
8167#endif
8168 default:
8169 (void) role;
8170 status = PSA_ERROR_NOT_SUPPORTED;
8171 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008172 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008173exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008174 psa_pake_abort(operation);
8175 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008176}
8177
David Horstmanne7f21e62023-05-12 18:17:21 +01008178/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008179#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008180static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008181 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008182{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008183 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008184 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008185 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008186
David Horstmann024e5c52023-06-14 15:48:21 +01008187 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008188 is_x1 = (stage->outputs < 1);
8189 } else {
8190 is_x1 = (stage->inputs < 1);
8191 }
8192
David Horstmann74a3d8c2023-06-14 18:28:19 +01008193 key_share_step = is_x1 ?
8194 PSA_JPAKE_X1_STEP_KEY_SHARE :
8195 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008196 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008197 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8198 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8199 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8200 } else {
8201 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008202 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008203 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008204}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008205#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008206
Przemek Stekiel2797d372022-12-22 11:19:22 +01008207static psa_status_t psa_pake_complete_inputs(
8208 psa_pake_operation_t *operation)
8209{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008210 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008211 /* Create copy of the inputs on stack as inputs share memory
8212 with the driver context which will be setup by the driver. */
8213 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008214
Przemek Stekielfde11282023-03-13 16:06:09 +01008215 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008216 return PSA_ERROR_BAD_STATE;
8217 }
8218
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008219 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008220 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8221 return PSA_ERROR_BAD_STATE;
8222 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008223 }
8224
Przemek Stekiel18620a32023-01-17 16:34:52 +01008225 /* Clear driver context */
8226 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8227
8228 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008229
8230 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008231 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008232
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008233 /* User and peer are translated to role. */
8234 mbedtls_free(inputs.user);
8235 mbedtls_free(inputs.peer);
8236
Przemek Stekiel2797d372022-12-22 11:19:22 +01008237 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008238#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008239 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008240 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008241 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008242#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008243 {
8244 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008245 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008246 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008247 return status;
8248}
8249
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008250#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008251static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008252 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008253 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008254 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008255{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008256 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8257 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8258 step != PSA_PAKE_STEP_ZK_PROOF) {
8259 return PSA_ERROR_INVALID_ARGUMENT;
8260 }
8261
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008262 psa_jpake_computation_stage_t *computation_stage =
8263 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008264
David Horstmann5da95602023-06-08 15:37:12 +01008265 if (computation_stage->round != PSA_JPAKE_FIRST &&
8266 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008267 return PSA_ERROR_BAD_STATE;
8268 }
8269
David Horstmanne7f21e62023-05-12 18:17:21 +01008270 /* Check that the step we are given is the one we were expecting */
8271 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008272 return PSA_ERROR_BAD_STATE;
8273 }
8274
David Horstmanne7f21e62023-05-12 18:17:21 +01008275 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8276 computation_stage->inputs == 0 &&
8277 computation_stage->outputs == 0) {
8278 /* Start of the round, so function decides whether we are inputting
8279 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008280 computation_stage->io_mode = io_mode;
8281 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008282 /* Middle of the round so the mode we are in must match the function
8283 * called by the user */
8284 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008285 }
8286
8287 return PSA_SUCCESS;
8288}
8289
David Horstmanne7f21e62023-05-12 18:17:21 +01008290static psa_status_t psa_jpake_epilogue(
8291 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008292 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008293{
David Horstmanne7f21e62023-05-12 18:17:21 +01008294 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008295 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008296
David Horstmanne7f21e62023-05-12 18:17:21 +01008297 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8298 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008299 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008300 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008301 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008302 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008303 }
8304 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008305 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008306 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008307 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008308 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008309 }
8310 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008311 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8312 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008313 /* End of a round, move to the next round */
8314 stage->inputs = 0;
8315 stage->outputs = 0;
8316 stage->round++;
8317 }
8318 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008319 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008320 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008321 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008322 return PSA_SUCCESS;
8323}
David Horstmanne7f21e62023-05-12 18:17:21 +01008324
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008325#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008326
Neil Armstronga7d08c32022-06-01 18:21:20 +02008327psa_status_t psa_pake_output(
8328 psa_pake_operation_t *operation,
8329 psa_pake_step_t step,
8330 uint8_t *output,
8331 size_t output_size,
8332 size_t *output_length)
8333{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008334 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008335 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008336 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008337
8338 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008339 status = psa_pake_complete_inputs(operation);
8340 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008341 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008342 }
8343 }
8344
8345 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008346 status = PSA_ERROR_BAD_STATE;
8347 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008348 }
8349
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008350 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008351 status = PSA_ERROR_INVALID_ARGUMENT;
8352 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008353 }
8354
Przemek Stekiele12ed362022-12-21 12:54:46 +01008355 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008356#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008357 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008358 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008359 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008360 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008361 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008362 driver_step = convert_jpake_computation_stage_to_driver_step(
8363 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008364 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008365#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008366 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008367 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008368 status = PSA_ERROR_NOT_SUPPORTED;
8369 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008370 }
8371
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008372 status = psa_driver_wrapper_pake_output(operation, driver_step,
8373 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008374
8375 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008376 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008377 }
8378
8379 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008380#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008381 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008382 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008383 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008384 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008385 }
8386 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008387#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008388 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008389 status = PSA_ERROR_NOT_SUPPORTED;
8390 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008391 }
8392
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008393 return PSA_SUCCESS;
8394exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008395 psa_pake_abort(operation);
8396 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008397}
8398
8399psa_status_t psa_pake_input(
8400 psa_pake_operation_t *operation,
8401 psa_pake_step_t step,
8402 const uint8_t *input,
8403 size_t input_length)
8404{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008406 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008407 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8408 operation->primitive,
8409 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008410
8411 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008412 status = psa_pake_complete_inputs(operation);
8413 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008414 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008415 }
8416 }
8417
8418 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008419 status = PSA_ERROR_BAD_STATE;
8420 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008421 }
8422
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008423 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008424 status = PSA_ERROR_INVALID_ARGUMENT;
8425 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008426 }
8427
Przemek Stekiele12ed362022-12-21 12:54:46 +01008428 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008429#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008430 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008431 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008432 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008433 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008434 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008435 driver_step = convert_jpake_computation_stage_to_driver_step(
8436 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008437 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008438#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008439 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008440 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008441 status = PSA_ERROR_NOT_SUPPORTED;
8442 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008443 }
8444
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008445 status = psa_driver_wrapper_pake_input(operation, driver_step,
8446 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008447
8448 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008449 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008450 }
8451
8452 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008453#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008454 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008455 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008456 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008457 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008458 }
8459 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008460#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008461 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008462 status = PSA_ERROR_NOT_SUPPORTED;
8463 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008464 }
8465
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008466 return PSA_SUCCESS;
8467exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008468 psa_pake_abort(operation);
8469 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008470}
8471
8472psa_status_t psa_pake_get_implicit_key(
8473 psa_pake_operation_t *operation,
8474 psa_key_derivation_operation_t *output)
8475{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008476 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008477 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008478 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008479 size_t shared_key_len = 0;
8480
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008481 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008482 status = PSA_ERROR_BAD_STATE;
8483 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008484 }
8485
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008486#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008487 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008488 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008489 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008490 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008491 status = PSA_ERROR_BAD_STATE;
8492 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008493 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008494 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008495#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008496 {
8497 status = PSA_ERROR_NOT_SUPPORTED;
8498 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008499 }
8500
Przemek Stekiel0c781802022-11-29 14:53:13 +01008501 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8502 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008503 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008504 &shared_key_len);
8505
8506 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008507 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008508 }
8509
8510 status = psa_key_derivation_input_bytes(output,
8511 PSA_KEY_DERIVATION_INPUT_SECRET,
8512 shared_key,
8513 shared_key_len);
8514
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008515 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008516exit:
8517 abort_status = psa_pake_abort(operation);
8518 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008519}
8520
8521psa_status_t psa_pake_abort(
8522 psa_pake_operation_t *operation)
8523{
Przemek Stekield69dca92023-01-31 19:59:20 +01008524 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008525
Przemek Stekield69dca92023-01-31 19:59:20 +01008526 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008527 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008528 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008529
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008530 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8531 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008532 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008533 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008534 }
8535 if (operation->data.inputs.user != NULL) {
8536 mbedtls_free(operation->data.inputs.user);
8537 }
8538 if (operation->data.inputs.peer != NULL) {
8539 mbedtls_free(operation->data.inputs.peer);
8540 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008541 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008542 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008543
Przemek Stekield69dca92023-01-31 19:59:20 +01008544 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008545}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008546#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008547
David Horstmann00d7a042023-12-07 18:39:17 +00008548/* Memory copying test hooks. These are called before input copy, after input
8549 * copy, before output copy and after output copy, respectively.
8550 * They are used by memory-poisoning tests to temporarily unpoison buffers
8551 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008552#if defined(MBEDTLS_TEST_HOOKS)
8553void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8554void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8555void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8556void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8557#endif
David Horstmannfde97392023-10-30 20:29:43 +00008558
David Horstmann1b7279a2023-11-15 15:18:30 +00008559/** Copy from an input buffer to a local copy.
8560 *
8561 * \param[in] input Pointer to input buffer.
8562 * \param[in] input_len Length of the input buffer.
8563 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8564 * \param[out] input_copy_len Length of the local copy buffer.
8565 * \return #PSA_SUCCESS, if the buffer was successfully
8566 * copied.
8567 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8568 * copy is too small to hold contents of the
8569 * input buffer.
8570 */
8571MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008572psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8573 uint8_t *input_copy, size_t input_copy_len)
8574{
8575 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008576 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008577 }
8578
David Horstmann372b8bb2023-11-24 16:21:04 +00008579#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008580 if (psa_input_pre_copy_hook != NULL) {
8581 psa_input_pre_copy_hook(input, input_len);
8582 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008583#endif
8584
David Horstmann777e7412023-11-15 17:33:47 +00008585 if (input_len > 0) {
8586 memcpy(input_copy, input, input_len);
8587 }
David Horstmannfde97392023-10-30 20:29:43 +00008588
David Horstmann372b8bb2023-11-24 16:21:04 +00008589#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008590 if (psa_input_post_copy_hook != NULL) {
8591 psa_input_post_copy_hook(input, input_len);
8592 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008593#endif
8594
David Horstmannfde97392023-10-30 20:29:43 +00008595 return PSA_SUCCESS;
8596}
8597
David Horstmann1b7279a2023-11-15 15:18:30 +00008598/** Copy from a local output buffer into a user-supplied one.
8599 *
8600 * \param[in] output_copy Pointer to a local buffer containing the output.
8601 * \param[in] output_copy_len Length of the local buffer.
8602 * \param[out] output Pointer to user-supplied output buffer.
8603 * \param[out] output_len Length of the user-supplied output buffer.
8604 * \return #PSA_SUCCESS, if the buffer was successfully
8605 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008606 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008607 * user-supplied output buffer is too small to
8608 * hold the contents of the local buffer.
8609 */
8610MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008611psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8612 uint8_t *output, size_t output_len)
8613{
8614 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008615 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008616 }
David Horstmann777e7412023-11-15 17:33:47 +00008617
David Horstmann372b8bb2023-11-24 16:21:04 +00008618#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008619 if (psa_output_pre_copy_hook != NULL) {
8620 psa_output_pre_copy_hook(output, output_len);
8621 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008622#endif
8623
David Horstmann777e7412023-11-15 17:33:47 +00008624 if (output_copy_len > 0) {
8625 memcpy(output, output_copy, output_copy_len);
8626 }
8627
David Horstmann372b8bb2023-11-24 16:21:04 +00008628#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008629 if (psa_output_post_copy_hook != NULL) {
8630 psa_output_post_copy_hook(output, output_len);
8631 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008632#endif
8633
David Horstmann8978f5c2023-10-30 20:37:12 +00008634 return PSA_SUCCESS;
8635}
8636
David Horstmannf1734052023-11-20 17:15:32 +00008637psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8638 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008639{
8640 psa_status_t status;
8641
David Horstmann9db14482023-11-23 15:50:37 +00008642 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008643
David Horstmannc5cc1c32023-11-15 18:11:26 +00008644 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008645 return PSA_SUCCESS;
8646 }
8647
David Horstmannf1734052023-11-20 17:15:32 +00008648 local_input->buffer = mbedtls_calloc(input_len, 1);
8649 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008650 /* Since we dealt with the zero-length case above, we know that
8651 * a NULL return value means a failure of allocation. */
8652 return PSA_ERROR_INSUFFICIENT_MEMORY;
8653 }
David Horstmannf1734052023-11-20 17:15:32 +00008654 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008655
David Horstmannf1734052023-11-20 17:15:32 +00008656 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008657
8658 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008659 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008660 if (status != PSA_SUCCESS) {
8661 goto error;
8662 }
8663
8664 return PSA_SUCCESS;
8665
8666error:
David Horstmannf1734052023-11-20 17:15:32 +00008667 mbedtls_free(local_input->buffer);
8668 local_input->buffer = NULL;
8669 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008670 return status;
8671}
8672
David Horstmannf1734052023-11-20 17:15:32 +00008673void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008674{
David Horstmannf1734052023-11-20 17:15:32 +00008675 mbedtls_free(local_input->buffer);
8676 local_input->buffer = NULL;
8677 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008678}
8679
David Horstmann89875a42023-11-20 12:54:09 +00008680psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8681 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008682{
David Horstmann9db14482023-11-23 15:50:37 +00008683 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008684
David Horstmannc5cc1c32023-11-15 18:11:26 +00008685 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008686 return PSA_SUCCESS;
8687 }
David Horstmann89875a42023-11-20 12:54:09 +00008688 local_output->buffer = mbedtls_calloc(output_len, 1);
8689 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008690 /* Since we dealt with the zero-length case above, we know that
8691 * a NULL return value means a failure of allocation. */
8692 return PSA_ERROR_INSUFFICIENT_MEMORY;
8693 }
David Horstmann89875a42023-11-20 12:54:09 +00008694 local_output->length = output_len;
8695 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008696
8697 return PSA_SUCCESS;
8698}
8699
David Horstmann89875a42023-11-20 12:54:09 +00008700psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008701{
David Horstmannc335a4e2023-11-15 15:57:32 +00008702 psa_status_t status;
8703
David Horstmann89875a42023-11-20 12:54:09 +00008704 if (local_output->buffer == NULL) {
8705 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008706 return PSA_SUCCESS;
8707 }
David Horstmann89875a42023-11-20 12:54:09 +00008708 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008709 /* We have an internal copy but nothing to copy back to. */
8710 return PSA_ERROR_CORRUPTION_DETECTED;
8711 }
8712
David Horstmann89875a42023-11-20 12:54:09 +00008713 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8714 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008715 if (status != PSA_SUCCESS) {
8716 return status;
8717 }
David Horstmann9467ea32023-11-08 17:44:18 +00008718
David Horstmann89875a42023-11-20 12:54:09 +00008719 mbedtls_free(local_output->buffer);
8720 local_output->buffer = NULL;
8721 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008722
8723 return PSA_SUCCESS;
8724}
8725
Gilles Peskinee59236f2018-01-27 23:32:46 +01008726#endif /* MBEDTLS_PSA_CRYPTO_C */