blob: 575c08cab9dcad470d40ff695d8169e8bdb55cdd [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 Horstmanne9a88ab2023-11-29 17:07:13 +0000114/* Substitute an input buffer for a local copy of itself.
115 * Assumptions:
116 * - psa_status_t status exists
117 * - An exit label is declared
David Horstmann3e72db42023-12-08 14:08:18 +0000118 * - The name <input>_copy is not used for the given value of <input>
David Horstmanne9a88ab2023-11-29 17:07:13 +0000119 */
120#define SWAP_FOR_LOCAL_INPUT(input, length) \
121 psa_crypto_local_input_t input ## _copy = PSA_CRYPTO_LOCAL_INPUT_INIT; \
122 status = psa_crypto_local_input_alloc(input, length, &input ## _copy); \
123 if (status != PSA_SUCCESS) { \
124 goto exit; \
125 } \
126 input = input ## _copy.buffer;
127
David Horstmann3e72db42023-12-08 14:08:18 +0000128/* Free the substituted input buffer copy created by SWAP_FOR_LOCAL_INPUT().
129 * Note that this does not restore the pointer to the original buffer.
130 * Assumptions:
131 * - psa_crypto_local_input_t <input>_copy exists, for the given value of
132 * <input>
133 * - <input>_copy was previously allocated by psa_crypto_local_input_alloc()
134 * - <input> points to <input>_copy.buffer
135 */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000136#define FREE_LOCAL_INPUT(input) \
David Horstmann3e72db42023-12-08 14:08:18 +0000137 input = NULL; \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000138 psa_crypto_local_input_free(&input ## _copy);
139
140/* Substitute an output buffer for a local copy of itself.
141 * Assumptions:
142 * - psa_status_t status exists
143 * - An exit label is declared
David Horstmann3e72db42023-12-08 14:08:18 +0000144 * - The name <output>_copy is not used for the given value of <output>
David Horstmanne9a88ab2023-11-29 17:07:13 +0000145 */
146#define SWAP_FOR_LOCAL_OUTPUT(output, length) \
147 psa_crypto_local_output_t output ## _copy = PSA_CRYPTO_LOCAL_OUTPUT_INIT; \
148 status = psa_crypto_local_output_alloc(output, length, &output ## _copy); \
149 if (status != PSA_SUCCESS) { \
150 goto exit; \
151 } \
152 output = output ## _copy.buffer;
153
David Horstmann3e72db42023-12-08 14:08:18 +0000154/* Free the substituted output buffer copy created by SWAP_FOR_LOCAL_OUTPUT()
155 * after first copying back its contents to the original buffer.
156 * Note that this does not restore the pointer to the original buffer.
157 * Assumptions:
158 * - psa_crypto_local_output_t <output>_copy exists, for the given value of
159 * <output>
160 * - <output>_copy was previously allocated by psa_crypto_local_output_alloc()
161 * - <output> points to <output>_copy.buffer
162 * - psa_status_t status exists
163 */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000164#define FREE_LOCAL_OUTPUT(output) \
David Horstmann3e72db42023-12-08 14:08:18 +0000165 output = NULL; \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000166 psa_status_t local_output_free_status; \
167 local_output_free_status = psa_crypto_local_output_free(&output ## _copy); \
168 if (local_output_free_status != PSA_SUCCESS) { \
David Horstmann3e72db42023-12-08 14:08:18 +0000169 /* Since this error case is an internal error, it's more serious than \
170 * any existing error code and so it's fine to overwrite the existing \
171 * status. */ \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000172 status = local_output_free_status; \
173 }
David Horstmann513101b2023-11-29 17:24:08 +0000174#else /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
175#define SWAP_FOR_LOCAL_INPUT(input, length)
176#define FREE_LOCAL_INPUT(input)
177#define SWAP_FOR_LOCAL_OUTPUT(output, length)
178#define FREE_LOCAL_OUTPUT(output)
179#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000180
181
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100182int psa_can_do_hash(psa_algorithm_t hash_alg)
183{
184 (void) hash_alg;
185 return global_data.drivers_initialized;
186}
Valerio Settia55f0422023-07-10 15:34:41 +0200187#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200188 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200189 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200190static int psa_is_dh_key_size_valid(size_t bits)
191{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200192 if (bits != 2048 && bits != 3072 && bits != 4096 &&
193 bits != 6144 && bits != 8192) {
194 return 0;
195 }
196
197 return 1;
198}
Valerio Settia55f0422023-07-10 15:34:41 +0200199#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200200 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200201 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100202
Gilles Peskine449bd832023-01-11 14:50:10 +0100203psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100204{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100205 /* Mbed TLS error codes can combine a high-level error code and a
206 * low-level error code. The low-level error usually reflects the
207 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100208 int low_level_ret = -(-ret & 0x007f);
209 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100210 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100212
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100213#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100214 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
215 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100216 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100217 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
218 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100219#endif
220
221#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200222 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
223 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
224 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
225 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
226 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200228 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200230 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100232#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200233
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100234#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000235 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100236 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100237 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100238#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100239
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100240#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100241 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100243 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100245#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100246
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100247#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200248 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100250#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200251
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100252#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200253 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200255 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100256 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100257#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200258
Dave Rodgman509b5672023-08-16 19:26:23 +0100259#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100260 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100262 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100264 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100266 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100268 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100270 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100272 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100274#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100275
Gilles Peskine449bd832023-01-11 14:50:10 +0100276#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
277 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100278 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
279 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100280 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100282 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
283 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100285 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100286 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100287#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100288
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100289#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100290 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100292#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100293
Gilles Peskinee59236f2018-01-27 23:32:46 +0100294 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
295 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
296 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100297 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100298
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100299#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100300 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200302 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100304 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100306#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100307
Gilles Peskine82e57d12020-11-13 21:31:17 +0100308#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100309 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100310 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
311 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100312 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100313 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100314 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
315 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100317 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100319#endif
320
Dave Rodgmandea266f2023-08-31 11:52:43 +0100321#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100322 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100326 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100328#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100329 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100331#endif
332#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100333
Dave Rodgman509b5672023-08-16 19:26:23 +0100334#if defined(MBEDTLS_BIGNUM_C)
335#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100336 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100338#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100339 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100341 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100343 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100345 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100347 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100349 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100351 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100353#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100354
Dave Rodgman509b5672023-08-16 19:26:23 +0100355#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100356 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100358 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
359 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100361#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
362 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100363 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100364 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100365#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100366 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
367 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100369 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100371 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
372 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100373 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100374 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100375 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100376 case MBEDTLS_ERR_PK_INVALID_ALG:
377 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
378 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100380 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200382 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100384#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100385
Gilles Peskineff2d2002019-05-06 15:26:23 +0200386 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200388 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100389 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200390
Dave Rodgman509b5672023-08-16 19:26:23 +0100391#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100392 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100393 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100394 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100396 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100397 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100398 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100400 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
401 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100403 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100405 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100407 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100408 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100409#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200410
Dave Rodgman1dab4452023-09-01 09:59:51 +0100411#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300412 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300413 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100414 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300415 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300417 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300419 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
420 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300422 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100424 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100425 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100426
Dave Rodgman509b5672023-08-16 19:26:23 +0100427#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000428 case MBEDTLS_ERR_ECP_IN_PROGRESS:
429 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100430#endif
431#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000432
Janos Follatha13b9052019-11-22 12:48:59 +0000433 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300435
Gilles Peskinee59236f2018-01-27 23:32:46 +0100436 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100438 }
439}
440
Paul Elliottdc42ca82023-02-24 18:11:59 +0000441/**
442 * \brief For output buffers which contain "tags"
443 * (outputs that may be checked for validity like
444 * hashes, MACs and signatures), fill the unused
445 * part of the output buffer (the whole buffer on
446 * error, the trailing part on success) with
447 * something that isn't a valid tag (barring an
448 * attack on the tag and deliberately-crafted
449 * input), in case the caller doesn't check the
450 * return status properly.
451 *
452 * \param output_buffer Pointer to buffer to wipe. May not be NULL
453 * unless \p output_buffer_size is zero.
454 * \param status Status of function called to generate
455 * output_buffer originally
456 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
457 * could be NULL.
458 * \param output_buffer_length Length of data written to output_buffer, must be
459 * less than \p output_buffer_size
460 */
461static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000462 size_t output_buffer_size, size_t output_buffer_length)
463{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000464 size_t offset = 0;
465
466 if (output_buffer_size == 0) {
467 /* If output_buffer_size is 0 then we have nothing to do. We must not
468 call memset because output_buffer may be NULL in this case */
469 return;
470 }
471
472 if (status == PSA_SUCCESS) {
473 offset = output_buffer_length;
474 }
475
476 memset(output_buffer + offset, '!', output_buffer_size - offset);
477}
478
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200479
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200480
481
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100482/****************************************************************/
483/* Key management */
484/****************************************************************/
485
Valerio Settia9aab1a2023-06-19 13:39:54 +0200486#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200487psa_ecc_family_t mbedtls_ecc_group_to_psa(mbedtls_ecp_group_id grpid,
488 size_t *bits)
489{
490 switch (grpid) {
Valerio Settic437fae2023-09-08 14:58:03 +0200491#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200492 case MBEDTLS_ECP_DP_SECP192R1:
493 *bits = 192;
494 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100495#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200496#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200497 case MBEDTLS_ECP_DP_SECP224R1:
498 *bits = 224;
499 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100500#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200501#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200502 case MBEDTLS_ECP_DP_SECP256R1:
503 *bits = 256;
504 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100505#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200506#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200507 case MBEDTLS_ECP_DP_SECP384R1:
508 *bits = 384;
509 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100510#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200511#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200512 case MBEDTLS_ECP_DP_SECP521R1:
513 *bits = 521;
514 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100515#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200516#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200517 case MBEDTLS_ECP_DP_BP256R1:
518 *bits = 256;
519 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100520#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200521#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200522 case MBEDTLS_ECP_DP_BP384R1:
523 *bits = 384;
524 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100525#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200526#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200527 case MBEDTLS_ECP_DP_BP512R1:
528 *bits = 512;
529 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100530#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200531#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200532 case MBEDTLS_ECP_DP_CURVE25519:
533 *bits = 255;
534 return PSA_ECC_FAMILY_MONTGOMERY;
Dave Rodgman6f682032023-08-16 18:44:32 +0100535#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200536#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200537 case MBEDTLS_ECP_DP_SECP192K1:
538 *bits = 192;
539 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100540#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200541#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200542 case MBEDTLS_ECP_DP_SECP224K1:
543 *bits = 224;
544 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100545#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200546#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200547 case MBEDTLS_ECP_DP_SECP256K1:
548 *bits = 256;
549 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100550#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200551#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200552 case MBEDTLS_ECP_DP_CURVE448:
553 *bits = 448;
554 return PSA_ECC_FAMILY_MONTGOMERY;
Dave Rodgman6f682032023-08-16 18:44:32 +0100555#endif
Valerio Settibc2b1d32023-06-19 12:15:13 +0200556 default:
557 *bits = 0;
558 return 0;
559 }
560}
561
Gilles Peskine449bd832023-01-11 14:50:10 +0100562mbedtls_ecp_group_id mbedtls_ecc_group_of_psa(psa_ecc_family_t curve,
563 size_t bits,
564 int bits_is_sloppy)
Gilles Peskine12313cd2018-06-20 00:20:32 +0200565{
Gilles Peskine449bd832023-01-11 14:50:10 +0100566 switch (curve) {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100567 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100569#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100570 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 return MBEDTLS_ECP_DP_SECP192R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100572#endif
573#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100574 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 return MBEDTLS_ECP_DP_SECP224R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100576#endif
577#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100578 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_ECP_DP_SECP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100580#endif
581#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100582 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 return MBEDTLS_ECP_DP_SECP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100584#endif
585#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100586 case 521:
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 return MBEDTLS_ECP_DP_SECP521R1;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100588 case 528:
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 if (bits_is_sloppy) {
590 return MBEDTLS_ECP_DP_SECP521R1;
591 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100592 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100593#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100594 }
595 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100596
Paul Elliott8ff510a2020-06-02 17:19:28 +0100597 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100599#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100600 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 return MBEDTLS_ECP_DP_BP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100602#endif
603#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100604 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100605 return MBEDTLS_ECP_DP_BP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100606#endif
607#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100608 case 512:
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return MBEDTLS_ECP_DP_BP512R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100610#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100611 }
612 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100613
Paul Elliott8ff510a2020-06-02 17:19:28 +0100614 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100615 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100616#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100617 case 255:
Gilles Peskine449bd832023-01-11 14:50:10 +0100618 return MBEDTLS_ECP_DP_CURVE25519;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100619 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100620 if (bits_is_sloppy) {
621 return MBEDTLS_ECP_DP_CURVE25519;
622 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100623 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100624#endif
625#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100626 case 448:
Gilles Peskine449bd832023-01-11 14:50:10 +0100627 return MBEDTLS_ECP_DP_CURVE448;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100628#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100629 }
630 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100631
Paul Elliott8ff510a2020-06-02 17:19:28 +0100632 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100633 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100634#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100635 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100636 return MBEDTLS_ECP_DP_SECP192K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100637#endif
638#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100639 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100640 return MBEDTLS_ECP_DP_SECP224K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100641#endif
642#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100643 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100644 return MBEDTLS_ECP_DP_SECP256K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100645#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100646 }
647 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200648 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100649
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100650 (void) bits_is_sloppy;
Gilles Peskine449bd832023-01-11 14:50:10 +0100651 return MBEDTLS_ECP_DP_NONE;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200652}
Valerio Settia9aab1a2023-06-19 13:39:54 +0200653#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200654
Gilles Peskine449bd832023-01-11 14:50:10 +0100655psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
656 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200657{
658 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100659 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200660 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200661 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200662 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200663 case PSA_KEY_TYPE_PASSWORD:
664 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200665 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100666#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200667 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100668 if (bits != 128 && bits != 192 && bits != 256) {
669 return PSA_ERROR_INVALID_ARGUMENT;
670 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200671 break;
672#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200673#if defined(PSA_WANT_KEY_TYPE_ARIA)
674 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 if (bits != 128 && bits != 192 && bits != 256) {
676 return PSA_ERROR_INVALID_ARGUMENT;
677 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200678 break;
679#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100680#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200681 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 if (bits != 128 && bits != 192 && bits != 256) {
683 return PSA_ERROR_INVALID_ARGUMENT;
684 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200685 break;
686#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100687#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200688 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 if (bits != 64 && bits != 128 && bits != 192) {
690 return PSA_ERROR_INVALID_ARGUMENT;
691 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200692 break;
693#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100694#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200695 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 if (bits != 256) {
697 return PSA_ERROR_INVALID_ARGUMENT;
698 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200699 break;
700#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200701 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200703 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 if (bits % 8 != 0) {
705 return PSA_ERROR_INVALID_ARGUMENT;
706 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200707
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200709}
710
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100711/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100712 *
Steven Cooremancd640932021-03-08 12:00:27 +0100713 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
714 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100715 *
716 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100717 * \param[in] key_type The key type of the key to be used with the
718 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100719 *
720 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100721 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100722 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100723 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100724 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100725MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100726 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100727 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100728{
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 if (PSA_ALG_IS_HMAC(algorithm)) {
730 if (key_type == PSA_KEY_TYPE_HMAC) {
731 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100732 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100733 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100734
Gilles Peskine449bd832023-01-11 14:50:10 +0100735 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
736 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
737 * key. */
738 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
739 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
740 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
741 * the block length (larger than 1) for block ciphers. */
742 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
743 return PSA_SUCCESS;
744 }
745 }
746 }
747
748 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100749}
750
Gilles Peskine449bd832023-01-11 14:50:10 +0100751psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
752 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200753{
Gilles Peskine449bd832023-01-11 14:50:10 +0100754 if (slot->key.data != NULL) {
755 return PSA_ERROR_ALREADY_EXISTS;
756 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200757
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 slot->key.data = mbedtls_calloc(1, buffer_length);
759 if (slot->key.data == NULL) {
760 return PSA_ERROR_INSUFFICIENT_MEMORY;
761 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200762
Ronald Cronea0f8a62020-11-25 17:52:23 +0100763 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100764 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200765}
766
Gilles Peskine449bd832023-01-11 14:50:10 +0100767psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
768 const uint8_t *data,
769 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200770{
Gilles Peskine449bd832023-01-11 14:50:10 +0100771 psa_status_t status = psa_allocate_buffer_to_slot(slot,
772 data_length);
773 if (status != PSA_SUCCESS) {
774 return status;
775 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200776
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 memcpy(slot->key.data, data, data_length);
778 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200779}
780
Ronald Crona0fe59f2020-11-29 11:14:53 +0100781psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100782 const psa_key_attributes_t *attributes,
783 const uint8_t *data, size_t data_length,
784 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100786{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100787 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
788 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100789
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200790 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100791 if (data_length == 0) {
792 return PSA_ERROR_NOT_SUPPORTED;
793 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200794
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 if (key_type_is_raw_bytes(type)) {
796 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200797
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
799 *bits);
800 if (status != PSA_SUCCESS) {
801 return status;
802 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200803
Ronald Crondd04d422020-11-28 15:14:42 +0100804 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100805 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100806 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200808
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 return PSA_SUCCESS;
810 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200811#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200812 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100813 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200814 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100815 return PSA_ERROR_INVALID_ARGUMENT;
816 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200817 return mbedtls_psa_ffdh_import_key(attributes,
818 data, data_length,
819 key_buffer, key_buffer_size,
820 key_buffer_length,
821 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100822 }
Valerio Settia55f0422023-07-10 15:34:41 +0200823#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200824 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200825#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100826 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
827 if (PSA_KEY_TYPE_IS_ECC(type)) {
828 return mbedtls_psa_ecp_import_key(attributes,
829 data, data_length,
830 key_buffer, key_buffer_size,
831 key_buffer_length,
832 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100833 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200834#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800835 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200836#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
837 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100838 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
839 if (PSA_KEY_TYPE_IS_RSA(type)) {
840 return mbedtls_psa_rsa_import_key(attributes,
841 data, data_length,
842 key_buffer, key_buffer_size,
843 key_buffer_length,
844 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200845 }
Valerio Settife478902023-07-25 12:27:19 +0200846#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
847 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800848 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100849 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100850
Gilles Peskine449bd832023-01-11 14:50:10 +0100851 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100852}
853
Gilles Peskinef603c712019-01-19 13:40:11 +0100854/** Calculate the intersection of two algorithm usage policies.
855 *
856 * Return 0 (which allows no operation) on incompatibility.
857 */
858static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100859 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100860 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100861 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100862{
Gilles Peskine549ea862019-05-22 11:45:59 +0200863 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100864 if (alg1 == alg2) {
865 return alg1;
866 }
Steven Cooreman03488022021-02-18 12:07:20 +0100867 /* If the policies are from the same hash-and-sign family, check
868 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100869 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
870 PSA_ALG_IS_SIGN_HASH(alg2) &&
871 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
872 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
873 return alg2;
874 }
875 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
876 return alg1;
877 }
Steven Cooreman03488022021-02-18 12:07:20 +0100878 }
879 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100880 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100881 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100882 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
883 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
884 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
885 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
886 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100887 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100888
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100889 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100890 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
891 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
892 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
893 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100894 }
895 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100896 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
897 (alg1_len <= alg2_len)) {
898 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100899 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100900 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
901 (alg2_len <= alg1_len)) {
902 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100903 }
904 }
905 /* If the policies are from the same MAC family, check whether one
906 * of them is a minimum-MAC-length policy. Calculate the most
907 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
909 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
910 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100911 /* Validate the combination of key type and algorithm. Since the base
912 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100913 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
914 return 0;
915 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100916
Steven Cooreman31a876d2021-03-03 20:47:40 +0100917 /* Get the (exact or at-least) output lengths for both sides of the
918 * requested intersection. None of the currently supported algorithms
919 * have an output length dependent on the actual key size, so setting it
920 * to a bogus value of 0 is currently OK.
921 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100922 * Note that for at-least-this-length wildcard algorithms, the output
923 * length is set to the shortest allowed length, which allows us to
924 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
926 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100927 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100928
Steven Cooremana1d83222021-02-25 10:20:29 +0100929 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100930 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
931 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
932 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100933 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100934
935 /* If only one is an at-least-this-length policy, the intersection would
936 * be the other (fixed-length) policy as long as said fixed length is
937 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
939 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100940 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100941 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
942 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100943 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100944
Steven Cooremancd640932021-03-08 12:00:27 +0100945 /* If none of them are wildcards, check whether they define the same tag
946 * length. This is still possible here when one is default-length and
947 * the other specific-length. Ensure to always return the
948 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 if (alg1_len == alg2_len) {
950 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
951 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100952 }
953 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100954 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100955}
956
Gilles Peskine449bd832023-01-11 14:50:10 +0100957static int psa_key_algorithm_permits(psa_key_type_t key_type,
958 psa_algorithm_t policy_alg,
959 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200960{
Gilles Peskine549ea862019-05-22 11:45:59 +0200961 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 if (requested_alg == policy_alg) {
963 return 1;
964 }
Steven Cooreman03488022021-02-18 12:07:20 +0100965 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
966 * and requested_alg is the same hash-and-sign family with any hash,
967 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
969 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
970 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
971 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100972 }
973 /* If policy_alg is a wildcard AEAD algorithm of the same base as
974 * the requested algorithm, check the requested tag length to be
975 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 if (PSA_ALG_IS_AEAD(policy_alg) &&
977 PSA_ALG_IS_AEAD(requested_alg) &&
978 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
979 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
980 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
981 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
982 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100983 }
Steven Cooremancd640932021-03-08 12:00:27 +0100984 /* If policy_alg is a MAC algorithm of the same base as the requested
985 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 if (PSA_ALG_IS_MAC(policy_alg) &&
987 PSA_ALG_IS_MAC(requested_alg) &&
988 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
989 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100990 /* Validate the combination of key type and algorithm. Since the policy
991 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
993 return 0;
994 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100995
Steven Cooreman31a876d2021-03-03 20:47:40 +0100996 /* Get both the requested output length for the algorithm which is to be
997 * verified, and the default output length for the base algorithm.
998 * Note that none of the currently supported algorithms have an output
999 * length dependent on actual key size, so setting it to a bogus value
1000 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001001 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +01001002 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001003 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 key_type, 0,
1005 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001006
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001007 /* If the policy is default-length, only allow an algorithm with
1008 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
1010 return requested_output_length == default_output_length;
1011 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001012
1013 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +01001014 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
1016 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
1017 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001018 }
1019
Steven Cooremancd640932021-03-08 12:00:27 +01001020 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
1021 * check for the requested MAC length to be equal to or longer than the
1022 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
1024 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
1025 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001026 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001027 }
Steven Cooremance48e852020-10-05 16:02:45 +02001028 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001029 * a key derivation with that key agreement should also be allowed. This
1030 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001031 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
1032 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
1033 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
1034 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +02001035 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001036 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001038}
1039
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001040/** Test whether a policy permits an algorithm.
1041 *
1042 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +01001043 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001044 * \note This function requires providing the key type for which the policy is
1045 * being validated, since some algorithm policy definitions (e.g. MAC)
1046 * have different properties depending on what kind of cipher it is
1047 * combined with.
1048 *
Steven Cooreman7e39f052021-02-23 14:18:32 +01001049 * \retval PSA_SUCCESS When \p alg is a specific algorithm
1050 * allowed by the \p policy.
1051 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
1052 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
1053 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001054 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001055static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
1056 psa_key_type_t key_type,
1057 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001058{
Steven Cooremand788fab2021-02-25 11:29:17 +01001059 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 if (alg == 0) {
1061 return PSA_ERROR_INVALID_ARGUMENT;
1062 }
Steven Cooremand788fab2021-02-25 11:29:17 +01001063
Steven Cooreman7e39f052021-02-23 14:18:32 +01001064 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 if (PSA_ALG_IS_WILDCARD(alg)) {
1066 return PSA_ERROR_INVALID_ARGUMENT;
1067 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001068
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
1070 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
1071 return PSA_SUCCESS;
1072 } else {
1073 return PSA_ERROR_NOT_PERMITTED;
1074 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001075}
1076
Gilles Peskinef603c712019-01-19 13:40:11 +01001077/** Restrict a key policy based on a constraint.
1078 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001079 * \note This function requires providing the key type for which the policy is
1080 * being restricted, since some algorithm policy definitions (e.g. MAC)
1081 * have different properties depending on what kind of cipher it is
1082 * combined with.
1083 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001084 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +01001085 * \param[in,out] policy The policy to restrict.
1086 * \param[in] constraint The policy constraint to apply.
1087 *
1088 * \retval #PSA_SUCCESS
1089 * \c *policy contains the intersection of the original value of
1090 * \c *policy and \c *constraint.
1091 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001092 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +01001093 * \c *policy is unchanged.
1094 */
1095static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001096 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +01001097 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +01001099{
1100 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 psa_key_policy_algorithm_intersection(key_type, policy->alg,
1102 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +02001103 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
1105 constraint->alg2);
1106 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1107 return PSA_ERROR_INVALID_ARGUMENT;
1108 }
1109 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1110 return PSA_ERROR_INVALID_ARGUMENT;
1111 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001112 policy->usage &= constraint->usage;
1113 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001114 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001116}
1117
Przemek Stekiel061f6942022-11-30 10:51:35 +01001118/** Get the description of a key given its identifier and policy constraints
1119 * and lock it.
1120 *
1121 * The key must have allow all the usage flags set in \p usage. If \p alg is
1122 * nonzero, the key must allow operations with this algorithm. If \p alg is
1123 * zero, the algorithm is not checked.
1124 *
1125 * In case of a persistent key, the function loads the description of the key
1126 * into a key slot if not already done.
1127 *
1128 * On success, the returned key slot is locked. It is the responsibility of
1129 * the caller to unlock the key slot when it does not access it anymore.
1130 */
1131static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001132 mbedtls_svc_key_id_t key,
1133 psa_key_slot_t **p_slot,
1134 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001136{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001137 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001138 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001139
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 status = psa_get_and_lock_key_slot(key, p_slot);
1141 if (status != PSA_SUCCESS) {
1142 return status;
1143 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001144 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001145
1146 /* Enforce that usage policy for the key slot contains all the flags
1147 * required by the usage parameter. There is one exception: public
1148 * keys can always be exported, so we treat public key objects as
1149 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001151 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001153
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001155 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001156 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001157 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001158
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001159 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 if (alg != 0) {
1161 status = psa_key_policy_permits(&slot->attr.policy,
1162 slot->attr.type,
1163 alg);
1164 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001165 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001167 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001168
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001170
1171error:
1172 *p_slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001174
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001176}
Darryl Green940d72c2018-07-13 13:18:51 +01001177
Ronald Cron5c522922020-11-14 16:35:34 +01001178/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001179 *
1180 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001181 * available, as opposed to a key in a secure element and/or to be used
1182 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001183 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001184 * This is a temporary function that may be used instead of
1185 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1186 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001187 *
Ronald Cron5c522922020-11-14 16:35:34 +01001188 * On success, the returned key slot is locked. It is the responsibility of the
1189 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001190 */
Ronald Cron5c522922020-11-14 16:35:34 +01001191static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1192 mbedtls_svc_key_id_t key,
1193 psa_key_slot_t **p_slot,
1194 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001196{
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1198 usage, alg);
1199 if (status != PSA_SUCCESS) {
1200 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001201 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001202
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
1204 psa_unlock_key_slot(*p_slot);
1205 *p_slot = NULL;
1206 return PSA_ERROR_NOT_SUPPORTED;
1207 }
1208
1209 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001210}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001211
Gilles Peskine449bd832023-01-11 14:50:10 +01001212psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001213{
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001215 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001217
Ronald Cronea0f8a62020-11-25 17:52:23 +01001218 slot->key.data = NULL;
1219 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001222}
1223
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001224/** Completely wipe a slot in memory, including its policy.
1225 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001226psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001227{
Gilles Peskine449bd832023-01-11 14:50:10 +01001228 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001229
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 /*
1231 * As the return error code may not be handled in case of multiple errors,
1232 * do our best to report an unexpected lock counter. Assert with
1233 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
1234 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1235 * function is called as part of the execution of a test suite, the
1236 * execution of the test suite is stopped in error if the assertion fails.
1237 */
1238 if (slot->lock_count != 1) {
1239 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->lock_count == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001240 status = PSA_ERROR_CORRUPTION_DETECTED;
1241 }
1242
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001243 /* Multipart operations may still be using the key. This is safe
1244 * because all multipart operation objects are independent from
1245 * the key slot: if they need to access the key after the setup
1246 * phase, they have a copy of the key. Note that this means that
1247 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001248 /* At this point, key material and other type-specific content has
1249 * been wiped. Clear remaining metadata. We can call memset and not
1250 * zeroize because the metadata is not particularly sensitive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001251 memset(slot, 0, sizeof(*slot));
1252 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001253}
1254
Gilles Peskine449bd832023-01-11 14:50:10 +01001255psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001256{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001257 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001258 psa_status_t status; /* status of the last operation */
1259 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001260#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1261 psa_se_drv_table_entry_t *driver;
1262#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001263
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 if (mbedtls_svc_key_id_is_null(key)) {
1265 return PSA_SUCCESS;
1266 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001267
Ronald Cronf2911112020-10-29 17:51:10 +01001268 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001269 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001270 * key, this will load the key description from persistent memory if not
1271 * done yet. We cannot avoid this loading as without it we don't know if
1272 * the key is operated by an SE or not and this information is needed by
1273 * the current implementation.
1274 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001275 status = psa_get_and_lock_key_slot(key, &slot);
1276 if (status != PSA_SUCCESS) {
1277 return status;
1278 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001279
Ronald Cronf2911112020-10-29 17:51:10 +01001280 /*
1281 * If the key slot containing the key description is under access by the
1282 * library (apart from the present access), the key cannot be destroyed
1283 * yet. For the time being, just return in error. Eventually (to be
1284 * implemented), the key should be destroyed when all accesses have
1285 * stopped.
1286 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001287 if (slot->lock_count > 1) {
1288 psa_unlock_key_slot(slot);
1289 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001290 }
1291
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001293 /* Refuse the destruction of a read-only key (which may or may not work
1294 * if we attempt it, depending on whether the key is merely read-only
1295 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001296 * Just do the best we can, which is to wipe the copy in memory
1297 * (done in this function's cleanup code). */
1298 overall_status = PSA_ERROR_NOT_PERMITTED;
1299 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001300 }
1301
Gilles Peskine354f7672019-07-12 23:46:38 +02001302#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1304 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001305 /* For a key in a secure element, we need to do three things:
1306 * remove the key file in internal storage, destroy the
1307 * key inside the secure element, and update the driver's
1308 * persistent data. Start a transaction that will encompass these
1309 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001310 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001311 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001313 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 status = psa_crypto_save_transaction();
1315 if (status != PSA_SUCCESS) {
1316 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001317 /* We should still try to destroy the key in the secure
1318 * element and the key metadata in storage. This is especially
1319 * important if the error is that the storage is full.
1320 * But how to do it exactly without risking an inconsistent
1321 * state after a reset?
1322 * https://github.com/ARMmbed/mbed-crypto/issues/215
1323 */
1324 overall_status = status;
1325 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001326 }
1327
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 status = psa_destroy_se_key(driver,
1329 psa_key_slot_get_slot_number(slot));
1330 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001331 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001333 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001334#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1335
Darryl Greend49a4992018-06-18 17:27:26 +01001336#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1338 status = psa_destroy_persistent_key(slot->attr.id);
1339 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001340 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001342
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001343 /* TODO: other slots may have a copy of the same key. We should
1344 * invalidate them.
1345 * https://github.com/ARMmbed/mbed-crypto/issues/214
1346 */
Darryl Greend49a4992018-06-18 17:27:26 +01001347 }
1348#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001349
Gilles Peskinefc762652019-07-22 19:30:34 +02001350#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001351 if (driver != NULL) {
1352 status = psa_save_se_persistent_data(driver);
1353 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001354 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 }
1356 status = psa_crypto_stop_transaction();
1357 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001358 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001360 }
1361#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1362
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001363exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001365 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001367 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 }
1369 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001370}
1371
Valerio Settib2bcedb2023-07-10 11:24:00 +02001372#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001373 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001374static psa_status_t psa_get_rsa_public_exponent(
1375 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001377{
1378 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001379 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001380 uint8_t *buffer = NULL;
1381 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001383
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1385 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001386 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 }
1388 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001389 /* It's the default value, which is reported as an empty string,
1390 * so there's nothing to do. */
1391 goto exit;
1392 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 buflen = mbedtls_mpi_size(&mpi);
1395 buffer = mbedtls_calloc(1, buflen);
1396 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001397 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1398 goto exit;
1399 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1401 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001402 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001404 attributes->domain_parameters = buffer;
1405 attributes->domain_parameters_size = buflen;
1406
1407exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 mbedtls_mpi_free(&mpi);
1409 if (ret != 0) {
1410 mbedtls_free(buffer);
1411 }
1412 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001413}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001414#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001415 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001416
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001417/** Retrieve all the publicly-accessible attributes of a key.
1418 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001419psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1420 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001421{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001422 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001423 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001424 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001425
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001427
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1429 if (status != PSA_SUCCESS) {
1430 return status;
1431 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001432
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001433 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1435 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001436
1437#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1439 psa_set_key_slot_number(attributes,
1440 psa_key_slot_get_slot_number(slot));
1441 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001442#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001443
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001445#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1446 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001447 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001448 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001449 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001450 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001451 * is not yet implemented.
1452 * https://github.com/ARMmbed/mbed-crypto/issues/216
1453 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001455 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001456
Ronald Cron90857082020-11-25 14:58:33 +01001457 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 slot->attr.type,
1459 slot->key.data,
1460 slot->key.bytes,
1461 &rsa);
1462 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001463 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001465
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 status = psa_get_rsa_public_exponent(rsa,
1467 attributes);
1468 mbedtls_rsa_free(rsa);
1469 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001470 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001471 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001472#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1473 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001474 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001475 default:
1476 /* Nothing else to do. */
1477 break;
1478 }
1479
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 if (status != PSA_SUCCESS) {
1481 psa_reset_key_attributes(attributes);
1482 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001483
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001485
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001487}
1488
Gilles Peskinec8000c02019-08-02 20:15:51 +02001489#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1490psa_status_t psa_get_key_slot_number(
1491 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001493{
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001495 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 return PSA_SUCCESS;
1497 } else {
1498 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001499 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001500}
1501#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1502
Gilles Peskine449bd832023-01-11 14:50:10 +01001503static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1504 size_t key_buffer_size,
1505 uint8_t *data,
1506 size_t data_size,
1507 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001508{
Gilles Peskine449bd832023-01-11 14:50:10 +01001509 if (key_buffer_size > data_size) {
1510 return PSA_ERROR_BUFFER_TOO_SMALL;
1511 }
1512 memcpy(data, key_buffer, key_buffer_size);
1513 memset(data + key_buffer_size, 0,
1514 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001515 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001517}
1518
Ronald Cron7285cda2020-11-26 14:46:37 +01001519psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001520 const psa_key_attributes_t *attributes,
1521 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001523{
Ronald Crond18b5f82020-11-25 16:46:05 +01001524 psa_key_type_t type = attributes->core.type;
1525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 if (key_type_is_raw_bytes(type) ||
1527 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001528 PSA_KEY_TYPE_IS_ECC(type) ||
1529 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 return psa_export_key_buffer_internal(
1531 key_buffer, key_buffer_size,
1532 data, data_size, data_length);
1533 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001534 /* This shouldn't happen in the reference implementation, but
1535 it is valid for a special-purpose implementation to omit
1536 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001538 }
1539}
1540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1542 uint8_t *data,
1543 size_t data_size,
1544 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001545{
1546 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1547 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1548 psa_key_slot_t *slot;
1549
Ronald Crone907e552021-01-18 13:22:38 +01001550 /* Reject a zero-length output buffer now, since this can never be a
1551 * valid key representation. This way we know that data must be a valid
1552 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 if (data_size == 0) {
1554 return PSA_ERROR_BUFFER_TOO_SMALL;
1555 }
Ronald Crone907e552021-01-18 13:22:38 +01001556
Ronald Cron9486f9d2020-11-26 13:36:23 +01001557 /* Set the key to empty now, so that even when there are errors, we always
1558 * set data_length to a value between 0 and data_size. On error, setting
1559 * the key to empty is a good choice because an empty key representation is
1560 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001561 *data_length = 0;
1562
Ronald Cron9486f9d2020-11-26 13:36:23 +01001563 /* Export requires the EXPORT flag. There is an exception for public keys,
1564 * which don't require any flag, but
1565 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1566 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001567 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1568 PSA_KEY_USAGE_EXPORT, 0);
1569 if (status != PSA_SUCCESS) {
1570 return status;
1571 }
mohammad160306e79202018-03-28 13:17:44 +03001572
Ronald Crond18b5f82020-11-25 16:46:05 +01001573 psa_key_attributes_t attributes = {
1574 .core = slot->attr
1575 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 status = psa_driver_wrapper_export_key(&attributes,
1577 slot->key.data, slot->key.bytes,
1578 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001579
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001581
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001583}
1584
Ronald Cron7285cda2020-11-26 14:46:37 +01001585psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001586 const psa_key_attributes_t *attributes,
1587 const uint8_t *key_buffer,
1588 size_t key_buffer_size,
1589 uint8_t *data,
1590 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001592{
Ronald Crond18b5f82020-11-25 16:46:05 +01001593 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001594
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001595 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001596 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1597 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001598 /* Exporting public -> public */
1599 return psa_export_key_buffer_internal(
1600 key_buffer, key_buffer_size,
1601 data, data_size, data_length);
1602 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001603#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001604 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1605 return mbedtls_psa_rsa_export_public_key(attributes,
1606 key_buffer,
1607 key_buffer_size,
1608 data,
1609 data_size,
1610 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001611#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001612 /* We don't know how to convert a private RSA key to public. */
1613 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001614#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001615 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001616 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001617#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001618 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1619 return mbedtls_psa_ecp_export_public_key(attributes,
1620 key_buffer,
1621 key_buffer_size,
1622 data,
1623 data_size,
1624 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001625#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001626 /* We don't know how to convert a private ECC key to public */
1627 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001628#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001629 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001630 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001631#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001632 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001633 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001634 key_buffer,
1635 key_buffer_size,
1636 data, data_size,
1637 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001638#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001639 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001640#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001641 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001642 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001643 (void) key_buffer;
1644 (void) key_buffer_size;
1645 (void) data;
1646 (void) data_size;
1647 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001648 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001649 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001650}
Ronald Crond18b5f82020-11-25 16:46:05 +01001651
Gilles Peskine449bd832023-01-11 14:50:10 +01001652psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1653 uint8_t *data,
1654 size_t data_size,
1655 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001656{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001657 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001658 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001659 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001660 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001661
Ronald Crone907e552021-01-18 13:22:38 +01001662 /* Reject a zero-length output buffer now, since this can never be a
1663 * valid key representation. This way we know that data must be a valid
1664 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001665 if (data_size == 0) {
1666 return PSA_ERROR_BUFFER_TOO_SMALL;
1667 }
Ronald Crone907e552021-01-18 13:22:38 +01001668
Darryl Greendd8fb772018-11-07 16:00:44 +00001669 /* Set the key to empty now, so that even when there are errors, we always
1670 * set data_length to a value between 0 and data_size. On error, setting
1671 * the key to empty is a good choice because an empty key representation is
1672 * unlikely to be accepted anywhere. */
1673 *data_length = 0;
1674
1675 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001676 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1677 if (status != PSA_SUCCESS) {
1678 return status;
1679 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001680
Gilles Peskine449bd832023-01-11 14:50:10 +01001681 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1682 status = PSA_ERROR_INVALID_ARGUMENT;
1683 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001684 }
1685
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001686 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001687 .core = slot->attr
1688 };
Ronald Cron67227982020-11-26 15:16:05 +01001689 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001690 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001692
1693exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001695
Gilles Peskine449bd832023-01-11 14:50:10 +01001696 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001697}
1698
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001699MBEDTLS_STATIC_ASSERT(
1700 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1701 "One or more key attribute flag is listed as both external-only and dual-use")
1702MBEDTLS_STATIC_ASSERT(
1703 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1704 "One or more key attribute flag is listed as both internal-only and dual-use")
1705MBEDTLS_STATIC_ASSERT(
1706 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1707 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001708
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001709/** Validate that a key policy is internally well-formed.
1710 *
1711 * This function only rejects invalid policies. It does not validate the
1712 * consistency of the policy with respect to other attributes of the key
1713 * such as the key type.
1714 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001715static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001716{
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1718 PSA_KEY_USAGE_COPY |
1719 PSA_KEY_USAGE_ENCRYPT |
1720 PSA_KEY_USAGE_DECRYPT |
1721 PSA_KEY_USAGE_SIGN_MESSAGE |
1722 PSA_KEY_USAGE_VERIFY_MESSAGE |
1723 PSA_KEY_USAGE_SIGN_HASH |
1724 PSA_KEY_USAGE_VERIFY_HASH |
1725 PSA_KEY_USAGE_VERIFY_DERIVATION |
1726 PSA_KEY_USAGE_DERIVE)) != 0) {
1727 return PSA_ERROR_INVALID_ARGUMENT;
1728 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001729
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001731}
1732
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001733/** Validate the internal consistency of key attributes.
1734 *
1735 * This function only rejects invalid attribute values. If does not
1736 * validate the consistency of the attributes with any key data that may
1737 * be involved in the creation of the key.
1738 *
1739 * Call this function early in the key creation process.
1740 *
1741 * \param[in] attributes Key attributes for the new key.
1742 * \param[out] p_drv On any return, the driver for the key, if any.
1743 * NULL for a transparent key.
1744 *
1745 */
1746static psa_status_t psa_validate_key_attributes(
1747 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001749{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001750 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1752 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001753
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 status = psa_validate_key_location(lifetime, p_drv);
1755 if (status != PSA_SUCCESS) {
1756 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001757 }
1758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 status = psa_validate_key_persistence(lifetime);
1760 if (status != PSA_SUCCESS) {
1761 return status;
1762 }
1763
1764 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1765 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1766 return PSA_ERROR_INVALID_ARGUMENT;
1767 }
1768 } else {
1769 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1770 return PSA_ERROR_INVALID_ARGUMENT;
1771 }
1772 }
1773
1774 status = psa_validate_key_policy(&attributes->core.policy);
1775 if (status != PSA_SUCCESS) {
1776 return status;
1777 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001778
1779 /* Refuse to create overly large keys.
1780 * Note that this doesn't trigger on import if the attributes don't
1781 * explicitly specify a size (so psa_get_key_bits returns 0), so
1782 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1784 return PSA_ERROR_NOT_SUPPORTED;
1785 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001786
Gilles Peskine91e8c332019-08-02 19:19:39 +02001787 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1789 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1790 return PSA_ERROR_INVALID_ARGUMENT;
1791 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001792
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001794}
1795
Gilles Peskine4747d192019-04-17 15:05:45 +02001796/** Prepare a key slot to receive key material.
1797 *
1798 * This function allocates a key slot and sets its metadata.
1799 *
1800 * If this function fails, call psa_fail_key_creation().
1801 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001802 * This function is intended to be used as follows:
1803 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001804 * it with the specified attributes, and in case of a volatile key assign it
1805 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001806 * -# Populate the slot with the key material.
1807 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1808 * In case of failure at any step, stop the sequence and call
1809 * psa_fail_key_creation().
1810 *
Ronald Cron5c522922020-11-14 16:35:34 +01001811 * On success, the key slot is locked. It is the responsibility of the caller
1812 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001813 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001814 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001815 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001816 * \param[out] p_slot On success, a pointer to the prepared slot.
1817 * \param[out] p_drv On any return, the driver for the key, if any.
1818 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001819 *
1820 * \retval #PSA_SUCCESS
1821 * The key slot is ready to receive key material.
1822 * \return If this function fails, the key slot is an invalid state.
1823 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001824 */
1825static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001826 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001827 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001828 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001830{
1831 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001832 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001833 psa_key_slot_t *slot;
1834
Gilles Peskinedf179142019-07-15 22:02:14 +02001835 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001836 *p_drv = NULL;
1837
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 status = psa_validate_key_attributes(attributes, p_drv);
1839 if (status != PSA_SUCCESS) {
1840 return status;
1841 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1844 if (status != PSA_SUCCESS) {
1845 return status;
1846 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001847 slot = *p_slot;
1848
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001849 /* We're storing the declared bit-size of the key. It's up to each
1850 * creation mechanism to verify that this information is correct.
1851 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001852 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001853 * is optional (import, copy). In case of a volatile key, assign it the
1854 * volatile key identifier associated to the slot returned to contain its
1855 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001856
1857 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001859#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1860 slot->attr.id = volatile_key_id;
1861#else
1862 slot->attr.id.key_id = volatile_key_id;
1863#endif
1864 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001865
Gilles Peskine91e8c332019-08-02 19:19:39 +02001866 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001867 * external-only flags, query `attributes`. Thanks to the check
1868 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001869 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001870 * may have set. */
1871 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001872
Gilles Peskinecbaff462019-07-12 23:46:04 +02001873#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001874 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001875 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001876 * create the key file in internal storage, create the
1877 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001878 * persistent data. This is done by starting a transaction that will
1879 * encompass these three actions.
1880 * For registering a volatile key, we just need to find an appropriate
1881 * slot number inside the SE. Since the key is designated volatile, creating
1882 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001883 /* The first thing to do is to find a slot number for the new key.
1884 * We save the slot number in persistent storage as part of the
1885 * transaction data. It will be needed to recover if the power
1886 * fails during the key creation process, to clean up on the secure
1887 * element side after restarting. Obtaining a slot number from the
1888 * secure element driver updates its persistent state, but we do not yet
1889 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001890 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001892 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001893 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1894 &slot_number);
1895 if (status != PSA_SUCCESS) {
1896 return status;
1897 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001898
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1900 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001901 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001902 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001903 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001904 status = psa_crypto_save_transaction();
1905 if (status != PSA_SUCCESS) {
1906 (void) psa_crypto_stop_transaction();
1907 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001908 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001909 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001910
1911 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001913 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001914
Gilles Peskine449bd832023-01-11 14:50:10 +01001915 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001916 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001918 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001919#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1920
Ryan Everett975d4112023-11-16 13:37:51 +00001921 slot->status = PSA_SLOT_OCCUPIED;
1922
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001924}
Gilles Peskine4747d192019-04-17 15:05:45 +02001925
1926/** Finalize the creation of a key once its key material has been set.
1927 *
1928 * This entails writing the key to persistent storage.
1929 *
1930 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001931 * See the documentation of psa_start_key_creation() for the intended use
1932 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001933 *
Ronald Cron5c522922020-11-14 16:35:34 +01001934 * If the finalization succeeds, the function unlocks the key slot (it was
1935 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1936 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001937 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001938 * \param[in,out] slot Pointer to the slot with key material.
1939 * \param[in] driver The secure element driver for the key,
1940 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001941 * \param[out] key On success, identifier of the key. Note that the
1942 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001943 *
1944 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001945 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001946 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1947 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1948 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1949 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1950 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1951 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001952 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001953 * \return If this function fails, the key slot is an invalid state.
1954 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001955 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001956static psa_status_t psa_finish_key_creation(
1957 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001958 psa_se_drv_table_entry_t *driver,
1959 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001960{
1961 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001962 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001963 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001964
1965#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001967#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001969 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001970 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001972
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001973 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1974 sizeof(data.slot_number),
1975 "Slot number size does not match psa_se_key_data_storage_t");
1976
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1978 status = psa_save_persistent_key(&slot->attr,
1979 (uint8_t *) &data,
1980 sizeof(data));
1981 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001982#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1983 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001984 /* Key material is saved in export representation in the slot, so
1985 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 status = psa_save_persistent_key(&slot->attr,
1987 slot->key.data,
1988 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001989 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001990 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001991#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1992
Gilles Peskinecbaff462019-07-12 23:46:04 +02001993#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001994 /* Finish the transaction for a key creation. This does not
1995 * happen when registering an existing key. Detect this case
1996 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001997 * creation of a persistent key in a secure element requires a transaction,
1998 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 if (driver != NULL &&
2000 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
2001 status = psa_save_se_persistent_data(driver);
2002 if (status != PSA_SUCCESS) {
2003 psa_destroy_persistent_key(slot->attr.id);
2004 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02002005 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02002007 }
2008#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2009
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002011 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 status = psa_unlock_key_slot(slot);
2013 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002014 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002016 }
Ronald Cron50972942020-11-14 11:28:25 +01002017
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002019}
2020
2021/** Abort the creation of a key.
2022 *
2023 * You may call this function after calling psa_start_key_creation(),
2024 * or after psa_finish_key_creation() fails. In other circumstances, this
2025 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002026 * See the documentation of psa_start_key_creation() for the intended use
2027 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002028 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002029 * \param[in,out] slot Pointer to the slot with key material.
2030 * \param[in] driver The secure element driver for the key,
2031 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002032 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002033static void psa_fail_key_creation(psa_key_slot_t *slot,
2034 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02002035{
Gilles Peskine011e4282019-06-26 18:34:38 +02002036 (void) driver;
2037
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02002039 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 }
Gilles Peskine011e4282019-06-26 18:34:38 +02002041
2042#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002043 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002044 * element, and the failure happened later (when saving metadata
2045 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002046 * element.
2047 * https://github.com/ARMmbed/mbed-crypto/issues/217
2048 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002049
Gilles Peskined7729582019-08-05 15:55:54 +02002050 /* Abort the ongoing transaction if any (there may not be one if
2051 * the creation process failed before starting one, or if the
2052 * key creation is a registration of a key in a secure element).
2053 * Earlier functions must already have done what it takes to undo any
2054 * partial creation. All that's left is to update the transaction data
2055 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002057#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2058
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02002060}
2061
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002062/** Validate optional attributes during key creation.
2063 *
2064 * Some key attributes are optional during key creation. If they are
2065 * specified in the attributes structure, check that they are consistent
2066 * with the data in the slot.
2067 *
2068 * This function should be called near the end of key creation, after
2069 * the slot in memory is fully populated but before saving persistent data.
2070 */
2071static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002072 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002074{
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 if (attributes->core.type != 0) {
2076 if (attributes->core.type != slot->attr.type) {
2077 return PSA_ERROR_INVALID_ARGUMENT;
2078 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002079 }
2080
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002082#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2083 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2085 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002086 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002087 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002088 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002089
Ronald Cron90857082020-11-25 14:58:33 +01002090 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 slot->attr.type,
2092 slot->key.data,
2093 slot->key.bytes,
2094 &rsa);
2095 if (status != PSA_SUCCESS) {
2096 return status;
2097 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002098
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 mbedtls_mpi_init(&actual);
2100 mbedtls_mpi_init(&required);
2101 ret = mbedtls_rsa_export(rsa,
2102 NULL, NULL, NULL, NULL, &actual);
2103 mbedtls_rsa_free(rsa);
2104 mbedtls_free(rsa);
2105 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002106 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 }
2108 ret = mbedtls_mpi_read_binary(&required,
2109 attributes->domain_parameters,
2110 attributes->domain_parameters_size);
2111 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002112 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 }
2114 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002115 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 }
2117rsa_exit:
2118 mbedtls_mpi_free(&actual);
2119 mbedtls_mpi_free(&required);
2120 if (ret != 0) {
2121 return mbedtls_to_psa_error(ret);
2122 }
2123 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002124#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2125 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002126 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002127 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002129 }
2130 }
2131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 if (attributes->core.bits != 0) {
2133 if (attributes->core.bits != slot->attr.bits) {
2134 return PSA_ERROR_INVALID_ARGUMENT;
2135 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002136 }
2137
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002139}
2140
Gilles Peskine449bd832023-01-11 14:50:10 +01002141psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
2142 const uint8_t *data,
2143 size_t data_length,
2144 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002145{
2146 psa_status_t status;
2147 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002148 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002149 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302150 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002151
Ronald Cron81709fc2020-11-14 12:10:32 +01002152 *key = MBEDTLS_SVC_KEY_ID_INIT;
2153
Gilles Peskine0f84d622019-09-12 19:03:13 +02002154 /* Reject zero-length symmetric keys (including raw data key objects).
2155 * This also rejects any key which might be encoded as an empty string,
2156 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (data_length == 0) {
2158 return PSA_ERROR_INVALID_ARGUMENT;
2159 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002160
Archana449608b2021-09-08 15:36:05 +05302161 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (data_length > SIZE_MAX / 8) {
2163 return PSA_ERROR_NOT_SUPPORTED;
2164 }
Archana6ed4bda2021-08-04 10:47:15 +05302165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2167 &slot, &driver);
2168 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002169 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002171
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002172 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302173 * storage ( thus not in the case of importing a key in a secure element
2174 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2175 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 if (slot->key.data == NULL) {
2177 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302178 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 attributes, data, data_length, &storage_size);
2180 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302181 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 }
Archanad8a83dc2021-06-14 10:04:16 +05302183 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 status = psa_allocate_buffer_to_slot(slot, storage_size);
2185 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002186 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002188 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002189
2190 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 status = psa_driver_wrapper_import_key(attributes,
2192 data, data_length,
2193 slot->key.data,
2194 slot->key.bytes,
2195 &slot->key.bytes, &bits);
2196 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002197 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002201 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002203 status = PSA_ERROR_INVALID_ARGUMENT;
2204 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002205 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002206
Archana6ed4bda2021-08-04 10:47:15 +05302207 /* Enforce a size limit, and in particular ensure that the bit
2208 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302210 status = PSA_ERROR_NOT_SUPPORTED;
2211 goto exit;
2212 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 status = psa_validate_optional_attributes(slot, attributes);
2214 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002215 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002217
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002219exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 if (status != PSA_SUCCESS) {
2221 psa_fail_key_creation(slot, driver);
2222 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002223
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002225}
2226
Gilles Peskined7729582019-08-05 15:55:54 +02002227#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2228psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002230{
2231 psa_status_t status;
2232 psa_key_slot_t *slot = NULL;
2233 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002234 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002235
2236 /* Leaving attributes unspecified is not currently supported.
2237 * It could make sense to query the key type and size from the
2238 * secure element, but not all secure elements support this
2239 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2241 return PSA_ERROR_NOT_SUPPORTED;
2242 }
2243 if (psa_get_key_bits(attributes) == 0) {
2244 return PSA_ERROR_NOT_SUPPORTED;
2245 }
Gilles Peskined7729582019-08-05 15:55:54 +02002246
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2248 &slot, &driver);
2249 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002250 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 }
Gilles Peskined7729582019-08-05 15:55:54 +02002252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002254
2255exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 if (status != PSA_SUCCESS) {
2257 psa_fail_key_creation(slot, driver);
2258 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002259
Gilles Peskined7729582019-08-05 15:55:54 +02002260 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 psa_close_key(key);
2262 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002263}
2264#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2265
Gilles Peskine449bd832023-01-11 14:50:10 +01002266psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2267 const psa_key_attributes_t *specified_attributes,
2268 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002269{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002270 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002271 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002272 psa_key_slot_t *source_slot = NULL;
2273 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002274 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002275 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302276 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002277
Ronald Cron81709fc2020-11-14 12:10:32 +01002278 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2279
Archana8a180362021-07-05 02:18:48 +05302280 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2282 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002283 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 status = psa_validate_optional_attributes(source_slot,
2287 specified_attributes);
2288 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002289 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002291
Archana9d17bf42021-09-10 06:22:44 +05302292 /* The target key type and number of bits have been validated by
2293 * psa_validate_optional_attributes() to be either equal to zero or
2294 * equal to the ones of the source key. So it is safe to inherit
2295 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302296 * */
Archana9d17bf42021-09-10 06:22:44 +05302297 actual_attributes.core.bits = source_slot->attr.bits;
2298 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302299
2300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 status = psa_restrict_key_policy(source_slot->attr.type,
2302 &actual_attributes.core.policy,
2303 &source_slot->attr.policy);
2304 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002305 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2309 &target_slot, &driver);
2310 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002311 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 }
2313 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2314 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302315 /*
Archana9d17bf42021-09-10 06:22:44 +05302316 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302317 * the source key would need to be exported as plaintext and re-imported
2318 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302319 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302320 * appropriate API invocations from the application, if needed.
2321 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002322 status = PSA_ERROR_NOT_SUPPORTED;
2323 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002324 }
Archana8a180362021-07-05 02:18:48 +05302325 /*
2326 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302327 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302328 * - For opaque keys this translates to an invocation of the drivers'
2329 * copy_key entry point through the dispatch layer.
2330 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2332 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2333 &storage_size);
2334 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302335 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 }
Archana374fe5b2021-09-08 15:50:28 +05302337
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2339 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302340 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 }
Archana374fe5b2021-09-08 15:50:28 +05302342
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 status = psa_driver_wrapper_copy_key(&actual_attributes,
2344 source_slot->key.data,
2345 source_slot->key.bytes,
2346 target_slot->key.data,
2347 target_slot->key.bytes,
2348 &target_slot->key.bytes);
2349 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302350 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 }
2352 } else {
2353 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302354 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 source_slot->key.bytes);
2356 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302357 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 }
Archana8a180362021-07-05 02:18:48 +05302359 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002361exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 if (status != PSA_SUCCESS) {
2363 psa_fail_key_creation(target_slot, driver);
2364 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002365
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002369}
2370
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002371
2372
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002373/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002374/* Message digests */
2375/****************************************************************/
2376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002378{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002379 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 if (operation->id == 0) {
2381 return PSA_SUCCESS;
2382 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002383
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002385 operation->id = 0;
2386
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002388}
2389
Gilles Peskine449bd832023-01-11 14:50:10 +01002390psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2391 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002392{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002393 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002394
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002395 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002397 status = PSA_ERROR_BAD_STATE;
2398 goto exit;
2399 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002400
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002402 status = PSA_ERROR_INVALID_ARGUMENT;
2403 goto exit;
2404 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002405
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002406 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2407 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002409
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002411
2412exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 if (status != PSA_SUCCESS) {
2414 psa_hash_abort(operation);
2415 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002416
2417 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002418}
2419
Gilles Peskine449bd832023-01-11 14:50:10 +01002420psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2421 const uint8_t *input,
2422 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002423{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002427 status = PSA_ERROR_BAD_STATE;
2428 goto exit;
2429 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002430
Steven Cooremanc8288352021-03-04 14:02:19 +01002431 /* Don't require hash implementations to behave correctly on a
2432 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 if (input_length == 0) {
2434 return PSA_SUCCESS;
2435 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002436
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002438
2439exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 if (status != PSA_SUCCESS) {
2441 psa_hash_abort(operation);
2442 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002445}
2446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2448 uint8_t *hash,
2449 size_t hash_size,
2450 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002451{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002452 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 if (operation->id == 0) {
2454 return PSA_ERROR_BAD_STATE;
2455 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002456
Steven Cooreman1e582352021-02-18 17:24:37 +01002457 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 operation, hash, hash_size, hash_length);
2459 psa_hash_abort(operation);
2460 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002461}
2462
Gilles Peskine449bd832023-01-11 14:50:10 +01002463psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2464 const uint8_t *hash,
2465 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002466{
Ronald Cron69a63422021-10-18 09:47:58 +02002467 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002468 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002469 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 operation,
2471 actual_hash, sizeof(actual_hash),
2472 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002473
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002475 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002477
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002479 status = PSA_ERROR_INVALID_SIGNATURE;
2480 goto exit;
2481 }
2482
Dave Rodgman78701152023-08-29 14:20:18 +01002483 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002484 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002486
2487exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2489 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002490 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002492
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002494}
2495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496psa_status_t psa_hash_compute(psa_algorithm_t alg,
2497 const uint8_t *input, size_t input_length,
2498 uint8_t *hash, size_t hash_size,
2499 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002500{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002501 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 if (!PSA_ALG_IS_HASH(alg)) {
2503 return PSA_ERROR_INVALID_ARGUMENT;
2504 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002505
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2507 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002508}
2509
Gilles Peskine449bd832023-01-11 14:50:10 +01002510psa_status_t psa_hash_compare(psa_algorithm_t alg,
2511 const uint8_t *input, size_t input_length,
2512 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002513{
Ronald Cron69a63422021-10-18 09:47:58 +02002514 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002515 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002516
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 if (!PSA_ALG_IS_HASH(alg)) {
2518 return PSA_ERROR_INVALID_ARGUMENT;
2519 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002520
Steven Cooreman1e582352021-02-18 17:24:37 +01002521 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 alg, input, input_length,
2523 actual_hash, sizeof(actual_hash),
2524 &actual_hash_length);
2525 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002526 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 }
2528 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002529 status = PSA_ERROR_INVALID_SIGNATURE;
2530 goto exit;
2531 }
Dave Rodgman78701152023-08-29 14:20:18 +01002532 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002533 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002535
2536exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2538 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002539}
2540
Gilles Peskine449bd832023-01-11 14:50:10 +01002541psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2542 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002543{
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 if (source_operation->id == 0 ||
2545 target_operation->id != 0) {
2546 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002547 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002548
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2550 target_operation);
2551 if (status != PSA_SUCCESS) {
2552 psa_hash_abort(target_operation);
2553 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002554
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002556}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002557
2558
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002559/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002560/* MAC */
2561/****************************************************************/
2562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002564{
Steven Cooremane6804192021-03-19 18:28:56 +01002565 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 if (operation->id == 0) {
2567 return PSA_SUCCESS;
2568 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002571 operation->mac_size = 0;
2572 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002573 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002574
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002576}
2577
Ronald Cron2dff3b22021-06-17 16:33:22 +02002578static psa_status_t psa_mac_finalize_alg_and_key_validation(
2579 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002580 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002582{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002583 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 psa_key_type_t key_type = psa_get_key_type(attributes);
2585 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 if (!PSA_ALG_IS_MAC(alg)) {
2588 return PSA_ERROR_INVALID_ARGUMENT;
2589 }
Steven Cooremane6804192021-03-19 18:28:56 +01002590
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002591 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 status = psa_mac_key_can_do(alg, key_type);
2593 if (status != PSA_SUCCESS) {
2594 return status;
2595 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002596
Steven Cooremand1a68f12021-05-10 11:13:41 +02002597 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002601 /* A very short MAC is too short for security since it can be
2602 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2603 * so we make this our minimum, even though 32 bits is still
2604 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002606 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2609 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002610 /* It's impossible to "truncate" to a larger length than the full length
2611 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002613 }
2614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002616 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2617 * that is disabled in the compile-time configuration. The result can
2618 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2619 * configuration into account. In this case, force a return of
2620 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2621 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2622 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2623 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2624 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002626 }
2627
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002629}
2630
Gilles Peskine449bd832023-01-11 14:50:10 +01002631static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2632 mbedtls_svc_key_id_t key,
2633 psa_algorithm_t alg,
2634 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002635{
2636 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2637 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002638 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002639 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002640
2641 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002643 status = PSA_ERROR_BAD_STATE;
2644 goto exit;
2645 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002646
2647 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 key,
2649 &slot,
2650 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2651 alg);
2652 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002653 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002655
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002656 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002657 .core = slot->attr
2658 };
2659
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2661 &operation->mac_size);
2662 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002663 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002665
2666 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002667 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 if (is_sign) {
2669 status = psa_driver_wrapper_mac_sign_setup(operation,
2670 &attributes,
2671 slot->key.data,
2672 slot->key.bytes,
2673 alg);
2674 } else {
2675 status = psa_driver_wrapper_mac_verify_setup(operation,
2676 &attributes,
2677 slot->key.data,
2678 slot->key.bytes,
2679 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002680 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002681
Gilles Peskinefbfac682018-07-08 20:51:54 +02002682exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 if (status != PSA_SUCCESS) {
2684 psa_mac_abort(operation);
2685 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002688
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002690}
2691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2693 mbedtls_svc_key_id_t key,
2694 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002695{
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002697}
2698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2700 mbedtls_svc_key_id_t key,
2701 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002702{
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002704}
2705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2707 const uint8_t *input,
2708 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002709{
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 if (operation->id == 0) {
2711 return PSA_ERROR_BAD_STATE;
2712 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002713
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002714 /* Don't require hash implementations to behave correctly on a
2715 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 if (input_length == 0) {
2717 return PSA_SUCCESS;
2718 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002719
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2721 input, input_length);
2722 if (status != PSA_SUCCESS) {
2723 psa_mac_abort(operation);
2724 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002725
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002727}
2728
Gilles Peskine449bd832023-01-11 14:50:10 +01002729psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2730 uint8_t *mac,
2731 size_t mac_size,
2732 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002733{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002734 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2735 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002736
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002738 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002739 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002740 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002741
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002743 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002744 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002745 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002746
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002747 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2748 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002750 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002751 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002752 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002753
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002755 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002756 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002757 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002758
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 status = psa_driver_wrapper_mac_sign_finish(operation,
2760 mac, operation->mac_size,
2761 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002762
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002763exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002764 /* In case of success, set the potential excess room in the output buffer
2765 * to an invalid value, to avoid potentially leaking a longer MAC.
2766 * In case of error, set the output length and content to a safe default,
2767 * such that in case the caller misses an error check, the output would be
2768 * an unachievable MAC.
2769 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002771 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002772 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002773 }
mohammad16036df908f2018-04-02 08:34:15 -07002774
Paul Elliottdc42ca82023-02-24 18:11:59 +00002775 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002776
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002778
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002780}
2781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2783 const uint8_t *mac,
2784 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002785{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002786 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2787 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002790 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002791 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002792 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002795 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002796 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002797 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002798
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002800 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002801 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002802 }
2803
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 status = psa_driver_wrapper_mac_verify_finish(operation,
2805 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002806
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002807exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002809
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002811}
2812
Gilles Peskine449bd832023-01-11 14:50:10 +01002813static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2814 psa_algorithm_t alg,
2815 const uint8_t *input,
2816 size_t input_length,
2817 uint8_t *mac,
2818 size_t mac_size,
2819 size_t *mac_length,
2820 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002821{
2822 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002823 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2824 psa_key_slot_t *slot;
2825 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002826 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002827
Ronald Cron51131b52021-06-17 17:17:20 +02002828 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 key,
2830 &slot,
2831 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2832 alg);
2833 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002834 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002836
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002837 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002838 .core = slot->attr
2839 };
2840
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2842 &operation_mac_size);
2843 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002844 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002848 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002849 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002850 }
2851
2852 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 &attributes,
2854 slot->key.data, slot->key.bytes,
2855 alg,
2856 input, input_length,
2857 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002858
2859exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002860 /* In case of success, set the potential excess room in the output buffer
2861 * to an invalid value, to avoid potentially leaking a longer MAC.
2862 * In case of error, set the output length and content to a safe default,
2863 * such that in case the caller misses an error check, the output would be
2864 * an unachievable MAC.
2865 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002867 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002868 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002869 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002870
2871 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002872
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002876}
2877
Gilles Peskine449bd832023-01-11 14:50:10 +01002878psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002879 psa_algorithm_t alg,
2880 const uint8_t *input,
2881 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 uint8_t *mac,
2883 size_t mac_size,
2884 size_t *mac_length)
2885{
2886 return psa_mac_compute_internal(key, alg,
2887 input, input_length,
2888 mac, mac_size, mac_length, 1);
2889}
2890
2891psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2892 psa_algorithm_t alg,
2893 const uint8_t *input,
2894 size_t input_length,
2895 const uint8_t *mac,
2896 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002897{
2898 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002899 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2900 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002901
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 status = psa_mac_compute_internal(key, alg,
2903 input, input_length,
2904 actual_mac, sizeof(actual_mac),
2905 &actual_mac_length, 0);
2906 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002907 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002909
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002911 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002912 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002913 }
Dave Rodgman78701152023-08-29 14:20:18 +01002914 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002915 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002916 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002917 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002918
2919exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002923}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002924
Gilles Peskinee59236f2018-01-27 23:32:46 +01002925/****************************************************************/
2926/* Asymmetric cryptography */
2927/****************************************************************/
2928
Gilles Peskine449bd832023-01-11 14:50:10 +01002929static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2930 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002931{
Gilles Peskine449bd832023-01-11 14:50:10 +01002932 if (input_is_message) {
2933 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2934 return PSA_ERROR_INVALID_ARGUMENT;
2935 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2938 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2939 return PSA_ERROR_INVALID_ARGUMENT;
2940 }
2941 }
2942 } else {
2943 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2944 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002945 }
2946 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002947
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002949}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002950
Gilles Peskine449bd832023-01-11 14:50:10 +01002951static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2952 int input_is_message,
2953 psa_algorithm_t alg,
2954 const uint8_t *input,
2955 size_t input_length,
2956 uint8_t *signature,
2957 size_t signature_size,
2958 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002959{
2960 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2961 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2962 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002963 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002964
2965 *signature_length = 0;
2966
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 status = psa_sign_verify_check_alg(input_is_message, alg);
2968 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002969 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002971
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002972 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002973 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002974 * buffer can in principle be empty since it doesn't actually have
2975 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (signature_size == 0) {
2977 return PSA_ERROR_BUFFER_TOO_SMALL;
2978 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002979
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002980 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 key, &slot,
2982 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2983 PSA_KEY_USAGE_SIGN_HASH,
2984 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002987 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002989
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002991 status = PSA_ERROR_INVALID_ARGUMENT;
2992 goto exit;
2993 }
2994
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002995 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002997 };
2998
Gilles Peskine449bd832023-01-11 14:50:10 +01002999 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003000 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003001 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003002 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 signature, signature_size, signature_length);
3004 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003005
3006 status = psa_driver_wrapper_sign_hash(
3007 &attributes, slot->key.data, slot->key.bytes,
3008 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003010 }
3011
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003012
3013exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003014 psa_wipe_tag_output_buffer(signature, status, signature_size,
3015 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003016
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003020}
3021
Gilles Peskine449bd832023-01-11 14:50:10 +01003022static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3023 int input_is_message,
3024 psa_algorithm_t alg,
3025 const uint8_t *input,
3026 size_t input_length,
3027 const uint8_t *signature,
3028 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003029{
3030 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3031 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3032 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003033
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 status = psa_sign_verify_check_alg(input_is_message, alg);
3035 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003036 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003038
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003039 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 key, &slot,
3041 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3042 PSA_KEY_USAGE_VERIFY_HASH,
3043 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003044
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 if (status != PSA_SUCCESS) {
3046 return status;
3047 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003048
3049 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003051 };
3052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003054 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003055 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003056 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 signature, signature_length);
3058 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003059 status = psa_driver_wrapper_verify_hash(
3060 &attributes, slot->key.data, slot->key.bytes,
3061 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003063 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003064
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003066
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003068
3069}
3070
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003071psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003072 const psa_key_attributes_t *attributes,
3073 const uint8_t *key_buffer,
3074 size_t key_buffer_size,
3075 psa_algorithm_t alg,
3076 const uint8_t *input,
3077 size_t input_length,
3078 uint8_t *signature,
3079 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003081{
3082 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003083
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003085 size_t hash_length;
3086 uint8_t hash[PSA_HASH_MAX_SIZE];
3087
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003088 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 PSA_ALG_SIGN_GET_HASH(alg),
3090 input, input_length,
3091 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003092
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003094 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003096
3097 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 attributes, key_buffer, key_buffer_size,
3099 alg, hash, hash_length,
3100 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003101 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003102
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003104}
3105
Gilles Peskine449bd832023-01-11 14:50:10 +01003106psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3107 psa_algorithm_t alg,
3108 const uint8_t *input,
3109 size_t input_length,
3110 uint8_t *signature,
3111 size_t signature_size,
3112 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003113{
3114 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003115 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003117}
3118
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003119psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003120 const psa_key_attributes_t *attributes,
3121 const uint8_t *key_buffer,
3122 size_t key_buffer_size,
3123 psa_algorithm_t alg,
3124 const uint8_t *input,
3125 size_t input_length,
3126 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003128{
3129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003130
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003132 size_t hash_length;
3133 uint8_t hash[PSA_HASH_MAX_SIZE];
3134
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003135 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 PSA_ALG_SIGN_GET_HASH(alg),
3137 input, input_length,
3138 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003139
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003141 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003143
3144 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 attributes, key_buffer, key_buffer_size,
3146 alg, hash, hash_length,
3147 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003148 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003149
Gilles Peskine449bd832023-01-11 14:50:10 +01003150 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003151}
3152
Gilles Peskine449bd832023-01-11 14:50:10 +01003153psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3154 psa_algorithm_t alg,
3155 const uint8_t *input,
3156 size_t input_length,
3157 const uint8_t *signature,
3158 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003159{
3160 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003161 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003163}
3164
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003165psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003166 const psa_key_attributes_t *attributes,
3167 const uint8_t *key_buffer, size_t key_buffer_size,
3168 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003169 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003170{
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3172 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3173 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003174#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3176 return mbedtls_psa_rsa_sign_hash(
3177 attributes,
3178 key_buffer, key_buffer_size,
3179 alg, hash, hash_length,
3180 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003181#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3182 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 } else {
3184 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003185 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3187 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003188#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003189 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3190 return mbedtls_psa_ecdsa_sign_hash(
3191 attributes,
3192 key_buffer, key_buffer_size,
3193 alg, hash, hash_length,
3194 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003195#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3196 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 } else {
3198 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003199 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003200 }
Ronald Cron4501c982021-03-19 20:09:32 +01003201
Gilles Peskine449bd832023-01-11 14:50:10 +01003202 (void) key_buffer;
3203 (void) key_buffer_size;
3204 (void) hash;
3205 (void) hash_length;
3206 (void) signature;
3207 (void) signature_size;
3208 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003211}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003212
Gilles Peskine449bd832023-01-11 14:50:10 +01003213psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3214 psa_algorithm_t alg,
3215 const uint8_t *hash,
3216 size_t hash_length,
3217 uint8_t *signature,
3218 size_t signature_size,
3219 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003220{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003221 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003222 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003223 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003224}
3225
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003226psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003227 const psa_key_attributes_t *attributes,
3228 const uint8_t *key_buffer, size_t key_buffer_size,
3229 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003231{
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3233 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3234 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003235#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3237 return mbedtls_psa_rsa_verify_hash(
3238 attributes,
3239 key_buffer, key_buffer_size,
3240 alg, hash, hash_length,
3241 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003242#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3243 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 } else {
3245 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003246 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003247 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3248 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003249#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3251 return mbedtls_psa_ecdsa_verify_hash(
3252 attributes,
3253 key_buffer, key_buffer_size,
3254 alg, hash, hash_length,
3255 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003256#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3257 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 } else {
3259 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003260 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003261 }
Ronald Cron4501c982021-03-19 20:09:32 +01003262
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 (void) key_buffer;
3264 (void) key_buffer_size;
3265 (void) hash;
3266 (void) hash_length;
3267 (void) signature;
3268 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003269
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003271}
3272
Gilles Peskine449bd832023-01-11 14:50:10 +01003273psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3274 psa_algorithm_t alg,
3275 const uint8_t *hash,
3276 size_t hash_length,
3277 const uint8_t *signature,
3278 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003279{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003280 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003281 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003283}
3284
Gilles Peskine449bd832023-01-11 14:50:10 +01003285psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3286 psa_algorithm_t alg,
3287 const uint8_t *input,
3288 size_t input_length,
3289 const uint8_t *salt,
3290 size_t salt_length,
3291 uint8_t *output,
3292 size_t output_size,
3293 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003294{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003295 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003296 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003297 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003298 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003299
Darryl Green5cc689a2018-07-24 15:34:10 +01003300 (void) input;
3301 (void) input_length;
3302 (void) salt;
3303 (void) output;
3304 (void) output_size;
3305
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003306 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003307
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3309 return PSA_ERROR_INVALID_ARGUMENT;
3310 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003311
Ronald Cron5c522922020-11-14 16:35:34 +01003312 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3314 if (status != PSA_SUCCESS) {
3315 return status;
3316 }
3317 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3318 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003319 status = PSA_ERROR_INVALID_ARGUMENT;
3320 goto exit;
3321 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003322
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003323 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003324 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003325 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003326
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003327 status = psa_driver_wrapper_asymmetric_encrypt(
3328 &attributes, slot->key.data, slot->key.bytes,
3329 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003331exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003333
Gilles Peskine449bd832023-01-11 14:50:10 +01003334 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003335}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003336
Gilles Peskine449bd832023-01-11 14:50:10 +01003337psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3338 psa_algorithm_t alg,
3339 const uint8_t *input,
3340 size_t input_length,
3341 const uint8_t *salt,
3342 size_t salt_length,
3343 uint8_t *output,
3344 size_t output_size,
3345 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003346{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003347 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003348 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003349 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003350 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003351
Darryl Green5cc689a2018-07-24 15:34:10 +01003352 (void) input;
3353 (void) input_length;
3354 (void) salt;
3355 (void) output;
3356 (void) output_size;
3357
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003358 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003359
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3361 return PSA_ERROR_INVALID_ARGUMENT;
3362 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003363
Ronald Cron5c522922020-11-14 16:35:34 +01003364 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3366 if (status != PSA_SUCCESS) {
3367 return status;
3368 }
3369 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003370 status = PSA_ERROR_INVALID_ARGUMENT;
3371 goto exit;
3372 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003373
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003374 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003375 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003376 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003377
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003378 status = psa_driver_wrapper_asymmetric_decrypt(
3379 &attributes, slot->key.data, slot->key.bytes,
3380 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003381 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003382
3383exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003385
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003387}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003388
Paul Elliott9fe12f62022-11-30 19:16:02 +00003389/****************************************************************/
3390/* Asymmetric interruptible cryptography */
3391/****************************************************************/
3392
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003393static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3394
Paul Elliott9fe12f62022-11-30 19:16:02 +00003395void psa_interruptible_set_max_ops(uint32_t max_ops)
3396{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003397 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003398}
3399
3400uint32_t psa_interruptible_get_max_ops(void)
3401{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003402 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003403}
3404
Paul Elliott9fe12f62022-11-30 19:16:02 +00003405uint32_t psa_sign_hash_get_num_ops(
3406 const psa_sign_hash_interruptible_operation_t *operation)
3407{
Paul Elliott296ede92022-12-15 17:00:30 +00003408 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003409}
3410
3411uint32_t psa_verify_hash_get_num_ops(
3412 const psa_verify_hash_interruptible_operation_t *operation)
3413{
Paul Elliott296ede92022-12-15 17:00:30 +00003414 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003415}
3416
Paul Elliott59ad9452022-12-18 15:09:02 +00003417static psa_status_t psa_sign_hash_abort_internal(
3418 psa_sign_hash_interruptible_operation_t *operation)
3419{
3420 if (operation->id == 0) {
3421 /* The object has (apparently) been initialized but it is not (yet)
3422 * in use. It's ok to call abort on such an object, and there's
3423 * nothing to do. */
3424 return PSA_SUCCESS;
3425 }
3426
3427 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3428
3429 status = psa_driver_wrapper_sign_hash_abort(operation);
3430
3431 operation->id = 0;
3432
Paul Elliotte6145dc2023-02-07 12:51:21 +00003433 /* Do not clear either the error_occurred or num_ops elements here as they
3434 * only want to be cleared by the application calling abort, not by abort
3435 * being called at completion of an operation. */
3436
Paul Elliott59ad9452022-12-18 15:09:02 +00003437 return status;
3438}
3439
Paul Elliott9fe12f62022-11-30 19:16:02 +00003440psa_status_t psa_sign_hash_start(
3441 psa_sign_hash_interruptible_operation_t *operation,
3442 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3443 const uint8_t *hash, size_t hash_length)
3444{
3445 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3446 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3447 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003448 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003449
Paul Elliottc9774412023-02-06 15:14:07 +00003450 /* Check that start has not been previously called, or operation has not
3451 * previously errored. */
3452 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003453 return PSA_ERROR_BAD_STATE;
3454 }
3455
Paul Elliott9fe12f62022-11-30 19:16:02 +00003456 status = psa_sign_verify_check_alg(0, alg);
3457 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003458 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003459 return status;
3460 }
3461
3462 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3463 PSA_KEY_USAGE_SIGN_HASH,
3464 alg);
3465
3466 if (status != PSA_SUCCESS) {
3467 goto exit;
3468 }
3469
3470 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3471 status = PSA_ERROR_INVALID_ARGUMENT;
3472 goto exit;
3473 }
3474
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003475 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003476 .core = slot->attr
3477 };
3478
Paul Elliott296ede92022-12-15 17:00:30 +00003479 /* Ensure ops count gets reset, in case of operation re-use. */
3480 operation->num_ops = 0;
3481
Paul Elliott9fe12f62022-11-30 19:16:02 +00003482 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3483 slot->key.data,
3484 slot->key.bytes, alg,
3485 hash, hash_length);
3486exit:
3487
3488 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003489 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003490 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003491 }
3492
3493 unlock_status = psa_unlock_key_slot(slot);
3494
Paul Elliottc9774412023-02-06 15:14:07 +00003495 if (unlock_status != PSA_SUCCESS) {
3496 operation->error_occurred = 1;
3497 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003498
Paul Elliottc9774412023-02-06 15:14:07 +00003499 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003500}
3501
3502
3503psa_status_t psa_sign_hash_complete(
3504 psa_sign_hash_interruptible_operation_t *operation,
3505 uint8_t *signature, size_t signature_size,
3506 size_t *signature_length)
3507{
3508 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3509
3510 *signature_length = 0;
3511
Paul Elliottc9774412023-02-06 15:14:07 +00003512 /* Check that start has been called first, and that operation has not
3513 * previously errored. */
3514 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003515 status = PSA_ERROR_BAD_STATE;
3516 goto exit;
3517 }
3518
Paul Elliott096abc42023-02-03 18:33:23 +00003519 /* Immediately reject a zero-length signature buffer. This guarantees that
3520 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003521 if (signature_size == 0) {
3522 status = PSA_ERROR_BUFFER_TOO_SMALL;
3523 goto exit;
3524 }
3525
3526 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3527 signature_size,
3528 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003529
Paul Elliott296ede92022-12-15 17:00:30 +00003530 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003531 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003532
Paul Elliottebe225c2023-02-10 14:32:53 +00003533exit:
3534
Paul Elliott59200a22023-02-21 15:07:40 +00003535 psa_wipe_tag_output_buffer(signature, status, signature_size,
3536 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003537
Paul Elliott53bb3122023-02-10 14:22:22 +00003538 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003539 if (status != PSA_SUCCESS) {
3540 operation->error_occurred = 1;
3541 }
3542
Paul Elliott59ad9452022-12-18 15:09:02 +00003543 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003544 }
3545
3546 return status;
3547}
3548
3549psa_status_t psa_sign_hash_abort(
3550 psa_sign_hash_interruptible_operation_t *operation)
3551{
Paul Elliott59ad9452022-12-18 15:09:02 +00003552 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3553
3554 status = psa_sign_hash_abort_internal(operation);
3555
3556 /* We clear the number of ops done here, so that it is not cleared when
3557 * the operation fails or succeeds, only on manual abort. */
3558 operation->num_ops = 0;
3559
Paul Elliottc9774412023-02-06 15:14:07 +00003560 /* Likewise, failure state. */
3561 operation->error_occurred = 0;
3562
Paul Elliott59ad9452022-12-18 15:09:02 +00003563 return status;
3564}
3565
3566static psa_status_t psa_verify_hash_abort_internal(
3567 psa_verify_hash_interruptible_operation_t *operation)
3568{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003569 if (operation->id == 0) {
3570 /* The object has (apparently) been initialized but it is not (yet)
3571 * in use. It's ok to call abort on such an object, and there's
3572 * nothing to do. */
3573 return PSA_SUCCESS;
3574 }
3575
Paul Elliott59ad9452022-12-18 15:09:02 +00003576 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3577
3578 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003579
3580 operation->id = 0;
3581
Paul Elliotte6145dc2023-02-07 12:51:21 +00003582 /* Do not clear either the error_occurred or num_ops elements here as they
3583 * only want to be cleared by the application calling abort, not by abort
3584 * being called at completion of an operation. */
3585
Paul Elliott59ad9452022-12-18 15:09:02 +00003586 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003587}
3588
3589psa_status_t psa_verify_hash_start(
3590 psa_verify_hash_interruptible_operation_t *operation,
3591 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3592 const uint8_t *hash, size_t hash_length,
3593 const uint8_t *signature, size_t signature_length)
3594{
3595 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3596 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3597 psa_key_slot_t *slot;
3598
Paul Elliottc9774412023-02-06 15:14:07 +00003599 /* Check that start has not been previously called, or operation has not
3600 * previously errored. */
3601 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003602 return PSA_ERROR_BAD_STATE;
3603 }
3604
3605 status = psa_sign_verify_check_alg(0, alg);
3606 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003607 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003608 return status;
3609 }
3610
3611 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3612 PSA_KEY_USAGE_VERIFY_HASH,
3613 alg);
3614
3615 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003616 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003617 return status;
3618 }
3619
3620 psa_key_attributes_t attributes = {
3621 .core = slot->attr
3622 };
3623
Paul Elliott296ede92022-12-15 17:00:30 +00003624 /* Ensure ops count gets reset, in case of operation re-use. */
3625 operation->num_ops = 0;
3626
Paul Elliott9fe12f62022-11-30 19:16:02 +00003627 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3628 slot->key.data,
3629 slot->key.bytes,
3630 alg, hash, hash_length,
3631 signature, signature_length);
3632
3633 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003634 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003635 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003636 }
3637
3638 unlock_status = psa_unlock_key_slot(slot);
3639
Paul Elliottc9774412023-02-06 15:14:07 +00003640 if (unlock_status != PSA_SUCCESS) {
3641 operation->error_occurred = 1;
3642 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003643
Paul Elliottc9774412023-02-06 15:14:07 +00003644 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003645}
3646
3647psa_status_t psa_verify_hash_complete(
3648 psa_verify_hash_interruptible_operation_t *operation)
3649{
3650 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3651
Paul Elliottc9774412023-02-06 15:14:07 +00003652 /* Check that start has been called first, and that operation has not
3653 * previously errored. */
3654 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003655 status = PSA_ERROR_BAD_STATE;
3656 goto exit;
3657 }
3658
3659 status = psa_driver_wrapper_verify_hash_complete(operation);
3660
Paul Elliott296ede92022-12-15 17:00:30 +00003661 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003662 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003663 operation);
3664
Paul Elliottebe225c2023-02-10 14:32:53 +00003665exit:
3666
Paul Elliott9fe12f62022-11-30 19:16:02 +00003667 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003668 if (status != PSA_SUCCESS) {
3669 operation->error_occurred = 1;
3670 }
3671
Paul Elliott59ad9452022-12-18 15:09:02 +00003672 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003673 }
3674
3675 return status;
3676}
3677
3678psa_status_t psa_verify_hash_abort(
3679 psa_verify_hash_interruptible_operation_t *operation)
3680{
Paul Elliott59ad9452022-12-18 15:09:02 +00003681 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003682
Paul Elliott59ad9452022-12-18 15:09:02 +00003683 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003684
Paul Elliott59ad9452022-12-18 15:09:02 +00003685 /* We clear the number of ops done here, so that it is not cleared when
3686 * the operation fails or succeeds, only on manual abort. */
3687 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003688
Paul Elliottc9774412023-02-06 15:14:07 +00003689 /* Likewise, failure state. */
3690 operation->error_occurred = 0;
3691
Paul Elliott59ad9452022-12-18 15:09:02 +00003692 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003693}
3694
Paul Elliott588f8ed2022-12-02 18:10:26 +00003695/****************************************************************/
3696/* Asymmetric interruptible cryptography internal */
3697/* implementations */
3698/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003699
Paul Elliott588f8ed2022-12-02 18:10:26 +00003700void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3701{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003702
Paul Elliott588f8ed2022-12-02 18:10:26 +00003703#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3704 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3705 defined(MBEDTLS_ECP_RESTARTABLE)
3706
3707 /* Internal implementation uses zero to indicate infinite number max ops,
3708 * therefore avoid this value, and set to minimum possible. */
3709 if (max_ops == 0) {
3710 max_ops = 1;
3711 }
3712
Paul Elliott588f8ed2022-12-02 18:10:26 +00003713 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003714#else
3715 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003716#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3717 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3718 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3719}
3720
Paul Elliott588f8ed2022-12-02 18:10:26 +00003721uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003722 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003723{
3724#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3725 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3726 defined(MBEDTLS_ECP_RESTARTABLE)
3727
Paul Elliott93d9ca82023-02-15 18:14:21 +00003728 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003729#else
3730 (void) operation;
3731 return 0;
3732#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3733 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3734 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3735}
3736
3737uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003738 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003739{
3740 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3741 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3742 defined(MBEDTLS_ECP_RESTARTABLE)
3743
Paul Elliott93d9ca82023-02-15 18:14:21 +00003744 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003745#else
3746 (void) operation;
3747 return 0;
3748#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3749 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3750 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3751}
3752
3753psa_status_t mbedtls_psa_sign_hash_start(
3754 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3755 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3756 size_t key_buffer_size, psa_algorithm_t alg,
3757 const uint8_t *hash, size_t hash_length)
3758{
3759 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003760 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003761
Paul Elliott068fe072023-01-16 13:59:15 +00003762 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3763 return PSA_ERROR_NOT_SUPPORTED;
3764 }
3765
3766 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003767 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003768 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003769
3770#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003771 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3772 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003773
Paul Elliotta1c94092023-02-15 16:38:04 +00003774 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3775
Paul Elliott93d9ca82023-02-15 18:14:21 +00003776 /* Ensure num_ops is zero'ed in case of context re-use. */
3777 operation->num_ops = 0;
3778
Paul Elliott068fe072023-01-16 13:59:15 +00003779 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3780 attributes->core.bits,
3781 key_buffer,
3782 key_buffer_size,
3783 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003784
Paul Elliott068fe072023-01-16 13:59:15 +00003785 if (status != PSA_SUCCESS) {
3786 return status;
3787 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003788
Paul Elliott1bc59df2023-02-05 13:41:57 +00003789 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003790 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003791
Paul Elliott068fe072023-01-16 13:59:15 +00003792 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003793 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003794 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003795
Paul Elliott0290a762023-02-09 14:30:24 +00003796 /* We only need to store the same length of hash as the private key size
3797 * here, it would be truncated by the internal implementation anyway. */
3798 required_hash_length = (hash_length < operation->coordinate_bytes ?
3799 hash_length : operation->coordinate_bytes);
3800
Paul Elliottba70ad42023-02-15 18:23:53 +00003801 if (required_hash_length > sizeof(operation->hash)) {
3802 /* Shouldn't happen, but better safe than sorry. */
3803 return PSA_ERROR_CORRUPTION_DETECTED;
3804 }
3805
Paul Elliott0290a762023-02-09 14:30:24 +00003806 memcpy(operation->hash, hash, required_hash_length);
3807 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003808
3809 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003810
3811#else
Paul Elliott068fe072023-01-16 13:59:15 +00003812 (void) operation;
3813 (void) key_buffer;
3814 (void) key_buffer_size;
3815 (void) alg;
3816 (void) hash;
3817 (void) hash_length;
3818 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003819 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003820
Paul Elliott068fe072023-01-16 13:59:15 +00003821 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003822#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3823 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3824 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003825}
3826
3827psa_status_t mbedtls_psa_sign_hash_complete(
3828 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3829 uint8_t *signature, size_t signature_size,
3830 size_t *signature_length)
3831{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003832#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3833 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3834 defined(MBEDTLS_ECP_RESTARTABLE)
3835
Paul Elliotta1c94092023-02-15 16:38:04 +00003836 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003837 mbedtls_mpi r;
3838 mbedtls_mpi s;
3839
Paul Elliott46845252023-02-03 14:59:11 +00003840 mbedtls_mpi_init(&r);
3841 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003842
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003843 /* Ensure max_ops is set to the current value (or default). */
3844 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3845
Paul Elliotta1c94092023-02-15 16:38:04 +00003846 if (signature_size < 2 * operation->coordinate_bytes) {
3847 status = PSA_ERROR_BUFFER_TOO_SMALL;
3848 goto exit;
3849 }
3850
Paul Elliott588f8ed2022-12-02 18:10:26 +00003851 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003852
Paul Elliott588f8ed2022-12-02 18:10:26 +00003853#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3854 status = mbedtls_to_psa_error(
3855 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003856 &r,
3857 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003858 &operation->ctx->d,
3859 operation->hash,
3860 operation->hash_length,
3861 operation->md_alg,
3862 mbedtls_psa_get_random,
3863 MBEDTLS_PSA_RANDOM_STATE,
3864 &operation->restart_ctx));
3865#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003866 status = PSA_ERROR_NOT_SUPPORTED;
3867 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003868#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3869 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003870 status = mbedtls_to_psa_error(
3871 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003872 &r,
3873 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003874 &operation->ctx->d,
3875 operation->hash,
3876 operation->hash_length,
3877 mbedtls_psa_get_random,
3878 MBEDTLS_PSA_RANDOM_STATE,
3879 mbedtls_psa_get_random,
3880 MBEDTLS_PSA_RANDOM_STATE,
3881 &operation->restart_ctx));
3882 }
3883
Paul Elliottf8e5b562023-02-19 18:43:45 +00003884 /* Hide the fact that the restart context only holds a delta of number of
3885 * ops done during the last operation, not an absolute value. */
3886 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3887
Paul Elliott724bd252023-02-08 12:35:08 +00003888 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003889 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003890 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003891 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003892 operation->coordinate_bytes)
3893 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003894
3895 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003896 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003897 }
3898
3899 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003900 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003901 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003902 operation->coordinate_bytes,
3903 operation->coordinate_bytes)
3904 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003905
3906 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003907 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003908 }
3909
Paul Elliott1bc59df2023-02-05 13:41:57 +00003910 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003911
Paul Elliott724bd252023-02-08 12:35:08 +00003912 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003913 }
Paul Elliott724bd252023-02-08 12:35:08 +00003914
3915exit:
3916
3917 mbedtls_mpi_free(&r);
3918 mbedtls_mpi_free(&s);
3919 return status;
3920
Paul Elliott588f8ed2022-12-02 18:10:26 +00003921 #else
3922
3923 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003924 (void) signature;
3925 (void) signature_size;
3926 (void) signature_length;
3927
3928 return PSA_ERROR_NOT_SUPPORTED;
3929
3930#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3931 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3932 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3933}
3934
3935psa_status_t mbedtls_psa_sign_hash_abort(
3936 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3937{
3938
3939#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3940 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3941 defined(MBEDTLS_ECP_RESTARTABLE)
3942
3943 if (operation->ctx) {
3944 mbedtls_ecdsa_free(operation->ctx);
3945 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003946 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003947 }
3948
3949 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3950
Paul Elliott93d9ca82023-02-15 18:14:21 +00003951 operation->num_ops = 0;
3952
Paul Elliott588f8ed2022-12-02 18:10:26 +00003953 return PSA_SUCCESS;
3954
3955#else
3956
3957 (void) operation;
3958
3959 return PSA_ERROR_NOT_SUPPORTED;
3960
3961#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3962 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3963 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3964}
3965
3966psa_status_t mbedtls_psa_verify_hash_start(
3967 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3968 const psa_key_attributes_t *attributes,
3969 const uint8_t *key_buffer, size_t key_buffer_size,
3970 psa_algorithm_t alg,
3971 const uint8_t *hash, size_t hash_length,
3972 const uint8_t *signature, size_t signature_length)
3973{
3974 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003975 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003976 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003977
Paul Elliott068fe072023-01-16 13:59:15 +00003978 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3979 return PSA_ERROR_NOT_SUPPORTED;
3980 }
3981
3982 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003983 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003984 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003985
3986#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003987 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3988 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003989
Paul Elliotta1c94092023-02-15 16:38:04 +00003990 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3991 mbedtls_mpi_init(&operation->r);
3992 mbedtls_mpi_init(&operation->s);
3993
Paul Elliott93d9ca82023-02-15 18:14:21 +00003994 /* Ensure num_ops is zero'ed in case of context re-use. */
3995 operation->num_ops = 0;
3996
Paul Elliott068fe072023-01-16 13:59:15 +00003997 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3998 attributes->core.bits,
3999 key_buffer,
4000 key_buffer_size,
4001 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004002
Paul Elliott068fe072023-01-16 13:59:15 +00004003 if (status != PSA_SUCCESS) {
4004 return status;
4005 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004006
Paul Elliottc569fc22023-02-10 13:02:54 +00004007 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004008
Paul Elliott1bc59df2023-02-05 13:41:57 +00004009 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004010 return PSA_ERROR_INVALID_SIGNATURE;
4011 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004012
Paul Elliott068fe072023-01-16 13:59:15 +00004013 status = mbedtls_to_psa_error(
4014 mbedtls_mpi_read_binary(&operation->r,
4015 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004016 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004017
Paul Elliott068fe072023-01-16 13:59:15 +00004018 if (status != PSA_SUCCESS) {
4019 return status;
4020 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004021
Paul Elliott068fe072023-01-16 13:59:15 +00004022 status = mbedtls_to_psa_error(
4023 mbedtls_mpi_read_binary(&operation->s,
4024 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004025 coordinate_bytes,
4026 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004027
Paul Elliott068fe072023-01-16 13:59:15 +00004028 if (status != PSA_SUCCESS) {
4029 return status;
4030 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004031
Paul Elliott2c9843f2023-02-15 17:32:42 +00004032 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004033
Paul Elliott2c9843f2023-02-15 17:32:42 +00004034 if (status != PSA_SUCCESS) {
4035 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004036 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004037
Paul Elliott0290a762023-02-09 14:30:24 +00004038 /* We only need to store the same length of hash as the private key size
4039 * here, it would be truncated by the internal implementation anyway. */
4040 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4041 coordinate_bytes);
4042
Paul Elliottba70ad42023-02-15 18:23:53 +00004043 if (required_hash_length > sizeof(operation->hash)) {
4044 /* Shouldn't happen, but better safe than sorry. */
4045 return PSA_ERROR_CORRUPTION_DETECTED;
4046 }
4047
Paul Elliott0290a762023-02-09 14:30:24 +00004048 memcpy(operation->hash, hash, required_hash_length);
4049 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004050
4051 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004052#else
Paul Elliott068fe072023-01-16 13:59:15 +00004053 (void) operation;
4054 (void) key_buffer;
4055 (void) key_buffer_size;
4056 (void) alg;
4057 (void) hash;
4058 (void) hash_length;
4059 (void) signature;
4060 (void) signature_length;
4061 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004062 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004063 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004064
Paul Elliott068fe072023-01-16 13:59:15 +00004065 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004066#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4067 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4068 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004069}
4070
4071psa_status_t mbedtls_psa_verify_hash_complete(
4072 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4073{
4074
4075#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4076 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4077 defined(MBEDTLS_ECP_RESTARTABLE)
4078
Paul Elliottf8e5b562023-02-19 18:43:45 +00004079 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4080
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004081 /* Ensure max_ops is set to the current value (or default). */
4082 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4083
Paul Elliottf8e5b562023-02-19 18:43:45 +00004084 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004085 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4086 operation->hash,
4087 operation->hash_length,
4088 &operation->ctx->Q,
4089 &operation->r,
4090 &operation->s,
4091 &operation->restart_ctx));
4092
Paul Elliottf8e5b562023-02-19 18:43:45 +00004093 /* Hide the fact that the restart context only holds a delta of number of
4094 * ops done during the last operation, not an absolute value. */
4095 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4096
4097 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004098#else
4099 (void) operation;
4100
4101 return PSA_ERROR_NOT_SUPPORTED;
4102
4103#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4104 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4105 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4106}
4107
4108psa_status_t mbedtls_psa_verify_hash_abort(
4109 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4110{
4111
4112#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4113 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4114 defined(MBEDTLS_ECP_RESTARTABLE)
4115
4116 if (operation->ctx) {
4117 mbedtls_ecdsa_free(operation->ctx);
4118 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004119 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004120 }
4121
4122 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4123
Paul Elliott93d9ca82023-02-15 18:14:21 +00004124 operation->num_ops = 0;
4125
Paul Elliott588f8ed2022-12-02 18:10:26 +00004126 mbedtls_mpi_free(&operation->r);
4127 mbedtls_mpi_free(&operation->s);
4128
4129 return PSA_SUCCESS;
4130
4131#else
4132 (void) operation;
4133
4134 return PSA_ERROR_NOT_SUPPORTED;
4135
4136#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4137 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4138 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4139}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004140
mohammad1603503973b2018-03-12 15:59:30 +02004141/****************************************************************/
4142/* Symmetric cryptography */
4143/****************************************************************/
4144
Gilles Peskine449bd832023-01-11 14:50:10 +01004145static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4146 mbedtls_svc_key_id_t key,
4147 psa_algorithm_t alg,
4148 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004149{
4150 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4151 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004152 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4154 PSA_KEY_USAGE_ENCRYPT :
4155 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004156 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004157
4158 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004160 status = PSA_ERROR_BAD_STATE;
4161 goto exit;
4162 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004163
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004165 status = PSA_ERROR_INVALID_ARGUMENT;
4166 goto exit;
4167 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004168
Gilles Peskine449bd832023-01-11 14:50:10 +01004169 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4170 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004171 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004173
Ronald Cron49fafa92021-03-10 08:34:23 +01004174 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004175 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004176 * so we only set it (in the driver wrapper) after resources have been
4177 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004178 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004180 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004181 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004182 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 }
4184 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004185
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004186 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004188 };
4189
Ronald Cronab99ac22020-10-01 16:38:28 +02004190 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 if (cipher_operation == MBEDTLS_ENCRYPT) {
4192 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4193 &attributes,
4194 slot->key.data,
4195 slot->key.bytes,
4196 alg);
4197 } else {
4198 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4199 &attributes,
4200 slot->key.data,
4201 slot->key.bytes,
4202 alg);
4203 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004204
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004205exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004206 if (status != PSA_SUCCESS) {
4207 psa_cipher_abort(operation);
4208 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004209
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004211
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004213}
4214
Gilles Peskine449bd832023-01-11 14:50:10 +01004215psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4216 mbedtls_svc_key_id_t key,
4217 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004218{
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004220}
4221
Gilles Peskine449bd832023-01-11 14:50:10 +01004222psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4223 mbedtls_svc_key_id_t key,
4224 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004225{
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004227}
4228
Gilles Peskine449bd832023-01-11 14:50:10 +01004229psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4230 uint8_t *iv,
4231 size_t iv_size,
4232 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004233{
Ronald Cron6d051732020-10-01 14:10:20 +02004234 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004235 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004236 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004237
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004239 status = PSA_ERROR_BAD_STATE;
4240 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004241 }
4242
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004244 status = PSA_ERROR_BAD_STATE;
4245 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004246 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004247
Ronald Cron2fb90522021-07-05 12:31:44 +02004248 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004250 status = PSA_ERROR_BUFFER_TOO_SMALL;
4251 goto exit;
4252 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004253
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004255 status = PSA_ERROR_GENERIC_ERROR;
4256 goto exit;
4257 }
4258
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 status = psa_generate_random(local_iv, default_iv_length);
4260 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004261 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 }
Ronald Cron5618a392021-03-26 09:52:26 +01004263
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 status = psa_driver_wrapper_cipher_set_iv(operation,
4265 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004266
4267exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 if (status == PSA_SUCCESS) {
4269 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004270 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004271 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004273 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004275 }
Ronald Cron6d051732020-10-01 14:10:20 +02004276
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004278}
4279
Gilles Peskine449bd832023-01-11 14:50:10 +01004280psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4281 const uint8_t *iv,
4282 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004283{
Ronald Cron6d051732020-10-01 14:10:20 +02004284 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004285
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004287 status = PSA_ERROR_BAD_STATE;
4288 goto exit;
4289 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004290
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004292 status = PSA_ERROR_BAD_STATE;
4293 goto exit;
4294 }
Ronald Crona0d68172021-03-26 10:15:08 +01004295
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004297 status = PSA_ERROR_INVALID_ARGUMENT;
4298 goto exit;
4299 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004300
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 status = psa_driver_wrapper_cipher_set_iv(operation,
4302 iv,
4303 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004304
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004305exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004307 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 } else {
4309 psa_cipher_abort(operation);
4310 }
4311 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004312}
4313
Gilles Peskine449bd832023-01-11 14:50:10 +01004314psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4315 const uint8_t *input,
4316 size_t input_length,
4317 uint8_t *output,
4318 size_t output_size,
4319 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004320{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004321 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004322
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004324 status = PSA_ERROR_BAD_STATE;
4325 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004326 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004327
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004329 status = PSA_ERROR_BAD_STATE;
4330 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004331 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004332
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 status = psa_driver_wrapper_cipher_update(operation,
4334 input,
4335 input_length,
4336 output,
4337 output_size,
4338 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004339
4340exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 if (status != PSA_SUCCESS) {
4342 psa_cipher_abort(operation);
4343 }
Ronald Cron6d051732020-10-01 14:10:20 +02004344
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004346}
4347
Gilles Peskine449bd832023-01-11 14:50:10 +01004348psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4349 uint8_t *output,
4350 size_t output_size,
4351 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004352{
David Saadab4ecc272019-02-14 13:48:10 +02004353 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004354
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004356 status = PSA_ERROR_BAD_STATE;
4357 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004358 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004359
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004361 status = PSA_ERROR_BAD_STATE;
4362 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004363 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004364
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 status = psa_driver_wrapper_cipher_finish(operation,
4366 output,
4367 output_size,
4368 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004369
4370exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 if (status == PSA_SUCCESS) {
4372 return psa_cipher_abort(operation);
4373 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004374 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004376
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004378 }
mohammad1603503973b2018-03-12 15:59:30 +02004379}
4380
Gilles Peskine449bd832023-01-11 14:50:10 +01004381psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004382{
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004384 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004385 * in use. It's ok to call abort on such an object, and there's
4386 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004388 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004389
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004391
Ronald Cron49fafa92021-03-10 08:34:23 +01004392 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004393 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004394 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004395
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004397}
4398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4400 psa_algorithm_t alg,
4401 const uint8_t *input,
4402 size_t input_length,
4403 uint8_t *output,
4404 size_t output_size,
4405 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004406{
4407 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004408 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004409 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004410 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4411 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004412 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004413
David Horstmanne9a88ab2023-11-29 17:07:13 +00004414 SWAP_FOR_LOCAL_INPUT(input, input_length);
4415 SWAP_FOR_LOCAL_OUTPUT(output, output_size);
David Horstmannc6977b42023-11-27 17:43:05 +00004416
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004418 status = PSA_ERROR_INVALID_ARGUMENT;
4419 goto exit;
4420 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004421
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4423 PSA_KEY_USAGE_ENCRYPT,
4424 alg);
4425 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004426 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004428
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004429 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004431 };
4432
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4434 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004435 status = PSA_ERROR_GENERIC_ERROR;
4436 goto exit;
4437 }
4438
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 if (default_iv_length > 0) {
4440 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004441 status = PSA_ERROR_BUFFER_TOO_SMALL;
4442 goto exit;
4443 }
4444
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 status = psa_generate_random(local_iv, default_iv_length);
4446 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004447 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004449 }
4450
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004451 status = psa_driver_wrapper_cipher_encrypt(
4452 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004453 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004454 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004456
4457exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 unlock_status = psa_unlock_key_slot(slot);
4459 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004460 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004461 }
Ronald Cron23919522021-07-08 19:00:07 +02004462
Gilles Peskine449bd832023-01-11 14:50:10 +01004463 if (status == PSA_SUCCESS) {
4464 if (default_iv_length > 0) {
4465 memcpy(output, local_iv, default_iv_length);
4466 }
4467 *output_length += default_iv_length;
4468 } else {
4469 *output_length = 0;
4470 }
4471
David Horstmanne9a88ab2023-11-29 17:07:13 +00004472 FREE_LOCAL_INPUT(input);
4473 FREE_LOCAL_OUTPUT(output);
David Horstmannc6977b42023-11-27 17:43:05 +00004474
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004476}
4477
Gilles Peskine449bd832023-01-11 14:50:10 +01004478psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4479 psa_algorithm_t alg,
4480 const uint8_t *input,
4481 size_t input_length,
4482 uint8_t *output,
4483 size_t output_size,
4484 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004485{
4486 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004487 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004488 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004489 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004490
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004492 status = PSA_ERROR_INVALID_ARGUMENT;
4493 goto exit;
4494 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004495
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4497 PSA_KEY_USAGE_DECRYPT,
4498 alg);
4499 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004500 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004502
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004503 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004505 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004506
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4508 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004509 status = PSA_ERROR_INVALID_ARGUMENT;
4510 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004512 status = PSA_ERROR_INVALID_ARGUMENT;
4513 goto exit;
4514 }
4515
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004516 status = psa_driver_wrapper_cipher_decrypt(
4517 &attributes, slot->key.data, slot->key.bytes,
4518 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004520
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004521exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 unlock_status = psa_unlock_key_slot(slot);
4523 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004524 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004526
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004528 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 }
Ronald Cron23919522021-07-08 19:00:07 +02004530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004532}
4533
4534
mohammad16035955c982018-04-26 00:53:03 +03004535/****************************************************************/
4536/* AEAD */
4537/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004538
Paul Elliottbaff51c2021-09-28 17:44:45 +01004539/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004540static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004541{
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004543}
4544
4545/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004546static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4547 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004548{
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004552#if defined(PSA_WANT_ALG_GCM)
4553 case PSA_ALG_GCM:
4554 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 * arbitrarily large nonces. Please note that we do not generally
4556 * recommend the usage of nonces of greater length than
4557 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4558 * size, which can then lead to collisions if you encrypt a very
4559 * large number of messages.*/
4560 if (nonce_length != 0) {
4561 return PSA_SUCCESS;
4562 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004563 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004564#endif /* PSA_WANT_ALG_GCM */
4565#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004566 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 if (nonce_length >= 7 && nonce_length <= 13) {
4568 return PSA_SUCCESS;
4569 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004570 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004571#endif /* PSA_WANT_ALG_CCM */
4572#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004573 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 if (nonce_length == 12) {
4575 return PSA_SUCCESS;
4576 } else if (nonce_length == 8) {
4577 return PSA_ERROR_NOT_SUPPORTED;
4578 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004579 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004580#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004581 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004582 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004584 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004585
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004587}
4588
Gilles Peskine449bd832023-01-11 14:50:10 +01004589static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004590{
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4592 return PSA_ERROR_INVALID_ARGUMENT;
4593 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004594
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004596}
4597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4599 psa_algorithm_t alg,
4600 const uint8_t *nonce,
4601 size_t nonce_length,
4602 const uint8_t *additional_data,
4603 size_t additional_data_length,
4604 const uint8_t *plaintext,
4605 size_t plaintext_length,
4606 uint8_t *ciphertext,
4607 size_t ciphertext_size,
4608 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004609{
Ronald Cron215633c2021-03-16 17:15:37 +01004610 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4611 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004612
mohammad1603f08a5502018-06-03 15:05:47 +03004613 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004614
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 status = psa_aead_check_algorithm(alg);
4616 if (status != PSA_SUCCESS) {
4617 return status;
4618 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004619
Ronald Cron9a986162021-03-26 12:40:07 +01004620 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4622 if (status != PSA_SUCCESS) {
4623 return status;
4624 }
mohammad16035955c982018-04-26 00:53:03 +03004625
Ronald Cron215633c2021-03-16 17:15:37 +01004626 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004628 };
mohammad16035955c982018-04-26 00:53:03 +03004629
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 status = psa_aead_check_nonce_length(alg, nonce_length);
4631 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004632 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004634
Ronald Cronde822812021-03-17 16:08:20 +01004635 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004636 &attributes, slot->key.data, slot->key.bytes,
4637 alg,
4638 nonce, nonce_length,
4639 additional_data, additional_data_length,
4640 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004642
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4644 memset(ciphertext, 0, ciphertext_size);
4645 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004646
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004647exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004649
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004651}
4652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4654 psa_algorithm_t alg,
4655 const uint8_t *nonce,
4656 size_t nonce_length,
4657 const uint8_t *additional_data,
4658 size_t additional_data_length,
4659 const uint8_t *ciphertext,
4660 size_t ciphertext_length,
4661 uint8_t *plaintext,
4662 size_t plaintext_size,
4663 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004664{
Ronald Cron215633c2021-03-16 17:15:37 +01004665 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4666 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004667
Gilles Peskineee652a32018-06-01 19:23:52 +02004668 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 status = psa_aead_check_algorithm(alg);
4671 if (status != PSA_SUCCESS) {
4672 return status;
4673 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004674
Ronald Cron9a986162021-03-26 12:40:07 +01004675 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4677 if (status != PSA_SUCCESS) {
4678 return status;
4679 }
mohammad16035955c982018-04-26 00:53:03 +03004680
Ronald Cron215633c2021-03-16 17:15:37 +01004681 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004683 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004684
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 status = psa_aead_check_nonce_length(alg, nonce_length);
4686 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004687 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004689
Ronald Cronde822812021-03-17 16:08:20 +01004690 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004691 &attributes, slot->key.data, slot->key.bytes,
4692 alg,
4693 nonce, nonce_length,
4694 additional_data, additional_data_length,
4695 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004697
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 if (status != PSA_SUCCESS && plaintext_size != 0) {
4699 memset(plaintext, 0, plaintext_size);
4700 }
mohammad160360a64d02018-06-03 17:20:42 +03004701
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004702exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004704
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 return status;
mohammad16035955c982018-04-26 00:53:03 +03004706}
4707
Gilles Peskine449bd832023-01-11 14:50:10 +01004708static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4709{
4710 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004713#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004715 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4717 return PSA_ERROR_INVALID_ARGUMENT;
4718 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004719 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004720#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004721
Przemek Stekiel86679c72022-10-06 17:06:56 +02004722#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004724 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4726 return PSA_ERROR_INVALID_ARGUMENT;
4727 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004728 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004729#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004730
Przemek Stekiel86679c72022-10-06 17:06:56 +02004731#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004733 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 if (tag_len != 16) {
4735 return PSA_ERROR_INVALID_ARGUMENT;
4736 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004737 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004738#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004739
4740 default:
4741 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004743 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004745}
4746
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004747/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004748static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4749 int is_encrypt,
4750 mbedtls_svc_key_id_t key,
4751 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004752{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004753 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4754 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4755 psa_key_slot_t *slot = NULL;
4756 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004757 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 status = psa_aead_check_algorithm(alg);
4760 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004761 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004763
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004765 status = PSA_ERROR_BAD_STATE;
4766 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004767 }
4768
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 if (operation->nonce_set || operation->lengths_set ||
4770 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004771 status = PSA_ERROR_BAD_STATE;
4772 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004773 }
4774
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004776 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004778 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004780
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4782 alg);
4783 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004784 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004786
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004787 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004788 .core = slot->attr
4789 };
4790
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004792 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004794
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 if (is_encrypt) {
4796 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4797 &attributes,
4798 slot->key.data,
4799 slot->key.bytes,
4800 alg);
4801 } else {
4802 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4803 &attributes,
4804 slot->key.data,
4805 slot->key.bytes,
4806 alg);
4807 }
4808 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004809 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004811
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004813
4814exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004816
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004818 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004820 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 } else {
4822 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004823 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004824
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004826}
4827
Paul Elliott302ff6b2021-04-20 18:10:30 +01004828/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004829psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4830 mbedtls_svc_key_id_t key,
4831 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004832{
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004834}
4835
4836/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004837psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4838 mbedtls_svc_key_id_t key,
4839 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004840{
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004842}
4843
4844/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004845psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4846 uint8_t *nonce,
4847 size_t nonce_size,
4848 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004849{
4850 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004851 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004852 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004853
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004854 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004855
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004857 status = PSA_ERROR_BAD_STATE;
4858 goto exit;
4859 }
4860
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004862 status = PSA_ERROR_BAD_STATE;
4863 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004864 }
4865
Paul Elliotte193ea82021-10-01 13:00:16 +01004866 /* For CCM, this size may not be correct according to the PSA
4867 * specification. The PSA Crypto 1.0.1 specification states:
4868 *
4869 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4870 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4871 *
4872 * However this restriction that L has to be the smallest integer is not
4873 * applied in practice, and it is not implementable here since the
4874 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4876 operation->alg);
4877 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004878 status = PSA_ERROR_BUFFER_TOO_SMALL;
4879 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004880 }
4881
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 status = psa_generate_random(local_nonce, required_nonce_size);
4883 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004884 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004886
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004888
Paul Elliott39dc6b82021-05-11 19:16:09 +01004889exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 if (status == PSA_SUCCESS) {
4891 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004892 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 } else {
4894 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004895 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004896
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004898}
4899
4900/* Set the nonce for a multipart authenticated encryption or decryption
4901 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004902psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4903 const uint8_t *nonce,
4904 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004905{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004906 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4907
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004909 status = PSA_ERROR_BAD_STATE;
4910 goto exit;
4911 }
4912
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004914 status = PSA_ERROR_BAD_STATE;
4915 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004916 }
4917
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4919 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004920 status = PSA_ERROR_INVALID_ARGUMENT;
4921 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004922 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004923
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4925 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004926
Paul Elliott39dc6b82021-05-11 19:16:09 +01004927exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004929 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 } else {
4931 psa_aead_abort(operation);
4932 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004933
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004935}
4936
4937/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004938psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4939 size_t ad_length,
4940 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004941{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004942 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4943
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004945 status = PSA_ERROR_BAD_STATE;
4946 goto exit;
4947 }
4948
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 if (operation->lengths_set || operation->ad_started ||
4950 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004951 status = PSA_ERROR_BAD_STATE;
4952 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004953 }
4954
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004956#if defined(PSA_WANT_ALG_GCM)
4957 case PSA_ALG_GCM:
4958 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 * bits. Without the guard this code will generate warnings on 32bit
4960 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004961#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 if (((uint64_t) ad_length) >> 61 != 0 ||
4963 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004964 status = PSA_ERROR_INVALID_ARGUMENT;
4965 goto exit;
4966 }
Paul Elliott325d3742021-09-27 17:56:28 +01004967#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004968 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004969#endif /* PSA_WANT_ALG_GCM */
4970#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004971 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004973 status = PSA_ERROR_INVALID_ARGUMENT;
4974 goto exit;
4975 }
4976 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004977#endif /* PSA_WANT_ALG_CCM */
4978#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004979 case PSA_ALG_CHACHA20_POLY1305:
4980 /* No length restrictions for ChaChaPoly. */
4981 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004982#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004983 default:
4984 break;
4985 }
Paul Elliott325d3742021-09-27 17:56:28 +01004986
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4988 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004989
Paul Elliott39dc6b82021-05-11 19:16:09 +01004990exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004992 operation->ad_remaining = ad_length;
4993 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004994 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 } else {
4996 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004997 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004998
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005000}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005001
5002/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005003psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5004 const uint8_t *input,
5005 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005006{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005007 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5008
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005010 status = PSA_ERROR_BAD_STATE;
5011 goto exit;
5012 }
5013
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005015 status = PSA_ERROR_BAD_STATE;
5016 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005017 }
5018
Gilles Peskine449bd832023-01-11 14:50:10 +01005019 if (operation->lengths_set) {
5020 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005021 status = PSA_ERROR_INVALID_ARGUMENT;
5022 goto exit;
5023 }
5024
5025 operation->ad_remaining -= input_length;
5026 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005027#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005029 status = PSA_ERROR_BAD_STATE;
5030 goto exit;
5031 }
5032#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005033
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 status = psa_driver_wrapper_aead_update_ad(operation, input,
5035 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005036
Paul Elliott39dc6b82021-05-11 19:16:09 +01005037exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005039 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 } else {
5041 psa_aead_abort(operation);
5042 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005043
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005045}
5046
5047/* Encrypt or decrypt a message fragment in an active multipart AEAD
5048 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005049psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5050 const uint8_t *input,
5051 size_t input_length,
5052 uint8_t *output,
5053 size_t output_size,
5054 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005055{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005056 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005057
5058 *output_length = 0;
5059
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005061 status = PSA_ERROR_BAD_STATE;
5062 goto exit;
5063 }
5064
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005066 status = PSA_ERROR_BAD_STATE;
5067 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005068 }
5069
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005071 /* Additional data length was supplied, but not all the additional
5072 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005074 status = PSA_ERROR_INVALID_ARGUMENT;
5075 goto exit;
5076 }
5077
5078 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005080 status = PSA_ERROR_INVALID_ARGUMENT;
5081 goto exit;
5082 }
5083
5084 operation->body_remaining -= input_length;
5085 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005086#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005088 status = PSA_ERROR_BAD_STATE;
5089 goto exit;
5090 }
5091#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005092
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5094 output, output_size,
5095 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005096
Paul Elliott39dc6b82021-05-11 19:16:09 +01005097exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005099 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 } else {
5101 psa_aead_abort(operation);
5102 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005103
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005105}
5106
Gilles Peskine449bd832023-01-11 14:50:10 +01005107static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005108{
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 if (operation->id == 0 || !operation->nonce_set) {
5110 return PSA_ERROR_BAD_STATE;
5111 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005112
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5114 operation->body_remaining != 0)) {
5115 return PSA_ERROR_INVALID_ARGUMENT;
5116 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005117
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005119}
5120
Paul Elliott302ff6b2021-04-20 18:10:30 +01005121/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005122psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5123 uint8_t *ciphertext,
5124 size_t ciphertext_size,
5125 size_t *ciphertext_length,
5126 uint8_t *tag,
5127 size_t tag_size,
5128 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005129{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005130 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5131
Paul Elliott302ff6b2021-04-20 18:10:30 +01005132 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005133 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005134
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 status = psa_aead_final_checks(operation);
5136 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005137 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005139
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005141 status = PSA_ERROR_BAD_STATE;
5142 goto exit;
5143 }
5144
Gilles Peskine449bd832023-01-11 14:50:10 +01005145 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5146 ciphertext_size,
5147 ciphertext_length,
5148 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005149
Paul Elliott39dc6b82021-05-11 19:16:09 +01005150exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005151
5152
Paul Elliottf47b0952021-05-21 18:02:33 +01005153 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005154 * the zero tag size, make sure the tag is set to something implausible.
5155 * Even if the operation succeeds, make sure we clear the rest of the
5156 * buffer to prevent potential leakage of anything previously placed in
5157 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005158 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005159
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005163}
5164
5165/* Finish authenticating and decrypting a message in a multipart AEAD
5166 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005167psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5168 uint8_t *plaintext,
5169 size_t plaintext_size,
5170 size_t *plaintext_length,
5171 const uint8_t *tag,
5172 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005173{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005174 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5175
Paul Elliott302ff6b2021-04-20 18:10:30 +01005176 *plaintext_length = 0;
5177
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 status = psa_aead_final_checks(operation);
5179 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005180 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005182
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005184 status = PSA_ERROR_BAD_STATE;
5185 goto exit;
5186 }
5187
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5189 plaintext_size,
5190 plaintext_length,
5191 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005192
5193exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005195
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005197}
5198
5199/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005200psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005201{
5202 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5203
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005205 /* The object has (apparently) been initialized but it is not (yet)
5206 * in use. It's ok to call abort on such an object, and there's
5207 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005209 }
5210
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005214
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005216}
5217
Gilles Peskinee59236f2018-01-27 23:32:46 +01005218/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005219/* Generators */
5220/****************************************************************/
5221
Przemek Stekiel69c46792022-06-10 12:59:51 +02005222#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005223 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005224 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305225 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305226 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005227#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005228#endif /* At least one builtin KDF */
5229
Przemek Stekiel69c46792022-06-10 12:59:51 +02005230#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005231 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5232 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5233static psa_status_t psa_key_derivation_start_hmac(
5234 psa_mac_operation_t *operation,
5235 psa_algorithm_t hash_alg,
5236 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005238{
5239 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5240 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5242 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5243 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005244
Steven Cooreman72f736a2021-05-07 14:14:37 +02005245 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005247
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 status = psa_driver_wrapper_mac_sign_setup(operation,
5249 &attributes,
5250 hmac_key, hmac_key_length,
5251 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005252
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 psa_reset_key_attributes(&attributes);
5254 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005255}
5256#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005257
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005258#define HKDF_STATE_INIT 0 /* no input yet */
5259#define HKDF_STATE_STARTED 1 /* got salt */
5260#define HKDF_STATE_KEYED 2 /* got key */
5261#define HKDF_STATE_OUTPUT 3 /* output started */
5262
Gilles Peskinecbe66502019-05-16 16:59:18 +02005263static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005265{
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5267 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5268 } else {
5269 return operation->alg;
5270 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005271}
5272
Gilles Peskine449bd832023-01-11 14:50:10 +01005273psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005274{
5275 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5277 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005278 /* The object has (apparently) been initialized but it is not
5279 * in use. It's ok to call abort on such an object, and there's
5280 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005282#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5284 mbedtls_free(operation->ctx.hkdf.info);
5285 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5286 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005287#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005288#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5289 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5291 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5292 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5293 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005294 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005295 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005296 }
5297
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005299 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005301 }
5302
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005304 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005306 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005307#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005309 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005311 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005312#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005313 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005314
5315 /* We leave the fields Ai and output_block to be erased safely by the
5316 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005318#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5319 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005320#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5322 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5323 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5324 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005325#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305326#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305327 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305328 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005329 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305330 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305331 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305332
5333 status = PSA_SUCCESS;
5334 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305335#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005336 {
5337 status = PSA_ERROR_BAD_STATE;
5338 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 mbedtls_platform_zeroize(operation, sizeof(*operation));
5340 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005341}
5342
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005343psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005345{
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005347 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005349 }
5350
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005351 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005353}
5354
Gilles Peskine449bd832023-01-11 14:50:10 +01005355psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5356 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005357{
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 if (operation->alg == 0) {
5359 return PSA_ERROR_BAD_STATE;
5360 }
5361 if (capacity > operation->capacity) {
5362 return PSA_ERROR_INVALID_ARGUMENT;
5363 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005364 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005366}
5367
Przemek Stekiel69c46792022-06-10 12:59:51 +02005368#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005369/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005370static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5371 psa_algorithm_t kdf_alg,
5372 uint8_t *output,
5373 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005374{
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5376 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005377 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005378 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005379#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005381#else
5382 const uint8_t last_block = 0xff;
5383#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005384
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 if (hkdf->state < HKDF_STATE_KEYED ||
5386 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005387#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005389#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 )) {
5391 return PSA_ERROR_BAD_STATE;
5392 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005393 hkdf->state = HKDF_STATE_OUTPUT;
5394
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005396 /* Copy what remains of the current block */
5397 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005399 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 }
5401 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005402 output += n;
5403 output_length -= n;
5404 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005406 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005408 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005409 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005410 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005411 * object was corrupted or if this function is called directly
5412 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 if (hkdf->block_number == last_block) {
5414 return PSA_ERROR_BAD_STATE;
5415 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005416
5417 /* We need a new block */
5418 ++hkdf->block_number;
5419 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005420
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5422 hash_alg,
5423 hkdf->prk,
5424 hash_length);
5425 if (status != PSA_SUCCESS) {
5426 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005427 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005428
5429 if (hkdf->block_number != 1) {
5430 status = psa_mac_update(&hkdf->hmac,
5431 hkdf->output_block,
5432 hash_length);
5433 if (status != PSA_SUCCESS) {
5434 return status;
5435 }
5436 }
5437 status = psa_mac_update(&hkdf->hmac,
5438 hkdf->info,
5439 hkdf->info_length);
5440 if (status != PSA_SUCCESS) {
5441 return status;
5442 }
5443 status = psa_mac_update(&hkdf->hmac,
5444 &hkdf->block_number, 1);
5445 if (status != PSA_SUCCESS) {
5446 return status;
5447 }
5448 status = psa_mac_sign_finish(&hkdf->hmac,
5449 hkdf->output_block,
5450 sizeof(hkdf->output_block),
5451 &hmac_output_length);
5452 if (status != PSA_SUCCESS) {
5453 return status;
5454 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005455 }
5456
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005458}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005459#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005460
John Durkop07cc04a2020-11-16 22:08:34 -08005461#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5462 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005463static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5464 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005466{
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5468 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005469 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5470 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005471 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005472
Janos Follath7742fee2019-06-17 12:58:10 +01005473 /* We can't be wanting more output after block 0xff, otherwise
5474 * the capacity check in psa_key_derivation_output_bytes() would have
5475 * prevented this call. It could happen only if the operation
5476 * object was corrupted or if this function is called directly
5477 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 if (tls12_prf->block_number == 0xff) {
5479 return PSA_ERROR_CORRUPTION_DETECTED;
5480 }
Janos Follath7742fee2019-06-17 12:58:10 +01005481
5482 /* We need a new block */
5483 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005484 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005485
5486 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5487 *
5488 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5489 *
5490 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5491 * HMAC_hash(secret, A(2) + seed) +
5492 * HMAC_hash(secret, A(3) + seed) + ...
5493 *
5494 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005495 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005496 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005497 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005498 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005499 * is currently extracted as `output_block` and where i is
5500 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005501 */
5502
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 status = psa_key_derivation_start_hmac(&hmac,
5504 hash_alg,
5505 tls12_prf->secret,
5506 tls12_prf->secret_length);
5507 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005508 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005510
5511 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005513 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5514 * the variable seed and in this instance means it in the context of the
5515 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 status = psa_mac_update(&hmac,
5517 tls12_prf->label,
5518 tls12_prf->label_length);
5519 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005520 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 }
5522 status = psa_mac_update(&hmac,
5523 tls12_prf->seed,
5524 tls12_prf->seed_length);
5525 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005526 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 }
5528 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005529 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5531 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005532 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005534 }
5535
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 status = psa_mac_sign_finish(&hmac,
5537 tls12_prf->Ai, hash_length,
5538 &hmac_output_length);
5539 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005540 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 }
5542 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005543 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005545
5546 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 status = psa_key_derivation_start_hmac(&hmac,
5548 hash_alg,
5549 tls12_prf->secret,
5550 tls12_prf->secret_length);
5551 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005552 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 }
5554 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5555 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005556 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 }
5558 status = psa_mac_update(&hmac, tls12_prf->label, 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, tls12_prf->seed, tls12_prf->seed_length);
5563 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005564 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 }
5566 status = psa_mac_sign_finish(&hmac,
5567 tls12_prf->output_block, hash_length,
5568 &hmac_output_length);
5569 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005570 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005572
Janos Follath7742fee2019-06-17 12:58:10 +01005573
5574cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 cleanup_status = psa_mac_abort(&hmac);
5576 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005577 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005579
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005581}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005582
Janos Follath844eb0e2019-06-19 12:10:49 +01005583static psa_status_t psa_key_derivation_tls12_prf_read(
5584 psa_tls12_prf_key_derivation_t *tls12_prf,
5585 psa_algorithm_t alg,
5586 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005588{
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5590 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005591 psa_status_t status;
5592 uint8_t offset, length;
5593
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005595 case PSA_TLS12_PRF_STATE_LABEL_SET:
5596 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5597 break;
5598 case PSA_TLS12_PRF_STATE_OUTPUT:
5599 break;
5600 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005602 }
5603
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005605 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 if (tls12_prf->left_in_block == 0) {
5607 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5608 alg);
5609 if (status != PSA_SUCCESS) {
5610 return status;
5611 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005612
5613 continue;
5614 }
5615
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005617 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005619 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005621
5622 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005624 output += length;
5625 output_length -= length;
5626 tls12_prf->left_in_block -= length;
5627 }
5628
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005630}
John Durkop07cc04a2020-11-16 22:08:34 -08005631#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5632 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005633
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005634#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5635static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5636 psa_tls12_ecjpake_to_pms_t *ecjpake,
5637 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005639{
5640 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005641 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005642
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 if (output_length != 32) {
5644 return PSA_ERROR_INVALID_ARGUMENT;
5645 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005646
Gilles Peskine449bd832023-01-11 14:50:10 +01005647 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5648 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5649 &output_size);
5650 if (status != PSA_SUCCESS) {
5651 return status;
5652 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005653
Gilles Peskine449bd832023-01-11 14:50:10 +01005654 if (output_size != output_length) {
5655 return PSA_ERROR_GENERIC_ERROR;
5656 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005657
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005659}
5660#endif
5661
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305662#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305663static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5664 psa_pbkdf2_key_derivation_t *pbkdf2,
5665 psa_algorithm_t prf_alg,
5666 uint8_t prf_output_length,
5667 psa_key_attributes_t *attributes)
5668{
5669 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305670 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305671 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305672 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305673 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305674 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305675 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305676
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305677 mac_operation.is_sign = 1;
5678 mac_operation.mac_size = prf_output_length;
5679 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305680
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305681 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5682 attributes,
5683 pbkdf2->password,
5684 pbkdf2->password_length,
5685 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305686 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305687 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305688 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305689 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5690 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305691 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305692 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305693 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305694 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305695 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305696 }
5697 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5698 &mac_output_length);
5699 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305700 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305701 }
5702
5703 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305704 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305705 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305706 }
5707
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305708 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305709
5710 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305711 /* We are passing prf_output_length as mac_size because the driver
5712 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305713 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305714 status = psa_driver_wrapper_mac_compute(attributes,
5715 pbkdf2->password,
5716 pbkdf2->password_length,
5717 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305718 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305719 &mac_output_length);
5720 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305721 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305722 }
5723
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305724 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305725 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305726
5727cleanup:
5728 /* Zeroise buffers to clear sensitive data from memory. */
5729 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5730 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305731}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305732
5733static psa_status_t psa_key_derivation_pbkdf2_read(
5734 psa_pbkdf2_key_derivation_t *pbkdf2,
5735 psa_algorithm_t kdf_alg,
5736 uint8_t *output,
5737 size_t output_length)
5738{
5739 psa_status_t status;
5740 psa_algorithm_t prf_alg;
5741 uint8_t prf_output_length;
5742 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5743 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5744 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5745
5746 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5747 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5748 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5749 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305750 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5751 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305752 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305753 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305754 } else {
5755 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305756 }
5757
5758 switch (pbkdf2->state) {
5759 case PSA_PBKDF2_STATE_PASSWORD_SET:
5760 /* Initially we need a new block so bytes_used is equal to block size*/
5761 pbkdf2->bytes_used = prf_output_length;
5762 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5763 break;
5764 case PSA_PBKDF2_STATE_OUTPUT:
5765 break;
5766 default:
5767 return PSA_ERROR_BAD_STATE;
5768 }
5769
5770 while (output_length != 0) {
5771 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5772 if (n > output_length) {
5773 n = (uint8_t) output_length;
5774 }
5775 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5776 output += n;
5777 output_length -= n;
5778 pbkdf2->bytes_used += n;
5779
5780 if (output_length == 0) {
5781 break;
5782 }
5783
5784 /* We need a new block */
5785 pbkdf2->bytes_used = 0;
5786 pbkdf2->block_number++;
5787
5788 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5789 prf_output_length,
5790 &attributes);
5791 if (status != PSA_SUCCESS) {
5792 return status;
5793 }
5794 }
5795
5796 return PSA_SUCCESS;
5797}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305798#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305799
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005800psa_status_t psa_key_derivation_output_bytes(
5801 psa_key_derivation_operation_t *operation,
5802 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005804{
5805 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005807
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005809 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005811 }
5812
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005814 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005815 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005816 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005817 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005818 goto exit;
5819 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005821 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005822 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005823 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5824 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005825 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005826 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005828 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005829 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005830
Przemek Stekiel69c46792022-06-10 12:59:51 +02005831#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5833 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5834 output, output_length);
5835 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005836#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005837#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5838 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5840 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5841 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5842 kdf_alg, output,
5843 output_length);
5844 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005845#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5846 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005847#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005849 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5851 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005852#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305853#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305854 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305855 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5856 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305857 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305858#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005859
Gilles Peskineeab56e42018-07-12 17:12:33 +02005860 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005861 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005863 }
5864
5865exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005867 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005868 * This allows us to differentiate between exhausted operations and
5869 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5870 * operations. */
5871 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005873 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005875 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005877}
5878
David Brown7807bf72021-02-09 16:28:23 -07005879#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005880static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005881{
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 if (data_size >= 8) {
5883 mbedtls_des_key_set_parity(data);
5884 }
5885 if (data_size >= 16) {
5886 mbedtls_des_key_set_parity(data + 8);
5887 }
5888 if (data_size >= 24) {
5889 mbedtls_des_key_set_parity(data + 16);
5890 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005891}
David Brown7807bf72021-02-09 16:28:23 -07005892#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005893
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005894/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005895 * ECC keys on a Weierstrass elliptic curve require the generation
5896 * of a private key which is an integer
5897 * in the range [1, N - 1], where N is the boundary of the private key domain:
5898 * N is the prime p for Diffie-Hellman, or the order of the
5899 * curve’s base point for ECC.
5900 *
5901 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5902 * This function generates the private key using the following process:
5903 *
5904 * 1. Draw a byte string of length ceiling(m/8) bytes.
5905 * 2. If m is not a multiple of 8, set the most significant
5906 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5907 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5908 * 4. If k > N - 2, discard the result and return to step 1.
5909 * 5. Output k + 1 as the private key.
5910 *
5911 * This method allows compliance to NIST standards, specifically the methods titled
5912 * Key-Pair Generation by Testing Candidates in the following publications:
5913 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5914 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5915 * Diffie-Hellman keys.
5916 *
5917 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5918 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5919 *
5920 * Note: Function allocates memory for *data buffer, so given *data should be
5921 * always NULL.
5922 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005923#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5924#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005925static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005926 psa_key_slot_t *slot,
5927 size_t bits,
5928 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005929 uint8_t **data
5930 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005931{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005932 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005933 mbedtls_mpi k;
5934 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005935 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005936 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005937 size_t m;
5938 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005939
Gilles Peskine449bd832023-01-11 14:50:10 +01005940 mbedtls_mpi_init(&k);
5941 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005942
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005943 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005945 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005947
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005949 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005950 goto cleanup;
5951 }
5952
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005953 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005955
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005957
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005958 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005959 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005960 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005961
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005962 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005963
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005964 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005966
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005967 /* Note: This function is always called with *data == NULL and it
5968 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 *data = mbedtls_calloc(1, m_bytes);
5970 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005971 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005972 goto cleanup;
5973 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005974
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005976 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005978 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005980
5981 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005983 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005984 * (8 * ceiling(m/8) - m) bits of the first byte in
5985 * the string to zero.
5986 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005988 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005989 }
5990
5991 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 * big-endian byte string.
5993 */
5994 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005995
5996 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 * Result of comparison is returned. When it indicates error
5998 * then this function is called again.
5999 */
6000 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006001 }
6002
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006003 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6005 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006006cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 if (ret != 0) {
6008 status = mbedtls_to_psa_error(ret);
6009 }
6010 if (status != PSA_SUCCESS) {
6011 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006012 *data = NULL;
6013 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 mbedtls_mpi_free(&k);
6015 mbedtls_mpi_free(&diff_N_2);
6016 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006017}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006018
6019/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6020 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6021 *
6022 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6023 * draw a 32-byte string and process it as specified in
6024 * Elliptic Curves for Security [RFC7748] §5.
6025 *
6026 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6027 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6028 *
6029 * Note: Function allocates memory for *data buffer, so given *data should be
6030 * always NULL.
6031 */
6032
6033static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6034 size_t bits,
6035 psa_key_derivation_operation_t *operation,
6036 uint8_t **data
6037 )
6038{
6039 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006040 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006041
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006043 case 255:
6044 output_length = 32;
6045 break;
6046 case 448:
6047 output_length = 56;
6048 break;
6049 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006051 break;
6052 }
6053
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006055
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 if (*data == NULL) {
6057 return PSA_ERROR_INSUFFICIENT_MEMORY;
6058 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006059
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006061
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006063 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006065
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006067 case 255:
6068 (*data)[0] &= 248;
6069 (*data)[31] &= 127;
6070 (*data)[31] |= 64;
6071 break;
6072 case 448:
6073 (*data)[0] &= 252;
6074 (*data)[55] |= 128;
6075 break;
6076 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006078 break;
6079 }
6080
6081 return status;
6082}
Valerio Setti86587ab2023-06-27 13:09:30 +02006083#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6084static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6085 psa_key_slot_t *slot, size_t bits,
6086 psa_key_derivation_operation_t *operation, uint8_t **data)
6087{
6088 (void) slot;
6089 (void) bits;
6090 (void) operation;
6091 (void) data;
6092 return PSA_ERROR_NOT_SUPPORTED;
6093}
6094
6095static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6096 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6097{
6098 (void) bits;
6099 (void) operation;
6100 (void) data;
6101 return PSA_ERROR_NOT_SUPPORTED;
6102}
6103#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6104#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006105
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006106static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006107 psa_key_slot_t *slot,
6108 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006110{
6111 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306113 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006114 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006115 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006116
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6118 return PSA_ERROR_INVALID_ARGUMENT;
6119 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006120
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006121#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006122 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6124 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6125 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006126 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006127 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6128 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006129 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 }
6131 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006132 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6134 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006135 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006137 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006138 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006139#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006140 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 if (key_type_is_raw_bytes(slot->attr.type)) {
6142 if (bits % 8 != 0) {
6143 return PSA_ERROR_INVALID_ARGUMENT;
6144 }
6145 data = mbedtls_calloc(1, bytes);
6146 if (data == NULL) {
6147 return PSA_ERROR_INSUFFICIENT_MEMORY;
6148 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006149
Gilles Peskine449bd832023-01-11 14:50:10 +01006150 status = psa_key_derivation_output_bytes(operation, data, bytes);
6151 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006152 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 }
David Brown12ca5032021-02-11 11:02:00 -07006154#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6156 psa_des_set_key_parity(data, bytes);
6157 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006158#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 } else {
6160 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006161 }
Ronald Crondd04d422020-11-28 15:14:42 +01006162
Ronald Cronbf33c932020-11-28 18:06:53 +01006163 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006164 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006166 };
6167
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6169 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6170 &storage_size);
6171 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306172 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 }
Archanad8a83dc2021-06-14 10:04:16 +05306174 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 status = psa_allocate_buffer_to_slot(slot, storage_size);
6176 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306177 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 }
Archanad8a83dc2021-06-14 10:04:16 +05306179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 status = psa_driver_wrapper_import_key(&attributes,
6181 data, bytes,
6182 slot->key.data,
6183 slot->key.bytes,
6184 &slot->key.bytes, &bits);
6185 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006186 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006188
6189exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 mbedtls_free(data);
6191 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006192}
6193
Gilles Peskine449bd832023-01-11 14:50:10 +01006194psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6195 psa_key_derivation_operation_t *operation,
6196 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006197{
6198 psa_status_t status;
6199 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006200 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006201
Ronald Cron81709fc2020-11-14 12:10:32 +01006202 *key = MBEDTLS_SVC_KEY_ID_INIT;
6203
Gilles Peskine0f84d622019-09-12 19:03:13 +02006204 /* Reject any attempt to create a zero-length key so that we don't
6205 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 if (psa_get_key_bits(attributes) == 0) {
6207 return PSA_ERROR_INVALID_ARGUMENT;
6208 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006209
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 if (operation->alg == PSA_ALG_NONE) {
6211 return PSA_ERROR_BAD_STATE;
6212 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006213
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 if (!operation->can_output_key) {
6215 return PSA_ERROR_NOT_PERMITTED;
6216 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006217
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6219 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006220#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006221 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006222 /* Deriving a key in a secure element is not implemented yet. */
6223 status = PSA_ERROR_NOT_SUPPORTED;
6224 }
6225#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 if (status == PSA_SUCCESS) {
6227 status = psa_generate_derived_key_internal(slot,
6228 attributes->core.bits,
6229 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006230 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 if (status == PSA_SUCCESS) {
6232 status = psa_finish_key_creation(slot, driver, key);
6233 }
6234 if (status != PSA_SUCCESS) {
6235 psa_fail_key_creation(slot, driver);
6236 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006237
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006239}
6240
Gilles Peskineeab56e42018-07-12 17:12:33 +02006241
6242
6243/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006244/* Key derivation */
6245/****************************************************************/
6246
Steven Cooreman932ffb72021-02-15 12:14:32 +01006247#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006248static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006249{
6250#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6252 return 1;
6253 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006254#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006255#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6257 return 1;
6258 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006259#endif
6260#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6262 return 1;
6263 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006264#endif
6265#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6267 return 1;
6268 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006269#endif
6270#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6272 return 1;
6273 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006274#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006275#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006276 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6277 return 1;
6278 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006279#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306280#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6281 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6282 return 1;
6283 }
6284#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306285#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6286 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6287 return 1;
6288 }
6289#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006291}
6292
Gilles Peskine449bd832023-01-11 14:50:10 +01006293static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006294{
6295 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 psa_status_t status = psa_hash_setup(&operation, alg);
6297 psa_hash_abort(&operation);
6298 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006299}
6300
Gilles Peskine969c5d62019-01-16 15:53:06 +01006301static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006302 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006304{
Janos Follath5fe19732019-06-20 15:09:30 +01006305 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6306 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006307 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006308
Gilles Peskine969c5d62019-01-16 15:53:06 +01006309 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 if (!is_kdf_alg_supported(kdf_alg)) {
6311 return PSA_ERROR_NOT_SUPPORTED;
6312 }
John Durkop07cc04a2020-11-16 22:08:34 -08006313
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006314 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306315 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6317 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306318 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6319 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6320 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306321 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306322 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 if (hash_size == 0) {
6324 return PSA_ERROR_NOT_SUPPORTED;
6325 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006326
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006327 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6328 * we might fail later, which is somewhat unfriendly and potentially
6329 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 psa_status_t status = psa_hash_try_support(hash_alg);
6331 if (status != PSA_SUCCESS) {
6332 return status;
6333 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006334 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006335
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6337 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6338 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6339 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006340 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006341#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006342 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6344 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006345 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006347#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6348 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 operation->capacity = 255 * hash_size;
6350 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006351}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006352
Gilles Peskine449bd832023-01-11 14:50:10 +01006353static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006354{
6355#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 if (alg == PSA_ALG_ECDH) {
6357 return PSA_SUCCESS;
6358 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006359#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006360#if defined(PSA_WANT_ALG_FFDH)
6361 if (alg == PSA_ALG_FFDH) {
6362 return PSA_SUCCESS;
6363 }
6364#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006365 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006367}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006368
6369static int psa_key_derivation_allows_free_form_secret_input(
6370 psa_algorithm_t kdf_alg)
6371{
6372#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6373 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6374 return 0;
6375 }
6376#endif
6377 (void) kdf_alg;
6378 return 1;
6379}
John Durkop07cc04a2020-11-16 22:08:34 -08006380#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006381
Gilles Peskine449bd832023-01-11 14:50:10 +01006382psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6383 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006384{
6385 psa_status_t status;
6386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 if (operation->alg != 0) {
6388 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006389 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006390
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6392 return PSA_ERROR_INVALID_ARGUMENT;
6393 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6394#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6395 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6396 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6397 status = psa_key_agreement_try_support(ka_alg);
6398 if (status != PSA_SUCCESS) {
6399 return status;
6400 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006401 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6402 return PSA_ERROR_INVALID_ARGUMENT;
6403 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6405#else
6406 return PSA_ERROR_NOT_SUPPORTED;
6407#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6408 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6409#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6410 status = psa_key_derivation_setup_kdf(operation, alg);
6411#else
6412 return PSA_ERROR_NOT_SUPPORTED;
6413#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6414 } else {
6415 return PSA_ERROR_INVALID_ARGUMENT;
6416 }
6417
6418 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006419 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 }
6421 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006422}
6423
Przemek Stekiel69c46792022-06-10 12:59:51 +02006424#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006425static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6426 psa_algorithm_t kdf_alg,
6427 psa_key_derivation_step_t step,
6428 const uint8_t *data,
6429 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006430{
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006432 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006434 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006435#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6437 return PSA_ERROR_INVALID_ARGUMENT;
6438 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006439#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006440 if (hkdf->state != HKDF_STATE_INIT) {
6441 return PSA_ERROR_BAD_STATE;
6442 } else {
6443 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6444 hash_alg,
6445 data, data_length);
6446 if (status != PSA_SUCCESS) {
6447 return status;
6448 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006449 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006451 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006452 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006453#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006454 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006455 /* We shouldn't be in different state as HKDF_EXPAND only allows
6456 * two inputs: SECRET (this case) and INFO which does not modify
6457 * the state. It could happen only if the hkdf
6458 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006459 if (hkdf->state != HKDF_STATE_INIT) {
6460 return PSA_ERROR_BAD_STATE;
6461 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006462
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006463 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006464 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6465 return PSA_ERROR_INVALID_ARGUMENT;
6466 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006467
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 memcpy(hkdf->prk, data, data_length);
6469 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006470#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006471 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006472 /* HKDF: If no salt was provided, use an empty salt.
6473 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006475#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6477 return PSA_ERROR_BAD_STATE;
6478 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006479#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6481 hash_alg,
6482 NULL, 0);
6483 if (status != PSA_SUCCESS) {
6484 return status;
6485 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006486 hkdf->state = HKDF_STATE_STARTED;
6487 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 if (hkdf->state != HKDF_STATE_STARTED) {
6489 return PSA_ERROR_BAD_STATE;
6490 }
6491 status = psa_mac_update(&hkdf->hmac,
6492 data, data_length);
6493 if (status != PSA_SUCCESS) {
6494 return status;
6495 }
6496 status = psa_mac_sign_finish(&hkdf->hmac,
6497 hkdf->prk,
6498 sizeof(hkdf->prk),
6499 &data_length);
6500 if (status != PSA_SUCCESS) {
6501 return status;
6502 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006503 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006504
Gilles Peskine2b522db2019-04-12 15:11:49 +02006505 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006506 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006507#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006509 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006510 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006511 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006512 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006513#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006514 {
6515 /* Block 0 is empty, and the next block will be
6516 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006518 }
6519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006521 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006522#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6524 return PSA_ERROR_INVALID_ARGUMENT;
6525 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006526#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006527#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6529 hkdf->state == HKDF_STATE_INIT) {
6530 return PSA_ERROR_BAD_STATE;
6531 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006532#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 if (hkdf->state == HKDF_STATE_OUTPUT) {
6534 return PSA_ERROR_BAD_STATE;
6535 }
6536 if (hkdf->info_set) {
6537 return PSA_ERROR_BAD_STATE;
6538 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006539 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006540 if (data_length != 0) {
6541 hkdf->info = mbedtls_calloc(1, data_length);
6542 if (hkdf->info == NULL) {
6543 return PSA_ERROR_INSUFFICIENT_MEMORY;
6544 }
6545 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006546 }
6547 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006549 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006551 }
6552}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006553#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006554
John Durkop07cc04a2020-11-16 22:08:34 -08006555#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6556 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006557static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6558 const uint8_t *data,
6559 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006560{
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6562 return PSA_ERROR_BAD_STATE;
6563 }
Janos Follathf08e2652019-06-13 09:05:41 +01006564
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 if (data_length != 0) {
6566 prf->seed = mbedtls_calloc(1, data_length);
6567 if (prf->seed == NULL) {
6568 return PSA_ERROR_INSUFFICIENT_MEMORY;
6569 }
Janos Follathf08e2652019-06-13 09:05:41 +01006570
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006572 prf->seed_length = data_length;
6573 }
Janos Follathf08e2652019-06-13 09:05:41 +01006574
Gilles Peskine43f958b2020-12-13 14:55:14 +01006575 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006576
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006578}
6579
Gilles Peskine449bd832023-01-11 14:50:10 +01006580static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6581 const uint8_t *data,
6582 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006583{
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6585 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6586 return PSA_ERROR_BAD_STATE;
6587 }
Janos Follath81550542019-06-13 14:26:34 +01006588
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 if (data_length != 0) {
6590 prf->secret = mbedtls_calloc(1, data_length);
6591 if (prf->secret == NULL) {
6592 return PSA_ERROR_INSUFFICIENT_MEMORY;
6593 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006594
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006596 prf->secret_length = data_length;
6597 }
Janos Follath81550542019-06-13 14:26:34 +01006598
Gilles Peskine43f958b2020-12-13 14:55:14 +01006599 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006600
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006602}
6603
Gilles Peskine449bd832023-01-11 14:50:10 +01006604static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6605 const uint8_t *data,
6606 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006607{
Gilles Peskine449bd832023-01-11 14:50:10 +01006608 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6609 return PSA_ERROR_BAD_STATE;
6610 }
Janos Follath63028dd2019-06-13 09:15:47 +01006611
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 if (data_length != 0) {
6613 prf->label = mbedtls_calloc(1, data_length);
6614 if (prf->label == NULL) {
6615 return PSA_ERROR_INSUFFICIENT_MEMORY;
6616 }
Janos Follath63028dd2019-06-13 09:15:47 +01006617
Gilles Peskine449bd832023-01-11 14:50:10 +01006618 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006619 prf->label_length = data_length;
6620 }
Janos Follath63028dd2019-06-13 09:15:47 +01006621
Gilles Peskine43f958b2020-12-13 14:55:14 +01006622 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006623
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006625}
6626
Gilles Peskine449bd832023-01-11 14:50:10 +01006627static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6628 psa_key_derivation_step_t step,
6629 const uint8_t *data,
6630 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006631{
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006633 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006635 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006637 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006639 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006641 }
6642}
John Durkop07cc04a2020-11-16 22:08:34 -08006643#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6644 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6645
6646#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6647static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6648 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006649 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006650 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006651{
6652 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6654 4 + data_length + prf->other_secret_length :
6655 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006656
Gilles Peskine449bd832023-01-11 14:50:10 +01006657 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6658 return PSA_ERROR_INVALID_ARGUMENT;
6659 }
John Durkop07cc04a2020-11-16 22:08:34 -08006660
Gilles Peskine449bd832023-01-11 14:50:10 +01006661 uint8_t *pms = mbedtls_calloc(1, pms_len);
6662 if (pms == NULL) {
6663 return PSA_ERROR_INSUFFICIENT_MEMORY;
6664 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006665 uint8_t *cur = pms;
6666
6667 /* pure-PSK:
6668 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006669 *
6670 * The premaster secret is formed as follows: if the PSK is N octets
6671 * long, concatenate a uint16 with the value N, N zero octets, a second
6672 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006673 *
6674 * mixed-PSK:
6675 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6676 * follows: concatenate a uint16 with the length of the other secret,
6677 * the other secret itself, uint16 with the length of PSK, and the
6678 * PSK itself.
6679 * For details please check:
6680 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6681 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6682 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006683 */
6684
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6686 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6687 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6688 if (prf->other_secret_length != 0) {
6689 memcpy(cur, prf->other_secret, prf->other_secret_length);
6690 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006691 cur += prf->other_secret_length;
6692 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006693 } else {
6694 *cur++ = MBEDTLS_BYTE_1(data_length);
6695 *cur++ = MBEDTLS_BYTE_0(data_length);
6696 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006697 cur += data_length;
6698 }
6699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 *cur++ = MBEDTLS_BYTE_1(data_length);
6701 *cur++ = MBEDTLS_BYTE_0(data_length);
6702 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006703 cur += data_length;
6704
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006705 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006706
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006707 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006709}
Janos Follath6660f0e2019-06-17 08:44:03 +01006710
Przemek Stekiele47201b2022-04-19 13:53:28 +02006711static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6712 psa_tls12_prf_key_derivation_t *prf,
6713 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006714 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006715{
Gilles Peskine449bd832023-01-11 14:50:10 +01006716 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6717 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006718 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006719
6720 if (data_length != 0) {
6721 prf->other_secret = mbedtls_calloc(1, data_length);
6722 if (prf->other_secret == NULL) {
6723 return PSA_ERROR_INSUFFICIENT_MEMORY;
6724 }
6725
6726 memcpy(prf->other_secret, data, data_length);
6727 prf->other_secret_length = data_length;
6728 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006729 prf->other_secret_length = 0;
6730 }
6731
6732 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6733
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006735}
6736
Janos Follath6660f0e2019-06-17 08:44:03 +01006737static psa_status_t psa_tls12_prf_psk_to_ms_input(
6738 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006739 psa_key_derivation_step_t step,
6740 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006741 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006742{
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006744 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 return psa_tls12_prf_psk_to_ms_set_key(prf,
6746 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006747 break;
6748 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6750 data,
6751 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006752 break;
6753 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006755 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006756
Przemek Stekiele47201b2022-04-19 13:53:28 +02006757 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006758}
John Durkop07cc04a2020-11-16 22:08:34 -08006759#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006760
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006761#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6762static psa_status_t psa_tls12_ecjpake_to_pms_input(
6763 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006764 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006765 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006767{
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6769 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6770 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006771 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006772
6773 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 if (data[0] != 0x04) {
6775 return PSA_ERROR_INVALID_ARGUMENT;
6776 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006777
6778 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006780
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006782}
6783#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306784
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306785#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306786static psa_status_t psa_pbkdf2_set_input_cost(
6787 psa_pbkdf2_key_derivation_t *pbkdf2,
6788 psa_key_derivation_step_t step,
6789 uint64_t data)
6790{
6791 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6792 return PSA_ERROR_INVALID_ARGUMENT;
6793 }
6794
6795 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6796 return PSA_ERROR_BAD_STATE;
6797 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306798
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306799 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306800 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306801 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306802
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306803 if (data == 0) {
6804 return PSA_ERROR_INVALID_ARGUMENT;
6805 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306806
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306807 pbkdf2->input_cost = data;
6808 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6809
6810 return PSA_SUCCESS;
6811}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306812
6813static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6814 const uint8_t *data,
6815 size_t data_length)
6816{
Gilles Peskineead17662023-08-20 22:02:51 +02006817 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6818 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6819 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6820 /* Appending to existing salt. No state change. */
6821 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306822 return PSA_ERROR_BAD_STATE;
6823 }
6824
Gilles Peskineca57d782023-07-20 19:08:06 +02006825 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006826 /* Appending an empty string, nothing to do. */
6827 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306828 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306829
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306830 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6831 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306832 return PSA_ERROR_INSUFFICIENT_MEMORY;
6833 }
6834
Gilles Peskineead17662023-08-20 22:02:51 +02006835 if (pbkdf2->salt_length != 0) {
6836 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6837 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306838 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306839 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306840 mbedtls_free(pbkdf2->salt);
6841 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306842 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306843 return PSA_SUCCESS;
6844}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306845
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306846#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306847static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306848 const uint8_t *input,
6849 size_t input_len,
6850 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306851 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306852{
6853 psa_status_t status = PSA_SUCCESS;
6854 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6855 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306856 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306857 } else {
6858 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306859 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306860 }
6861 return status;
6862}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306863#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306864
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306865#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306866static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6867 size_t input_len,
6868 uint8_t *output,
6869 size_t *output_len)
6870{
6871 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306872 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306873 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306874 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306875 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6876 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6877 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306878 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306879 * mac_size as the driver function sets mac_output_length = mac_size
6880 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306881 status = psa_driver_wrapper_mac_compute(&attributes,
6882 zeros, sizeof(zeros),
6883 PSA_ALG_CMAC, input, input_len,
6884 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306885 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6886 128U,
6887 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306888 output_len);
6889 } else {
6890 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306891 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306892 }
6893 return status;
6894}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306895#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306896
6897static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306898 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306899 const uint8_t *data,
6900 size_t data_length)
6901{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306902 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306903 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6904 return PSA_ERROR_BAD_STATE;
6905 }
6906
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306907#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306908 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6909 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6910 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6911 pbkdf2->password,
6912 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306913 } else
6914#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6915#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6916 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306917 status = psa_pbkdf2_cmac_set_password(data, data_length,
6918 pbkdf2->password,
6919 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306920 } else
6921#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6922 {
6923 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306924 }
6925
6926 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6927
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306928 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306929}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306930
6931static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306932 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306933 psa_key_derivation_step_t step,
6934 const uint8_t *data,
6935 size_t data_length)
6936{
6937 switch (step) {
6938 case PSA_KEY_DERIVATION_INPUT_SALT:
6939 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6940 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306941 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306942 default:
6943 return PSA_ERROR_INVALID_ARGUMENT;
6944 }
6945}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306946#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306947
Gilles Peskineb8965192019-09-24 16:21:10 +02006948/** Check whether the given key type is acceptable for the given
6949 * input step of a key derivation.
6950 *
6951 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6952 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6953 * Both secret and non-secret inputs can alternatively have the type
6954 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6955 * that the input was passed as a buffer rather than via a key object.
6956 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006957static int psa_key_derivation_check_input_type(
6958 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006960{
Gilles Peskine449bd832023-01-11 14:50:10 +01006961 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006962 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 if (key_type == PSA_KEY_TYPE_DERIVE) {
6964 return PSA_SUCCESS;
6965 }
6966 if (key_type == PSA_KEY_TYPE_NONE) {
6967 return PSA_SUCCESS;
6968 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006969 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006970 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 if (key_type == PSA_KEY_TYPE_DERIVE) {
6972 return PSA_SUCCESS;
6973 }
6974 if (key_type == PSA_KEY_TYPE_NONE) {
6975 return PSA_SUCCESS;
6976 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006977 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006978 case PSA_KEY_DERIVATION_INPUT_LABEL:
6979 case PSA_KEY_DERIVATION_INPUT_SALT:
6980 case PSA_KEY_DERIVATION_INPUT_INFO:
6981 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6983 return PSA_SUCCESS;
6984 }
6985 if (key_type == PSA_KEY_TYPE_NONE) {
6986 return PSA_SUCCESS;
6987 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006988 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306989 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6990 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6991 return PSA_SUCCESS;
6992 }
6993 if (key_type == PSA_KEY_TYPE_DERIVE) {
6994 return PSA_SUCCESS;
6995 }
6996 if (key_type == PSA_KEY_TYPE_NONE) {
6997 return PSA_SUCCESS;
6998 }
6999 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007000 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007002}
7003
Janos Follathb80a94e2019-06-12 15:54:46 +01007004static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007005 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007006 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007007 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007008 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007010{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007011 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007012 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007013
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 status = psa_key_derivation_check_input_type(step, key_type);
7015 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007016 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007018
Przemek Stekiel69c46792022-06-10 12:59:51 +02007019#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007020 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7021 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7022 step, data, data_length);
7023 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007024#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007025#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7027 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7028 step, data, data_length);
7029 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007030#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7031#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7033 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7034 step, data, data_length);
7035 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007036#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007037#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007039 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7041 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007042#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307043#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307044 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307045 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7046 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307047 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307048#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007049 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007050 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007051 (void) data;
7052 (void) data_length;
7053 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007055 }
7056
Gilles Peskine224b0d62019-09-23 18:13:17 +02007057exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 if (status != PSA_SUCCESS) {
7059 psa_key_derivation_abort(operation);
7060 }
7061 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007062}
7063
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307064static psa_status_t psa_key_derivation_input_integer_internal(
7065 psa_key_derivation_operation_t *operation,
7066 psa_key_derivation_step_t step,
7067 uint64_t value)
7068{
7069 psa_status_t status;
7070 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7071
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307072#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307073 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307074 status = psa_pbkdf2_set_input_cost(
7075 &operation->ctx.pbkdf2, step, value);
7076 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307077#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307078 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307079 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307080 (void) value;
7081 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307082 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307083 }
7084
7085 if (status != PSA_SUCCESS) {
7086 psa_key_derivation_abort(operation);
7087 }
7088 return status;
7089}
7090
Janos Follath51f4a0f2019-06-14 11:35:55 +01007091psa_status_t psa_key_derivation_input_bytes(
7092 psa_key_derivation_operation_t *operation,
7093 psa_key_derivation_step_t step,
7094 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007096{
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 return psa_key_derivation_input_internal(operation, step,
7098 PSA_KEY_TYPE_NONE,
7099 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007100}
7101
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307102psa_status_t psa_key_derivation_input_integer(
7103 psa_key_derivation_operation_t *operation,
7104 psa_key_derivation_step_t step,
7105 uint64_t value)
7106{
7107 return psa_key_derivation_input_integer_internal(operation, step, value);
7108}
7109
Janos Follath51f4a0f2019-06-14 11:35:55 +01007110psa_status_t psa_key_derivation_input_key(
7111 psa_key_derivation_operation_t *operation,
7112 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007113 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007114{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007115 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007116 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007117 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007118
Ronald Cron5c522922020-11-14 16:35:34 +01007119 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7121 if (status != PSA_SUCCESS) {
7122 psa_key_derivation_abort(operation);
7123 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007124 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007125
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307126 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7127 * permission to output to a key object. */
7128 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7129 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007130 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007132
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 status = psa_key_derivation_input_internal(operation,
7134 step, slot->attr.type,
7135 slot->key.data,
7136 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007137
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007139
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007141}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007142
7143
7144
7145/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007146/* Key agreement */
7147/****************************************************************/
7148
Gilles Peskine449bd832023-01-11 14:50:10 +01007149psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7150 const uint8_t *key_buffer,
7151 size_t key_buffer_size,
7152 psa_algorithm_t alg,
7153 const uint8_t *peer_key,
7154 size_t peer_key_length,
7155 uint8_t *shared_secret,
7156 size_t shared_secret_size,
7157 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007158{
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007160#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007161 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7163 key_buffer_size, alg,
7164 peer_key, peer_key_length,
7165 shared_secret,
7166 shared_secret_size,
7167 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007168#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007169
7170#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7171 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007172 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007173 peer_key,
7174 peer_key_length,
7175 key_buffer,
7176 key_buffer_size,
7177 shared_secret,
7178 shared_secret_size,
7179 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007180#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7181
Gilles Peskine01d718c2018-09-18 12:01:02 +02007182 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007183 (void) attributes;
7184 (void) key_buffer;
7185 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007186 (void) peer_key;
7187 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007188 (void) shared_secret;
7189 (void) shared_secret_size;
7190 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007192 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007193}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007194
Aditya Deshpande17845b82022-10-13 17:21:01 +01007195/** Internal function for raw key agreement
7196 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007197 * to the driver's implementation if a driver is present.
7198 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007199 * (psa_key_agreement_raw_builtin).
7200 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007201static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7202 psa_key_slot_t *private_key,
7203 const uint8_t *peer_key,
7204 size_t peer_key_length,
7205 uint8_t *shared_secret,
7206 size_t shared_secret_size,
7207 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007208{
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7210 return PSA_ERROR_NOT_SUPPORTED;
7211 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007212
7213 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007215 };
7216
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 return psa_driver_wrapper_key_agreement(&attributes,
7218 private_key->key.data,
7219 private_key->key.bytes, alg,
7220 peer_key, peer_key_length,
7221 shared_secret,
7222 shared_secret_size,
7223 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007224}
7225
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007226/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007227 * to potentially free embedded data structures and wipe confidential data.
7228 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007229static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7230 psa_key_derivation_step_t step,
7231 psa_key_slot_t *private_key,
7232 const uint8_t *peer_key,
7233 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007234{
7235 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007236 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007237 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007238 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007239
7240 /* Step 1: run the secret agreement algorithm to generate the shared
7241 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007242 status = psa_key_agreement_raw_internal(ka_alg,
7243 private_key,
7244 peer_key, peer_key_length,
7245 shared_secret,
7246 sizeof(shared_secret),
7247 &shared_secret_length);
7248 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007249 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007250 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007251
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007252 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007253 * the shared secret. A shared secret is permitted wherever a key
7254 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 status = psa_key_derivation_input_internal(operation, step,
7256 PSA_KEY_TYPE_DERIVE,
7257 shared_secret,
7258 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007259exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7261 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007262}
7263
Gilles Peskine449bd832023-01-11 14:50:10 +01007264psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7265 psa_key_derivation_step_t step,
7266 mbedtls_svc_key_id_t private_key,
7267 const uint8_t *peer_key,
7268 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007269{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007270 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007271 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007272 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007273
Gilles Peskine449bd832023-01-11 14:50:10 +01007274 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7275 return PSA_ERROR_INVALID_ARGUMENT;
7276 }
Ronald Cron5c522922020-11-14 16:35:34 +01007277 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7279 if (status != PSA_SUCCESS) {
7280 return status;
7281 }
7282 status = psa_key_agreement_internal(operation, step,
7283 slot,
7284 peer_key, peer_key_length);
7285 if (status != PSA_SUCCESS) {
7286 psa_key_derivation_abort(operation);
7287 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007288 /* If a private key has been added as SECRET, we allow the derived
7289 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007291 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007292 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007293 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007294
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007296
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007298}
7299
Gilles Peskine449bd832023-01-11 14:50:10 +01007300psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7301 mbedtls_svc_key_id_t private_key,
7302 const uint8_t *peer_key,
7303 size_t peer_key_length,
7304 uint8_t *output,
7305 size_t output_size,
7306 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007307{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007308 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007309 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007310 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007311 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007312
Gilles Peskine449bd832023-01-11 14:50:10 +01007313 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007314 status = PSA_ERROR_INVALID_ARGUMENT;
7315 goto exit;
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, alg);
7319 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007320 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007321 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007322
Gilles Peskine3e561302022-04-14 00:17:15 +02007323 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7324 * for the output size. The PSA specification only guarantees that this
7325 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7326 * but it might be nice to allow smaller buffers if the output fits.
7327 * At the time of writing this comment, with only ECDH implemented,
7328 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7329 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7330 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007331 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007332 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7333 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007334 status = PSA_ERROR_BUFFER_TOO_SMALL;
7335 goto exit;
7336 }
7337
Gilles Peskine449bd832023-01-11 14:50:10 +01007338 status = psa_key_agreement_raw_internal(alg, slot,
7339 peer_key, peer_key_length,
7340 output, output_size,
7341 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007342
7343exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007345 /* If an error happens and is not handled properly, the output
7346 * may be used as a key to protect sensitive data. Arrange for such
7347 * a key to be random, which is likely to result in decryption or
7348 * verification errors. This is better than filling the buffer with
7349 * some constant data such as zeros, which would result in the data
7350 * being protected with a reproducible, easily knowable key.
7351 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007353 *output_length = output_size;
7354 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007355
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007357
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007359}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007360
7361
Gilles Peskine30524eb2020-11-13 17:02:26 +01007362
Gilles Peskine86a440b2018-11-12 18:39:40 +01007363/****************************************************************/
7364/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007365/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007366
Gilles Peskine672a7712023-04-28 21:00:28 +02007367#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7368#include "entropy_poll.h"
7369#endif
7370
Gilles Peskine30524eb2020-11-13 17:02:26 +01007371/** Initialize the PSA random generator.
7372 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007373static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007374{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007375#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007377#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7378
Gilles Peskine30524eb2020-11-13 17:02:26 +01007379 /* Set default configuration if
7380 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007382 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007383 }
7384 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007385 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007387
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007389#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7390 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7391 /* The PSA entropy injection feature depends on using NV seed as an entropy
7392 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 mbedtls_entropy_add_source(&rng->entropy,
7394 mbedtls_nv_seed_poll, NULL,
7395 MBEDTLS_ENTROPY_BLOCK_SIZE,
7396 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007397#endif
7398
Gilles Peskine449bd832023-01-11 14:50:10 +01007399 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007400#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007401}
7402
7403/** Deinitialize the PSA random generator.
7404 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007405static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007406{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007407#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007409#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7411 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007412#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007413}
7414
7415/** Seed the PSA random generator.
7416 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007417static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007418{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007419#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7420 /* Do nothing: the external RNG seeds itself. */
7421 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007423#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007424 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7426 drbg_seed, sizeof(drbg_seed) - 1);
7427 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007428#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007429}
7430
Gilles Peskine449bd832023-01-11 14:50:10 +01007431psa_status_t psa_generate_random(uint8_t *output,
7432 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007433{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007434 GUARD_MODULE_INITIALIZED;
7435
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007436#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7437
7438 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7440 output, output_size,
7441 &output_length);
7442 if (status != PSA_SUCCESS) {
7443 return status;
7444 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007445 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007446 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 if (output_length != output_size) {
7448 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7449 }
7450 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007451
7452#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7453
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007455 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7457 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7458 output_size);
7459 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7460 output, request_size);
7461 if (ret != 0) {
7462 return mbedtls_to_psa_error(ret);
7463 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007464 output_size -= request_size;
7465 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007466 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007468#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007469}
7470
Gilles Peskine8814fc42020-12-14 15:33:44 +01007471/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007472 *
7473 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7474 * `psa_generate_random(...)`. The state parameter is ignored since the
7475 * PSA API doesn't support passing an explicit state.
7476 *
7477 * In the non-external case, psa_generate_random() calls an
7478 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7479 * and semantics as mbedtls_psa_get_random(). As an optimization,
7480 * instead of doing this back-and-forth between the PSA API and the
7481 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7482 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007483 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007484#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7485int mbedtls_psa_get_random(void *p_rng,
7486 unsigned char *output,
7487 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007488{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007489 /* This function takes a pointer to the RNG state because that's what
7490 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7491 * its own state internally and doesn't let the caller access that state.
7492 * So we just ignore the state parameter, and in practice we'll pass
7493 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007494 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007495 psa_status_t status = psa_generate_random(output, output_size);
7496 if (status == PSA_SUCCESS) {
7497 return 0;
7498 } else {
7499 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7500 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007501}
7502#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7503
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007504#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007505psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7506 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007507{
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 if (global_data.initialized) {
7509 return PSA_ERROR_NOT_PERMITTED;
7510 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007511
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7513 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7514 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7515 return PSA_ERROR_INVALID_ARGUMENT;
7516 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007517
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007519}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007520#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007521
Ronald Cron3772afe2021-02-08 16:10:05 +01007522/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007523 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007524 * \param type The key type
7525 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007526 *
7527 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007528 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007529 * \retval #PSA_ERROR_INVALID_ARGUMENT
7530 * The size in bits of the key is not valid.
7531 * \retval #PSA_ERROR_NOT_SUPPORTED
7532 * The type and/or the size in bits of the key or the combination of
7533 * the two is not supported.
7534 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007535static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007537{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007538 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007539
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 if (key_type_is_raw_bytes(type)) {
7541 status = psa_validate_unstructured_key_bit_size(type, bits);
7542 if (status != PSA_SUCCESS) {
7543 return status;
7544 }
7545 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007546#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7548 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7549 return PSA_ERROR_NOT_SUPPORTED;
7550 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007551 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007552 return PSA_ERROR_NOT_SUPPORTED;
7553 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007554
Ronald Cron01b2aba2020-10-05 09:42:02 +02007555 /* Accept only byte-aligned keys, for the same reasons as
7556 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 if (bits % 8 != 0) {
7558 return PSA_ERROR_NOT_SUPPORTED;
7559 }
7560 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007561#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007562
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007563#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007565 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 return PSA_SUCCESS;
7567 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007568#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007569
Valerio Settia55f0422023-07-10 15:34:41 +02007570#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007571 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007572 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007573 return PSA_ERROR_NOT_SUPPORTED;
7574 }
7575 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007576#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007577 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007579 }
7580
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007582}
7583
Ronald Cron55ed0592020-10-05 10:30:40 +02007584psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007585 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007587{
7588 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007589 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007590
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 if ((attributes->domain_parameters == NULL) &&
7592 (attributes->domain_parameters_size != 0)) {
7593 return PSA_ERROR_INVALID_ARGUMENT;
7594 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007595
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 if (key_type_is_raw_bytes(type)) {
7597 status = psa_generate_random(key_buffer, key_buffer_size);
7598 if (status != PSA_SUCCESS) {
7599 return status;
7600 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007601
David Brown12ca5032021-02-11 11:02:00 -07007602#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 if (type == PSA_KEY_TYPE_DES) {
7604 psa_des_set_key_parity(key_buffer, key_buffer_size);
7605 }
David Brown8107e312021-02-12 08:08:46 -07007606#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007608
Valerio Setti76df8c12023-07-11 14:11:28 +02007609#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7611 return mbedtls_psa_rsa_generate_key(attributes,
7612 key_buffer,
7613 key_buffer_size,
7614 key_buffer_length);
7615 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007616#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007617
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007618#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7620 return mbedtls_psa_ecp_generate_key(attributes,
7621 key_buffer,
7622 key_buffer_size,
7623 key_buffer_length);
7624 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007625#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007626
Valerio Settia55f0422023-07-10 15:34:41 +02007627#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007628 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7629 return mbedtls_psa_ffdh_generate_key(attributes,
7630 key_buffer,
7631 key_buffer_size,
7632 key_buffer_length);
7633 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007634#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007635 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 (void) key_buffer_length;
7637 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007638 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007639
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007641}
Darryl Green0c6575a2018-11-07 16:05:30 +00007642
Gilles Peskine449bd832023-01-11 14:50:10 +01007643psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7644 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007645{
7646 psa_status_t status;
7647 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007648 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007649 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007650
Ronald Cron81709fc2020-11-14 12:10:32 +01007651 *key = MBEDTLS_SVC_KEY_ID_INIT;
7652
Gilles Peskine0f84d622019-09-12 19:03:13 +02007653 /* Reject any attempt to create a zero-length key so that we don't
7654 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 if (psa_get_key_bits(attributes) == 0) {
7656 return PSA_ERROR_INVALID_ARGUMENT;
7657 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007658
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007659 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7661 return PSA_ERROR_INVALID_ARGUMENT;
7662 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007663
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7665 &slot, &driver);
7666 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007667 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 }
Gilles Peskine11792082019-08-06 18:36:36 +02007669
Ronald Cron977c2472020-10-13 08:32:21 +02007670 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307671 * storage ( thus not in the case of generating a key in a secure element
7672 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7673 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 if (slot->key.data == NULL) {
7675 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7676 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007677 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 attributes->core.type, attributes->core.bits);
7679 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007680 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007681 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007682
7683 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 attributes->core.type,
7685 attributes->core.bits);
7686 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007687 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 attributes, &key_buffer_size);
7689 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007690 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 }
Ronald Cron977c2472020-10-13 08:32:21 +02007692 }
Ronald Cron977c2472020-10-13 08:32:21 +02007693
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7695 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007696 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 }
Ronald Cron977c2472020-10-13 08:32:21 +02007698 }
7699
Gilles Peskine449bd832023-01-11 14:50:10 +01007700 status = psa_driver_wrapper_generate_key(attributes,
7701 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007702
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 if (status != PSA_SUCCESS) {
7704 psa_remove_key_data_from_memory(slot);
7705 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007706
Gilles Peskine11792082019-08-06 18:36:36 +02007707exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007708 if (status == PSA_SUCCESS) {
7709 status = psa_finish_key_creation(slot, driver, key);
7710 }
7711 if (status != PSA_SUCCESS) {
7712 psa_fail_key_creation(slot, driver);
7713 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007714
Gilles Peskine449bd832023-01-11 14:50:10 +01007715 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007716}
7717
Gilles Peskinee59236f2018-01-27 23:32:46 +01007718/****************************************************************/
7719/* Module setup */
7720/****************************************************************/
7721
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007722#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007723psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 void (* entropy_init)(mbedtls_entropy_context *ctx),
7725 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007726{
Gilles Peskine449bd832023-01-11 14:50:10 +01007727 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7728 return PSA_ERROR_BAD_STATE;
7729 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007730 global_data.rng.entropy_init = entropy_init;
7731 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007732 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007733}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007734#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007735
Gilles Peskine449bd832023-01-11 14:50:10 +01007736void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007737{
Gilles Peskine449bd832023-01-11 14:50:10 +01007738 psa_wipe_all_key_slots();
7739 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7740 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007741 }
7742 /* Wipe all remaining data, including configuration.
7743 * In particular, this sets all state indicator to the value
7744 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007746
7747 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007748 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007749}
7750
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007751#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7752/** Recover a transaction that was interrupted by a power failure.
7753 *
7754 * This function is called during initialization, before psa_crypto_init()
7755 * returns. If this function returns a failure status, the initialization
7756 * fails.
7757 */
7758static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007759 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007760{
Gilles Peskine449bd832023-01-11 14:50:10 +01007761 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007762 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7763 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 /* TODO - fall through to the failure case until this
7765 * is implemented.
7766 * https://github.com/ARMmbed/mbed-crypto/issues/218
7767 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007768 default:
7769 /* We found an unsupported transaction in the storage.
7770 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007772 }
7773}
7774#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7775
Gilles Peskine449bd832023-01-11 14:50:10 +01007776psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007777{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007778 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007779
Gilles Peskinec6b69072018-11-20 21:42:52 +01007780 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 if (global_data.initialized != 0) {
7782 return PSA_SUCCESS;
7783 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007784
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007785 /* Init drivers */
7786 status = psa_driver_wrapper_init();
7787 if (status != PSA_SUCCESS) {
7788 goto exit;
7789 }
7790 global_data.drivers_initialized = 1;
7791
Gilles Peskine30524eb2020-11-13 17:02:26 +01007792 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007794 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007795 status = mbedtls_psa_random_seed(&global_data.rng);
7796 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007797 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007799 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007800
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 status = psa_initialize_key_slots();
7802 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01007803 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007805
Gilles Peskine4b734222019-07-24 15:56:31 +02007806#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007807 status = psa_crypto_load_transaction();
7808 if (status == PSA_SUCCESS) {
7809 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7810 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007811 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007812 }
7813 status = psa_crypto_stop_transaction();
7814 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007815 /* There's no transaction to complete. It's all good. */
7816 status = PSA_SUCCESS;
7817 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007818#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007819
Gilles Peskinec6b69072018-11-20 21:42:52 +01007820 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007821 global_data.initialized = 1;
7822
7823exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007824 if (status != PSA_SUCCESS) {
7825 mbedtls_psa_crypto_free();
7826 }
7827 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007828}
7829
Yanray Wangffc3c482023-07-11 12:01:04 +08007830#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007831psa_status_t psa_crypto_driver_pake_get_password_len(
7832 const psa_crypto_driver_pake_inputs_t *inputs,
7833 size_t *password_len)
7834{
7835 if (inputs->password_len == 0) {
7836 return PSA_ERROR_BAD_STATE;
7837 }
7838
7839 *password_len = inputs->password_len;
7840
7841 return PSA_SUCCESS;
7842}
7843
7844psa_status_t psa_crypto_driver_pake_get_password(
7845 const psa_crypto_driver_pake_inputs_t *inputs,
7846 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7847{
7848 if (inputs->password_len == 0) {
7849 return PSA_ERROR_BAD_STATE;
7850 }
7851
7852 if (buffer_size < inputs->password_len) {
7853 return PSA_ERROR_BUFFER_TOO_SMALL;
7854 }
7855
7856 memcpy(buffer, inputs->password, inputs->password_len);
7857 *buffer_length = inputs->password_len;
7858
7859 return PSA_SUCCESS;
7860}
7861
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007862psa_status_t psa_crypto_driver_pake_get_user_len(
7863 const psa_crypto_driver_pake_inputs_t *inputs,
7864 size_t *user_len)
7865{
7866 if (inputs->user_len == 0) {
7867 return PSA_ERROR_BAD_STATE;
7868 }
7869
7870 *user_len = inputs->user_len;
7871
7872 return PSA_SUCCESS;
7873}
7874
7875psa_status_t psa_crypto_driver_pake_get_user(
7876 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007877 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007878{
7879 if (inputs->user_len == 0) {
7880 return PSA_ERROR_BAD_STATE;
7881 }
7882
Przemek Stekielc0e62502023-03-14 11:49:36 +01007883 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007884 return PSA_ERROR_BUFFER_TOO_SMALL;
7885 }
7886
Przemek Stekielc0e62502023-03-14 11:49:36 +01007887 memcpy(user_id, inputs->user, inputs->user_len);
7888 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007889
7890 return PSA_SUCCESS;
7891}
7892
7893psa_status_t psa_crypto_driver_pake_get_peer_len(
7894 const psa_crypto_driver_pake_inputs_t *inputs,
7895 size_t *peer_len)
7896{
7897 if (inputs->peer_len == 0) {
7898 return PSA_ERROR_BAD_STATE;
7899 }
7900
7901 *peer_len = inputs->peer_len;
7902
7903 return PSA_SUCCESS;
7904}
7905
7906psa_status_t psa_crypto_driver_pake_get_peer(
7907 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007908 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007909{
7910 if (inputs->peer_len == 0) {
7911 return PSA_ERROR_BAD_STATE;
7912 }
7913
Przemek Stekielc0e62502023-03-14 11:49:36 +01007914 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007915 return PSA_ERROR_BUFFER_TOO_SMALL;
7916 }
7917
Przemek Stekielc0e62502023-03-14 11:49:36 +01007918 memcpy(peer_id, inputs->peer, inputs->peer_len);
7919 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007920
7921 return PSA_SUCCESS;
7922}
7923
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007924psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7925 const psa_crypto_driver_pake_inputs_t *inputs,
7926 psa_pake_cipher_suite_t *cipher_suite)
7927{
7928 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7929 return PSA_ERROR_BAD_STATE;
7930 }
7931
7932 *cipher_suite = inputs->cipher_suite;
7933
7934 return PSA_SUCCESS;
7935}
7936
Neil Armstronga7d08c32022-06-01 18:21:20 +02007937psa_status_t psa_pake_setup(
7938 psa_pake_operation_t *operation,
7939 const psa_pake_cipher_suite_t *cipher_suite)
7940{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007941 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007942
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007943 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007944 status = PSA_ERROR_BAD_STATE;
7945 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007946 }
7947
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007948 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007949 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007950 status = PSA_ERROR_INVALID_ARGUMENT;
7951 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007952 }
7953
Przemek Stekiel51eac532022-12-07 11:04:51 +01007954 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7955
Przemek Stekiele12ed362022-12-21 12:54:46 +01007956 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007957 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7958 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007959 operation->data.inputs.cipher_suite = *cipher_suite;
7960
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007961#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007962 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007963 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007964 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007965
David Horstmann16f01512023-06-14 17:21:07 +01007966 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007967 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007968 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007969#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007970 {
7971 status = PSA_ERROR_NOT_SUPPORTED;
7972 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007973 }
7974
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007975 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7976
Przemek Stekiel51eac532022-12-07 11:04:51 +01007977 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007978exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007979 psa_pake_abort(operation);
7980 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007981}
7982
7983psa_status_t psa_pake_set_password_key(
7984 psa_pake_operation_t *operation,
7985 mbedtls_svc_key_id_t password)
7986{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007987 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007988 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7989 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007990 psa_key_attributes_t attributes;
7991 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007992
Przemek Stekiel51eac532022-12-07 11:04:51 +01007993 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007994 status = PSA_ERROR_BAD_STATE;
7995 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007996 }
7997
Przemek Stekiel6c764412022-11-22 14:05:12 +01007998 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7999 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008000 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008001 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008002 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008003 }
8004
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008005 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008006 .core = slot->attr
8007 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008008
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008009 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008010
Przemek Stekiel51eac532022-12-07 11:04:51 +01008011 if (type != PSA_KEY_TYPE_PASSWORD &&
8012 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8013 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008014 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008015 }
8016
Przemek Stekiel51eac532022-12-07 11:04:51 +01008017 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8018 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008019 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008020 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008021 }
8022
8023 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8024 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008025 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008026exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008027 if (status != PSA_SUCCESS) {
8028 psa_pake_abort(operation);
8029 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008030 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008031 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008032}
8033
8034psa_status_t psa_pake_set_user(
8035 psa_pake_operation_t *operation,
8036 const uint8_t *user_id,
8037 size_t user_id_len)
8038{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008039 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008040
8041 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008042 status = PSA_ERROR_BAD_STATE;
8043 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008044 }
8045
Przemek Stekiel51eac532022-12-07 11:04:51 +01008046 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008047 status = PSA_ERROR_INVALID_ARGUMENT;
8048 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008049 }
8050
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008051 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008052 status = PSA_ERROR_BAD_STATE;
8053 goto exit;
8054 }
8055
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008056 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8057 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008058 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8059 goto exit;
8060 }
8061
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008062 memcpy(operation->data.inputs.user, user_id, user_id_len);
8063 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008064
8065 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008066exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008067 psa_pake_abort(operation);
8068 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008069}
8070
8071psa_status_t psa_pake_set_peer(
8072 psa_pake_operation_t *operation,
8073 const uint8_t *peer_id,
8074 size_t peer_id_len)
8075{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008076 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008077
8078 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008079 status = PSA_ERROR_BAD_STATE;
8080 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008081 }
8082
Przemek Stekiel51eac532022-12-07 11:04:51 +01008083 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008084 status = PSA_ERROR_INVALID_ARGUMENT;
8085 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008086 }
8087
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008088 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008089 status = PSA_ERROR_BAD_STATE;
8090 goto exit;
8091 }
8092
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008093 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8094 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008095 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8096 goto exit;
8097 }
8098
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008099 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8100 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008101
8102 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008103exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008104 psa_pake_abort(operation);
8105 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008106}
8107
8108psa_status_t psa_pake_set_role(
8109 psa_pake_operation_t *operation,
8110 psa_pake_role_t role)
8111{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008112 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008113
Przemek Stekiel51eac532022-12-07 11:04:51 +01008114 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008115 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008116 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008117 }
8118
Przemek Stekiel09104b82023-03-06 14:11:51 +01008119 switch (operation->alg) {
8120#if defined(PSA_WANT_ALG_JPAKE)
8121 case PSA_ALG_JPAKE:
8122 if (role == PSA_PAKE_ROLE_NONE) {
8123 return PSA_SUCCESS;
8124 }
8125 status = PSA_ERROR_INVALID_ARGUMENT;
8126 break;
8127#endif
8128 default:
8129 (void) role;
8130 status = PSA_ERROR_NOT_SUPPORTED;
8131 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008132 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008133exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008134 psa_pake_abort(operation);
8135 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008136}
8137
David Horstmanne7f21e62023-05-12 18:17:21 +01008138/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008139#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008140static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008141 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008142{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008143 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008144 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008145 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008146
David Horstmann024e5c52023-06-14 15:48:21 +01008147 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008148 is_x1 = (stage->outputs < 1);
8149 } else {
8150 is_x1 = (stage->inputs < 1);
8151 }
8152
David Horstmann74a3d8c2023-06-14 18:28:19 +01008153 key_share_step = is_x1 ?
8154 PSA_JPAKE_X1_STEP_KEY_SHARE :
8155 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008156 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008157 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8158 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8159 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8160 } else {
8161 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008162 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008163 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008164}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008165#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008166
Przemek Stekiel2797d372022-12-22 11:19:22 +01008167static psa_status_t psa_pake_complete_inputs(
8168 psa_pake_operation_t *operation)
8169{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008170 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008171 /* Create copy of the inputs on stack as inputs share memory
8172 with the driver context which will be setup by the driver. */
8173 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008174
Przemek Stekielfde11282023-03-13 16:06:09 +01008175 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008176 return PSA_ERROR_BAD_STATE;
8177 }
8178
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008179 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008180 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8181 return PSA_ERROR_BAD_STATE;
8182 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008183 }
8184
Przemek Stekiel18620a32023-01-17 16:34:52 +01008185 /* Clear driver context */
8186 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8187
8188 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008189
8190 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008191 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008192
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008193 /* User and peer are translated to role. */
8194 mbedtls_free(inputs.user);
8195 mbedtls_free(inputs.peer);
8196
Przemek Stekiel2797d372022-12-22 11:19:22 +01008197 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008198#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008199 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008200 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008201 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008202#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008203 {
8204 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008205 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008206 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008207 return status;
8208}
8209
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008210#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008211static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008212 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008213 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008214 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008215{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008216 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8217 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8218 step != PSA_PAKE_STEP_ZK_PROOF) {
8219 return PSA_ERROR_INVALID_ARGUMENT;
8220 }
8221
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008222 psa_jpake_computation_stage_t *computation_stage =
8223 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008224
David Horstmann5da95602023-06-08 15:37:12 +01008225 if (computation_stage->round != PSA_JPAKE_FIRST &&
8226 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008227 return PSA_ERROR_BAD_STATE;
8228 }
8229
David Horstmanne7f21e62023-05-12 18:17:21 +01008230 /* Check that the step we are given is the one we were expecting */
8231 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008232 return PSA_ERROR_BAD_STATE;
8233 }
8234
David Horstmanne7f21e62023-05-12 18:17:21 +01008235 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8236 computation_stage->inputs == 0 &&
8237 computation_stage->outputs == 0) {
8238 /* Start of the round, so function decides whether we are inputting
8239 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008240 computation_stage->io_mode = io_mode;
8241 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008242 /* Middle of the round so the mode we are in must match the function
8243 * called by the user */
8244 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008245 }
8246
8247 return PSA_SUCCESS;
8248}
8249
David Horstmanne7f21e62023-05-12 18:17:21 +01008250static psa_status_t psa_jpake_epilogue(
8251 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008252 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008253{
David Horstmanne7f21e62023-05-12 18:17:21 +01008254 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008255 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008256
David Horstmanne7f21e62023-05-12 18:17:21 +01008257 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8258 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008259 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008260 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008261 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008262 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008263 }
8264 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008265 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008266 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008267 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008268 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008269 }
8270 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008271 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8272 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008273 /* End of a round, move to the next round */
8274 stage->inputs = 0;
8275 stage->outputs = 0;
8276 stage->round++;
8277 }
8278 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008279 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008280 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008281 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008282 return PSA_SUCCESS;
8283}
David Horstmanne7f21e62023-05-12 18:17:21 +01008284
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008285#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008286
Neil Armstronga7d08c32022-06-01 18:21:20 +02008287psa_status_t psa_pake_output(
8288 psa_pake_operation_t *operation,
8289 psa_pake_step_t step,
8290 uint8_t *output,
8291 size_t output_size,
8292 size_t *output_length)
8293{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008294 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008295 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008296 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008297
8298 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008299 status = psa_pake_complete_inputs(operation);
8300 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008301 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008302 }
8303 }
8304
8305 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008306 status = PSA_ERROR_BAD_STATE;
8307 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008308 }
8309
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008310 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008311 status = PSA_ERROR_INVALID_ARGUMENT;
8312 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008313 }
8314
Przemek Stekiele12ed362022-12-21 12:54:46 +01008315 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008316#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008317 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008318 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008319 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008320 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008321 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008322 driver_step = convert_jpake_computation_stage_to_driver_step(
8323 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008324 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008325#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008326 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008327 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008328 status = PSA_ERROR_NOT_SUPPORTED;
8329 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008330 }
8331
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008332 status = psa_driver_wrapper_pake_output(operation, driver_step,
8333 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008334
8335 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008336 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008337 }
8338
8339 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008340#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008341 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008342 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008343 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008344 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008345 }
8346 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008347#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008348 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008349 status = PSA_ERROR_NOT_SUPPORTED;
8350 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008351 }
8352
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008353 return PSA_SUCCESS;
8354exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008355 psa_pake_abort(operation);
8356 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008357}
8358
8359psa_status_t psa_pake_input(
8360 psa_pake_operation_t *operation,
8361 psa_pake_step_t step,
8362 const uint8_t *input,
8363 size_t input_length)
8364{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008365 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008366 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008367 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8368 operation->primitive,
8369 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008370
8371 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008372 status = psa_pake_complete_inputs(operation);
8373 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008374 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008375 }
8376 }
8377
8378 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008379 status = PSA_ERROR_BAD_STATE;
8380 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008381 }
8382
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008383 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008384 status = PSA_ERROR_INVALID_ARGUMENT;
8385 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008386 }
8387
Przemek Stekiele12ed362022-12-21 12:54:46 +01008388 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008389#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008390 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008391 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008392 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008393 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008394 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008395 driver_step = convert_jpake_computation_stage_to_driver_step(
8396 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008397 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008398#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008399 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008400 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008401 status = PSA_ERROR_NOT_SUPPORTED;
8402 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008403 }
8404
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008405 status = psa_driver_wrapper_pake_input(operation, driver_step,
8406 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008407
8408 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008409 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008410 }
8411
8412 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008413#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008414 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008415 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008416 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008417 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008418 }
8419 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008420#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008421 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008422 status = PSA_ERROR_NOT_SUPPORTED;
8423 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008424 }
8425
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008426 return PSA_SUCCESS;
8427exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008428 psa_pake_abort(operation);
8429 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008430}
8431
8432psa_status_t psa_pake_get_implicit_key(
8433 psa_pake_operation_t *operation,
8434 psa_key_derivation_operation_t *output)
8435{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008436 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008437 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008438 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008439 size_t shared_key_len = 0;
8440
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008441 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008442 status = PSA_ERROR_BAD_STATE;
8443 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008444 }
8445
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008446#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008447 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008448 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008449 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008450 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008451 status = PSA_ERROR_BAD_STATE;
8452 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008453 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008454 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008455#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008456 {
8457 status = PSA_ERROR_NOT_SUPPORTED;
8458 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008459 }
8460
Przemek Stekiel0c781802022-11-29 14:53:13 +01008461 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8462 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008463 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008464 &shared_key_len);
8465
8466 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008467 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008468 }
8469
8470 status = psa_key_derivation_input_bytes(output,
8471 PSA_KEY_DERIVATION_INPUT_SECRET,
8472 shared_key,
8473 shared_key_len);
8474
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008475 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008476exit:
8477 abort_status = psa_pake_abort(operation);
8478 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008479}
8480
8481psa_status_t psa_pake_abort(
8482 psa_pake_operation_t *operation)
8483{
Przemek Stekield69dca92023-01-31 19:59:20 +01008484 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008485
Przemek Stekield69dca92023-01-31 19:59:20 +01008486 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008487 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008488 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008489
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008490 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8491 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008492 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008493 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008494 }
8495 if (operation->data.inputs.user != NULL) {
8496 mbedtls_free(operation->data.inputs.user);
8497 }
8498 if (operation->data.inputs.peer != NULL) {
8499 mbedtls_free(operation->data.inputs.peer);
8500 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008501 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008502 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008503
Przemek Stekield69dca92023-01-31 19:59:20 +01008504 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008505}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008506#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008507
David Horstmann00d7a042023-12-07 18:39:17 +00008508/* Memory copying test hooks. These are called before input copy, after input
8509 * copy, before output copy and after output copy, respectively.
8510 * They are used by memory-poisoning tests to temporarily unpoison buffers
8511 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008512#if defined(MBEDTLS_TEST_HOOKS)
8513void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8514void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8515void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8516void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8517#endif
David Horstmannfde97392023-10-30 20:29:43 +00008518
David Horstmann1b7279a2023-11-15 15:18:30 +00008519/** Copy from an input buffer to a local copy.
8520 *
8521 * \param[in] input Pointer to input buffer.
8522 * \param[in] input_len Length of the input buffer.
8523 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8524 * \param[out] input_copy_len Length of the local copy buffer.
8525 * \return #PSA_SUCCESS, if the buffer was successfully
8526 * copied.
8527 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8528 * copy is too small to hold contents of the
8529 * input buffer.
8530 */
8531MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008532psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8533 uint8_t *input_copy, size_t input_copy_len)
8534{
8535 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008536 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008537 }
8538
David Horstmann372b8bb2023-11-24 16:21:04 +00008539#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008540 if (psa_input_pre_copy_hook != NULL) {
8541 psa_input_pre_copy_hook(input, input_len);
8542 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008543#endif
8544
David Horstmann777e7412023-11-15 17:33:47 +00008545 if (input_len > 0) {
8546 memcpy(input_copy, input, input_len);
8547 }
David Horstmannfde97392023-10-30 20:29:43 +00008548
David Horstmann372b8bb2023-11-24 16:21:04 +00008549#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008550 if (psa_input_post_copy_hook != NULL) {
8551 psa_input_post_copy_hook(input, input_len);
8552 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008553#endif
8554
David Horstmannfde97392023-10-30 20:29:43 +00008555 return PSA_SUCCESS;
8556}
8557
David Horstmann1b7279a2023-11-15 15:18:30 +00008558/** Copy from a local output buffer into a user-supplied one.
8559 *
8560 * \param[in] output_copy Pointer to a local buffer containing the output.
8561 * \param[in] output_copy_len Length of the local buffer.
8562 * \param[out] output Pointer to user-supplied output buffer.
8563 * \param[out] output_len Length of the user-supplied output buffer.
8564 * \return #PSA_SUCCESS, if the buffer was successfully
8565 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008566 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008567 * user-supplied output buffer is too small to
8568 * hold the contents of the local buffer.
8569 */
8570MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008571psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8572 uint8_t *output, size_t output_len)
8573{
8574 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008575 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008576 }
David Horstmann777e7412023-11-15 17:33:47 +00008577
David Horstmann372b8bb2023-11-24 16:21:04 +00008578#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008579 if (psa_output_pre_copy_hook != NULL) {
8580 psa_output_pre_copy_hook(output, output_len);
8581 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008582#endif
8583
David Horstmann777e7412023-11-15 17:33:47 +00008584 if (output_copy_len > 0) {
8585 memcpy(output, output_copy, output_copy_len);
8586 }
8587
David Horstmann372b8bb2023-11-24 16:21:04 +00008588#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008589 if (psa_output_post_copy_hook != NULL) {
8590 psa_output_post_copy_hook(output, output_len);
8591 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008592#endif
8593
David Horstmann8978f5c2023-10-30 20:37:12 +00008594 return PSA_SUCCESS;
8595}
8596
David Horstmannf1734052023-11-20 17:15:32 +00008597psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8598 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008599{
8600 psa_status_t status;
8601
David Horstmann9db14482023-11-23 15:50:37 +00008602 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008603
David Horstmannc5cc1c32023-11-15 18:11:26 +00008604 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008605 return PSA_SUCCESS;
8606 }
8607
David Horstmannf1734052023-11-20 17:15:32 +00008608 local_input->buffer = mbedtls_calloc(input_len, 1);
8609 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008610 /* Since we dealt with the zero-length case above, we know that
8611 * a NULL return value means a failure of allocation. */
8612 return PSA_ERROR_INSUFFICIENT_MEMORY;
8613 }
David Horstmannf1734052023-11-20 17:15:32 +00008614 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008615
David Horstmannf1734052023-11-20 17:15:32 +00008616 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008617
8618 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008619 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008620 if (status != PSA_SUCCESS) {
8621 goto error;
8622 }
8623
8624 return PSA_SUCCESS;
8625
8626error:
David Horstmannf1734052023-11-20 17:15:32 +00008627 mbedtls_free(local_input->buffer);
8628 local_input->buffer = NULL;
8629 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008630 return status;
8631}
8632
David Horstmannf1734052023-11-20 17:15:32 +00008633void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008634{
David Horstmannf1734052023-11-20 17:15:32 +00008635 mbedtls_free(local_input->buffer);
8636 local_input->buffer = NULL;
8637 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008638}
8639
David Horstmann89875a42023-11-20 12:54:09 +00008640psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8641 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008642{
David Horstmann9db14482023-11-23 15:50:37 +00008643 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008644
David Horstmannc5cc1c32023-11-15 18:11:26 +00008645 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008646 return PSA_SUCCESS;
8647 }
David Horstmann89875a42023-11-20 12:54:09 +00008648 local_output->buffer = mbedtls_calloc(output_len, 1);
8649 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +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 Horstmann89875a42023-11-20 12:54:09 +00008654 local_output->length = output_len;
8655 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008656
8657 return PSA_SUCCESS;
8658}
8659
David Horstmann89875a42023-11-20 12:54:09 +00008660psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008661{
David Horstmannc335a4e2023-11-15 15:57:32 +00008662 psa_status_t status;
8663
David Horstmann89875a42023-11-20 12:54:09 +00008664 if (local_output->buffer == NULL) {
8665 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008666 return PSA_SUCCESS;
8667 }
David Horstmann89875a42023-11-20 12:54:09 +00008668 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008669 /* We have an internal copy but nothing to copy back to. */
8670 return PSA_ERROR_CORRUPTION_DETECTED;
8671 }
8672
David Horstmann89875a42023-11-20 12:54:09 +00008673 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8674 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008675 if (status != PSA_SUCCESS) {
8676 return status;
8677 }
David Horstmann9467ea32023-11-08 17:44:18 +00008678
David Horstmann89875a42023-11-20 12:54:09 +00008679 mbedtls_free(local_output->buffer);
8680 local_output->buffer = NULL;
8681 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008682
8683 return PSA_SUCCESS;
8684}
8685
Gilles Peskinee59236f2018-01-27 23:32:46 +01008686#endif /* MBEDTLS_PSA_CRYPTO_C */