blob: 2847d70dee11e7403c89b9591f329bc7b5dd6054 [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
David Horstmannbf4ec792023-12-11 15:45:20 +0000163 * - The name <output>_local_output_status is not used for the given value of
164 * <output>
David Horstmann3e72db42023-12-08 14:08:18 +0000165 */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000166#define FREE_LOCAL_OUTPUT(output) \
David Horstmann3e72db42023-12-08 14:08:18 +0000167 output = NULL; \
David Horstmannbf4ec792023-12-11 15:45:20 +0000168 psa_status_t output ## _local_output_status; \
169 output ## _local_output_status = psa_crypto_local_output_free(&output ## _copy); \
170 if (output ## _local_output_status != PSA_SUCCESS) { \
David Horstmann3e72db42023-12-08 14:08:18 +0000171 /* Since this error case is an internal error, it's more serious than \
172 * any existing error code and so it's fine to overwrite the existing \
173 * status. */ \
David Horstmannbf4ec792023-12-11 15:45:20 +0000174 status = output ## _local_output_status; \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000175 }
David Horstmann513101b2023-11-29 17:24:08 +0000176#else /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
177#define SWAP_FOR_LOCAL_INPUT(input, length)
178#define FREE_LOCAL_INPUT(input)
179#define SWAP_FOR_LOCAL_OUTPUT(output, length)
180#define FREE_LOCAL_OUTPUT(output)
181#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000182
183
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100184int psa_can_do_hash(psa_algorithm_t hash_alg)
185{
186 (void) hash_alg;
187 return global_data.drivers_initialized;
188}
Valerio Settia55f0422023-07-10 15:34:41 +0200189#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200190 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200191 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200192static int psa_is_dh_key_size_valid(size_t bits)
193{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200194 if (bits != 2048 && bits != 3072 && bits != 4096 &&
195 bits != 6144 && bits != 8192) {
196 return 0;
197 }
198
199 return 1;
200}
Valerio Settia55f0422023-07-10 15:34:41 +0200201#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200202 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200203 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100204
Gilles Peskine449bd832023-01-11 14:50:10 +0100205psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100206{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100207 /* Mbed TLS error codes can combine a high-level error code and a
208 * low-level error code. The low-level error usually reflects the
209 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 int low_level_ret = -(-ret & 0x007f);
211 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100212 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100213 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100214
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100215#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100216 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
217 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100218 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100219 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
220 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100221#endif
222
223#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200224 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
225 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
226 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
227 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
228 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200230 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200232 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100233 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100234#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200235
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100236#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000237 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100238 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100239 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100240#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100241
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100242#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100243 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100245 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100247#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100248
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100249#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200250 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100252#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200253
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100254#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200255 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100256 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200257 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100259#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200260
Dave Rodgman509b5672023-08-16 19:26:23 +0100261#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100262 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100264 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100266 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100268 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100270 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100272 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100274 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100276#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100277
Gilles Peskine449bd832023-01-11 14:50:10 +0100278#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
279 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100280 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
281 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100282 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100284 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
285 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100286 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100287 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100289#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100290
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100291#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100292 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100294#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100295
Gilles Peskinee59236f2018-01-27 23:32:46 +0100296 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
297 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
298 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100300
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100301#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100302 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200304 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100306 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100308#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100309
Gilles Peskine82e57d12020-11-13 21:31:17 +0100310#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100312 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
313 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100314 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100316 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
317 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100319 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100321#endif
322
Dave Rodgmandea266f2023-08-31 11:52:43 +0100323#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100326 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100328 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100329 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100330#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100331 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100333#endif
334#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100335
Dave Rodgman509b5672023-08-16 19:26:23 +0100336#if defined(MBEDTLS_BIGNUM_C)
337#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100338 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100340#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100341 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
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_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100345 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100347 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
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_DIVISION_BY_ZERO:
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_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100353 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100355#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100356
Dave Rodgman509b5672023-08-16 19:26:23 +0100357#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100358 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100359 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100360 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
361 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100363#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
364 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100365 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100367#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100368 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
369 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100371 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100373 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
374 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100375 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100376 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100378 case MBEDTLS_ERR_PK_INVALID_ALG:
379 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
380 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100382 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200384 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100386#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100387
Gilles Peskineff2d2002019-05-06 15:26:23 +0200388 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100389 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200390 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100391 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200392
Dave Rodgman509b5672023-08-16 19:26:23 +0100393#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100394 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100396 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100397 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100398 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100400 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100401 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100402 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
403 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100405 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100407 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100408 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100409 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100411#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200412
Dave Rodgman1dab4452023-09-01 09:59:51 +0100413#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300414 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300415 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300417 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300419 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300421 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
422 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300424 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100425 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100426 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100428
Dave Rodgman509b5672023-08-16 19:26:23 +0100429#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000430 case MBEDTLS_ERR_ECP_IN_PROGRESS:
431 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100432#endif
433#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000434
Janos Follatha13b9052019-11-22 12:48:59 +0000435 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100436 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300437
Gilles Peskinee59236f2018-01-27 23:32:46 +0100438 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100440 }
441}
442
Paul Elliottdc42ca82023-02-24 18:11:59 +0000443/**
444 * \brief For output buffers which contain "tags"
445 * (outputs that may be checked for validity like
446 * hashes, MACs and signatures), fill the unused
447 * part of the output buffer (the whole buffer on
448 * error, the trailing part on success) with
449 * something that isn't a valid tag (barring an
450 * attack on the tag and deliberately-crafted
451 * input), in case the caller doesn't check the
452 * return status properly.
453 *
454 * \param output_buffer Pointer to buffer to wipe. May not be NULL
455 * unless \p output_buffer_size is zero.
456 * \param status Status of function called to generate
457 * output_buffer originally
458 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
459 * could be NULL.
460 * \param output_buffer_length Length of data written to output_buffer, must be
461 * less than \p output_buffer_size
462 */
463static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000464 size_t output_buffer_size, size_t output_buffer_length)
465{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000466 size_t offset = 0;
467
468 if (output_buffer_size == 0) {
469 /* If output_buffer_size is 0 then we have nothing to do. We must not
470 call memset because output_buffer may be NULL in this case */
471 return;
472 }
473
474 if (status == PSA_SUCCESS) {
475 offset = output_buffer_length;
476 }
477
478 memset(output_buffer + offset, '!', output_buffer_size - offset);
479}
480
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200481
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200482
483
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100484/****************************************************************/
485/* Key management */
486/****************************************************************/
487
Valerio Settia9aab1a2023-06-19 13:39:54 +0200488#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200489psa_ecc_family_t mbedtls_ecc_group_to_psa(mbedtls_ecp_group_id grpid,
490 size_t *bits)
491{
492 switch (grpid) {
Valerio Settic437fae2023-09-08 14:58:03 +0200493#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200494 case MBEDTLS_ECP_DP_SECP192R1:
495 *bits = 192;
496 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100497#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200498#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200499 case MBEDTLS_ECP_DP_SECP224R1:
500 *bits = 224;
501 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100502#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200503#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200504 case MBEDTLS_ECP_DP_SECP256R1:
505 *bits = 256;
506 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100507#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200508#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200509 case MBEDTLS_ECP_DP_SECP384R1:
510 *bits = 384;
511 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100512#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200513#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200514 case MBEDTLS_ECP_DP_SECP521R1:
515 *bits = 521;
516 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100517#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200518#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200519 case MBEDTLS_ECP_DP_BP256R1:
520 *bits = 256;
521 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100522#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200523#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200524 case MBEDTLS_ECP_DP_BP384R1:
525 *bits = 384;
526 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100527#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200528#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200529 case MBEDTLS_ECP_DP_BP512R1:
530 *bits = 512;
531 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100532#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200533#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200534 case MBEDTLS_ECP_DP_CURVE25519:
535 *bits = 255;
536 return PSA_ECC_FAMILY_MONTGOMERY;
Dave Rodgman6f682032023-08-16 18:44:32 +0100537#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200538#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200539 case MBEDTLS_ECP_DP_SECP192K1:
540 *bits = 192;
541 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100542#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200543#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200544 case MBEDTLS_ECP_DP_SECP224K1:
545 *bits = 224;
546 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100547#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200548#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200549 case MBEDTLS_ECP_DP_SECP256K1:
550 *bits = 256;
551 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100552#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200553#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200554 case MBEDTLS_ECP_DP_CURVE448:
555 *bits = 448;
556 return PSA_ECC_FAMILY_MONTGOMERY;
Dave Rodgman6f682032023-08-16 18:44:32 +0100557#endif
Valerio Settibc2b1d32023-06-19 12:15:13 +0200558 default:
559 *bits = 0;
560 return 0;
561 }
562}
563
Gilles Peskine449bd832023-01-11 14:50:10 +0100564mbedtls_ecp_group_id mbedtls_ecc_group_of_psa(psa_ecc_family_t curve,
565 size_t bits,
566 int bits_is_sloppy)
Gilles Peskine12313cd2018-06-20 00:20:32 +0200567{
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 switch (curve) {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100569 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100571#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100572 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_ECP_DP_SECP192R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100574#endif
575#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100576 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 return MBEDTLS_ECP_DP_SECP224R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100578#endif
579#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100580 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 return MBEDTLS_ECP_DP_SECP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100582#endif
583#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100584 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_ECP_DP_SECP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100586#endif
587#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100588 case 521:
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_ECP_DP_SECP521R1;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100590 case 528:
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 if (bits_is_sloppy) {
592 return MBEDTLS_ECP_DP_SECP521R1;
593 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100594 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100595#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100596 }
597 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100598
Paul Elliott8ff510a2020-06-02 17:19:28 +0100599 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100601#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100602 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100603 return MBEDTLS_ECP_DP_BP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100604#endif
605#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100606 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 return MBEDTLS_ECP_DP_BP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100608#endif
609#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100610 case 512:
Gilles Peskine449bd832023-01-11 14:50:10 +0100611 return MBEDTLS_ECP_DP_BP512R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100612#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100613 }
614 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100615
Paul Elliott8ff510a2020-06-02 17:19:28 +0100616 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100618#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100619 case 255:
Gilles Peskine449bd832023-01-11 14:50:10 +0100620 return MBEDTLS_ECP_DP_CURVE25519;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100621 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100622 if (bits_is_sloppy) {
623 return MBEDTLS_ECP_DP_CURVE25519;
624 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100625 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100626#endif
627#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100628 case 448:
Gilles Peskine449bd832023-01-11 14:50:10 +0100629 return MBEDTLS_ECP_DP_CURVE448;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100630#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100631 }
632 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100633
Paul Elliott8ff510a2020-06-02 17:19:28 +0100634 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100635 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100636#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100637 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100638 return MBEDTLS_ECP_DP_SECP192K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100639#endif
640#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100641 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100642 return MBEDTLS_ECP_DP_SECP224K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100643#endif
644#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100645 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100646 return MBEDTLS_ECP_DP_SECP256K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100647#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100648 }
649 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200650 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100651
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100652 (void) bits_is_sloppy;
Gilles Peskine449bd832023-01-11 14:50:10 +0100653 return MBEDTLS_ECP_DP_NONE;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200654}
Valerio Settia9aab1a2023-06-19 13:39:54 +0200655#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200656
Gilles Peskine449bd832023-01-11 14:50:10 +0100657psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
658 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200659{
660 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100661 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200662 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200663 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200664 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200665 case PSA_KEY_TYPE_PASSWORD:
666 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200667 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100668#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200669 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 if (bits != 128 && bits != 192 && bits != 256) {
671 return PSA_ERROR_INVALID_ARGUMENT;
672 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200673 break;
674#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200675#if defined(PSA_WANT_KEY_TYPE_ARIA)
676 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 if (bits != 128 && bits != 192 && bits != 256) {
678 return PSA_ERROR_INVALID_ARGUMENT;
679 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200680 break;
681#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100682#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200683 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 if (bits != 128 && bits != 192 && bits != 256) {
685 return PSA_ERROR_INVALID_ARGUMENT;
686 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200687 break;
688#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100689#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200690 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 if (bits != 64 && bits != 128 && bits != 192) {
692 return PSA_ERROR_INVALID_ARGUMENT;
693 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200694 break;
695#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100696#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200697 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 if (bits != 256) {
699 return PSA_ERROR_INVALID_ARGUMENT;
700 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200701 break;
702#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200703 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200705 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100706 if (bits % 8 != 0) {
707 return PSA_ERROR_INVALID_ARGUMENT;
708 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200709
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200711}
712
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100713/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100714 *
Steven Cooremancd640932021-03-08 12:00:27 +0100715 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
716 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100717 *
718 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100719 * \param[in] key_type The key type of the key to be used with the
720 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100721 *
722 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100723 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100724 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100725 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100726 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100727MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100728 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100730{
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 if (PSA_ALG_IS_HMAC(algorithm)) {
732 if (key_type == PSA_KEY_TYPE_HMAC) {
733 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100734 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100735 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
738 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
739 * key. */
740 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
741 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
742 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
743 * the block length (larger than 1) for block ciphers. */
744 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
745 return PSA_SUCCESS;
746 }
747 }
748 }
749
750 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100751}
752
Gilles Peskine449bd832023-01-11 14:50:10 +0100753psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
754 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200755{
Gilles Peskine449bd832023-01-11 14:50:10 +0100756 if (slot->key.data != NULL) {
757 return PSA_ERROR_ALREADY_EXISTS;
758 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200759
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 slot->key.data = mbedtls_calloc(1, buffer_length);
761 if (slot->key.data == NULL) {
762 return PSA_ERROR_INSUFFICIENT_MEMORY;
763 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200764
Ronald Cronea0f8a62020-11-25 17:52:23 +0100765 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100766 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200767}
768
Gilles Peskine449bd832023-01-11 14:50:10 +0100769psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
770 const uint8_t *data,
771 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200772{
Gilles Peskine449bd832023-01-11 14:50:10 +0100773 psa_status_t status = psa_allocate_buffer_to_slot(slot,
774 data_length);
775 if (status != PSA_SUCCESS) {
776 return status;
777 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200778
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 memcpy(slot->key.data, data, data_length);
780 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200781}
782
Ronald Crona0fe59f2020-11-29 11:14:53 +0100783psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100784 const psa_key_attributes_t *attributes,
785 const uint8_t *data, size_t data_length,
786 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100788{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100789 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
790 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100791
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200792 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 if (data_length == 0) {
794 return PSA_ERROR_NOT_SUPPORTED;
795 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200796
Gilles Peskine449bd832023-01-11 14:50:10 +0100797 if (key_type_is_raw_bytes(type)) {
798 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200799
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
801 *bits);
802 if (status != PSA_SUCCESS) {
803 return status;
804 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200805
Ronald Crondd04d422020-11-28 15:14:42 +0100806 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100808 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200810
Gilles Peskine449bd832023-01-11 14:50:10 +0100811 return PSA_SUCCESS;
812 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200813#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200814 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100815 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200816 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100817 return PSA_ERROR_INVALID_ARGUMENT;
818 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200819 return mbedtls_psa_ffdh_import_key(attributes,
820 data, data_length,
821 key_buffer, key_buffer_size,
822 key_buffer_length,
823 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100824 }
Valerio Settia55f0422023-07-10 15:34:41 +0200825#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200826 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200827#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
829 if (PSA_KEY_TYPE_IS_ECC(type)) {
830 return mbedtls_psa_ecp_import_key(attributes,
831 data, data_length,
832 key_buffer, key_buffer_size,
833 key_buffer_length,
834 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100835 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200836#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800837 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200838#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
839 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100840 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
841 if (PSA_KEY_TYPE_IS_RSA(type)) {
842 return mbedtls_psa_rsa_import_key(attributes,
843 data, data_length,
844 key_buffer, key_buffer_size,
845 key_buffer_length,
846 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200847 }
Valerio Settife478902023-07-25 12:27:19 +0200848#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
849 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800850 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100851 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100852
Gilles Peskine449bd832023-01-11 14:50:10 +0100853 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100854}
855
Gilles Peskinef603c712019-01-19 13:40:11 +0100856/** Calculate the intersection of two algorithm usage policies.
857 *
858 * Return 0 (which allows no operation) on incompatibility.
859 */
860static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100861 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100862 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100863 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100864{
Gilles Peskine549ea862019-05-22 11:45:59 +0200865 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100866 if (alg1 == alg2) {
867 return alg1;
868 }
Steven Cooreman03488022021-02-18 12:07:20 +0100869 /* If the policies are from the same hash-and-sign family, check
870 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
872 PSA_ALG_IS_SIGN_HASH(alg2) &&
873 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
874 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
875 return alg2;
876 }
877 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
878 return alg1;
879 }
Steven Cooreman03488022021-02-18 12:07:20 +0100880 }
881 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100882 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100883 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100884 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
885 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
886 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
887 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
888 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100889 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100890
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100891 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
893 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
894 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
895 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100896 }
897 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
899 (alg1_len <= alg2_len)) {
900 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100901 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100902 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
903 (alg2_len <= alg1_len)) {
904 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100905 }
906 }
907 /* If the policies are from the same MAC family, check whether one
908 * of them is a minimum-MAC-length policy. Calculate the most
909 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100910 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
911 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
912 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100913 /* Validate the combination of key type and algorithm. Since the base
914 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
916 return 0;
917 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100918
Steven Cooreman31a876d2021-03-03 20:47:40 +0100919 /* Get the (exact or at-least) output lengths for both sides of the
920 * requested intersection. None of the currently supported algorithms
921 * have an output length dependent on the actual key size, so setting it
922 * to a bogus value of 0 is currently OK.
923 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100924 * Note that for at-least-this-length wildcard algorithms, the output
925 * length is set to the shortest allowed length, which allows us to
926 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
928 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100929 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100930
Steven Cooremana1d83222021-02-25 10:20:29 +0100931 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100932 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
933 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
934 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100935 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100936
937 /* If only one is an at-least-this-length policy, the intersection would
938 * be the other (fixed-length) policy as long as said fixed length is
939 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100940 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
941 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100942 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
944 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100945 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100946
Steven Cooremancd640932021-03-08 12:00:27 +0100947 /* If none of them are wildcards, check whether they define the same tag
948 * length. This is still possible here when one is default-length and
949 * the other specific-length. Ensure to always return the
950 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100951 if (alg1_len == alg2_len) {
952 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
953 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100954 }
955 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100957}
958
Gilles Peskine449bd832023-01-11 14:50:10 +0100959static int psa_key_algorithm_permits(psa_key_type_t key_type,
960 psa_algorithm_t policy_alg,
961 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200962{
Gilles Peskine549ea862019-05-22 11:45:59 +0200963 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 if (requested_alg == policy_alg) {
965 return 1;
966 }
Steven Cooreman03488022021-02-18 12:07:20 +0100967 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
968 * and requested_alg is the same hash-and-sign family with any hash,
969 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
971 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
972 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
973 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100974 }
975 /* If policy_alg is a wildcard AEAD algorithm of the same base as
976 * the requested algorithm, check the requested tag length to be
977 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100978 if (PSA_ALG_IS_AEAD(policy_alg) &&
979 PSA_ALG_IS_AEAD(requested_alg) &&
980 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
981 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
982 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
983 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
984 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100985 }
Steven Cooremancd640932021-03-08 12:00:27 +0100986 /* If policy_alg is a MAC algorithm of the same base as the requested
987 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 if (PSA_ALG_IS_MAC(policy_alg) &&
989 PSA_ALG_IS_MAC(requested_alg) &&
990 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
991 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100992 /* Validate the combination of key type and algorithm. Since the policy
993 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
995 return 0;
996 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100997
Steven Cooreman31a876d2021-03-03 20:47:40 +0100998 /* Get both the requested output length for the algorithm which is to be
999 * verified, and the default output length for the base algorithm.
1000 * Note that none of the currently supported algorithms have an output
1001 * length dependent on actual key size, so setting it to a bogus value
1002 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001003 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001005 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 key_type, 0,
1007 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001008
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001009 /* If the policy is default-length, only allow an algorithm with
1010 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
1012 return requested_output_length == default_output_length;
1013 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001014
1015 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +01001016 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
1018 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
1019 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001020 }
1021
Steven Cooremancd640932021-03-08 12:00:27 +01001022 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
1023 * check for the requested MAC length to be equal to or longer than the
1024 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
1026 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
1027 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001028 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001029 }
Steven Cooremance48e852020-10-05 16:02:45 +02001030 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001031 * a key derivation with that key agreement should also be allowed. This
1032 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
1034 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
1035 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
1036 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +02001037 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001038 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001040}
1041
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001042/** Test whether a policy permits an algorithm.
1043 *
1044 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +01001045 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001046 * \note This function requires providing the key type for which the policy is
1047 * being validated, since some algorithm policy definitions (e.g. MAC)
1048 * have different properties depending on what kind of cipher it is
1049 * combined with.
1050 *
Steven Cooreman7e39f052021-02-23 14:18:32 +01001051 * \retval PSA_SUCCESS When \p alg is a specific algorithm
1052 * allowed by the \p policy.
1053 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
1054 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
1055 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001056 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001057static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
1058 psa_key_type_t key_type,
1059 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001060{
Steven Cooremand788fab2021-02-25 11:29:17 +01001061 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 if (alg == 0) {
1063 return PSA_ERROR_INVALID_ARGUMENT;
1064 }
Steven Cooremand788fab2021-02-25 11:29:17 +01001065
Steven Cooreman7e39f052021-02-23 14:18:32 +01001066 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 if (PSA_ALG_IS_WILDCARD(alg)) {
1068 return PSA_ERROR_INVALID_ARGUMENT;
1069 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001070
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
1072 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
1073 return PSA_SUCCESS;
1074 } else {
1075 return PSA_ERROR_NOT_PERMITTED;
1076 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001077}
1078
Gilles Peskinef603c712019-01-19 13:40:11 +01001079/** Restrict a key policy based on a constraint.
1080 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001081 * \note This function requires providing the key type for which the policy is
1082 * being restricted, since some algorithm policy definitions (e.g. MAC)
1083 * have different properties depending on what kind of cipher it is
1084 * combined with.
1085 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001086 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +01001087 * \param[in,out] policy The policy to restrict.
1088 * \param[in] constraint The policy constraint to apply.
1089 *
1090 * \retval #PSA_SUCCESS
1091 * \c *policy contains the intersection of the original value of
1092 * \c *policy and \c *constraint.
1093 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001094 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +01001095 * \c *policy is unchanged.
1096 */
1097static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001098 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +01001099 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +01001101{
1102 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 psa_key_policy_algorithm_intersection(key_type, policy->alg,
1104 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +02001105 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
1107 constraint->alg2);
1108 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1109 return PSA_ERROR_INVALID_ARGUMENT;
1110 }
1111 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1112 return PSA_ERROR_INVALID_ARGUMENT;
1113 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001114 policy->usage &= constraint->usage;
1115 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001116 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001118}
1119
Przemek Stekiel061f6942022-11-30 10:51:35 +01001120/** Get the description of a key given its identifier and policy constraints
1121 * and lock it.
1122 *
1123 * The key must have allow all the usage flags set in \p usage. If \p alg is
1124 * nonzero, the key must allow operations with this algorithm. If \p alg is
1125 * zero, the algorithm is not checked.
1126 *
1127 * In case of a persistent key, the function loads the description of the key
1128 * into a key slot if not already done.
1129 *
1130 * On success, the returned key slot is locked. It is the responsibility of
1131 * the caller to unlock the key slot when it does not access it anymore.
1132 */
1133static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001134 mbedtls_svc_key_id_t key,
1135 psa_key_slot_t **p_slot,
1136 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001138{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001139 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001140 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001141
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 status = psa_get_and_lock_key_slot(key, p_slot);
1143 if (status != PSA_SUCCESS) {
1144 return status;
1145 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001146 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001147
1148 /* Enforce that usage policy for the key slot contains all the flags
1149 * required by the usage parameter. There is one exception: public
1150 * keys can always be exported, so we treat public key objects as
1151 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001153 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001155
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001157 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001158 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001159 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001160
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001161 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 if (alg != 0) {
1163 status = psa_key_policy_permits(&slot->attr.policy,
1164 slot->attr.type,
1165 alg);
1166 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001167 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001169 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001170
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001172
1173error:
1174 *p_slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001176
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001178}
Darryl Green940d72c2018-07-13 13:18:51 +01001179
Ronald Cron5c522922020-11-14 16:35:34 +01001180/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001181 *
1182 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001183 * available, as opposed to a key in a secure element and/or to be used
1184 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001185 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001186 * This is a temporary function that may be used instead of
1187 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1188 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001189 *
Ronald Cron5c522922020-11-14 16:35:34 +01001190 * On success, the returned key slot is locked. It is the responsibility of the
1191 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001192 */
Ronald Cron5c522922020-11-14 16:35:34 +01001193static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1194 mbedtls_svc_key_id_t key,
1195 psa_key_slot_t **p_slot,
1196 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001198{
Gilles Peskine449bd832023-01-11 14:50:10 +01001199 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1200 usage, alg);
1201 if (status != PSA_SUCCESS) {
1202 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001203 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001204
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
1206 psa_unlock_key_slot(*p_slot);
1207 *p_slot = NULL;
1208 return PSA_ERROR_NOT_SUPPORTED;
1209 }
1210
1211 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001212}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001215{
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001217 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001218 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001219
Ronald Cronea0f8a62020-11-25 17:52:23 +01001220 slot->key.data = NULL;
1221 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001222
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001224}
1225
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001226/** Completely wipe a slot in memory, including its policy.
1227 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001228psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001229{
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 /*
1233 * As the return error code may not be handled in case of multiple errors,
1234 * do our best to report an unexpected lock counter. Assert with
1235 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
1236 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1237 * function is called as part of the execution of a test suite, the
1238 * execution of the test suite is stopped in error if the assertion fails.
1239 */
1240 if (slot->lock_count != 1) {
1241 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->lock_count == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001242 status = PSA_ERROR_CORRUPTION_DETECTED;
1243 }
1244
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001245 /* Multipart operations may still be using the key. This is safe
1246 * because all multipart operation objects are independent from
1247 * the key slot: if they need to access the key after the setup
1248 * phase, they have a copy of the key. Note that this means that
1249 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001250 /* At this point, key material and other type-specific content has
1251 * been wiped. Clear remaining metadata. We can call memset and not
1252 * zeroize because the metadata is not particularly sensitive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001253 memset(slot, 0, sizeof(*slot));
1254 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001255}
1256
Gilles Peskine449bd832023-01-11 14:50:10 +01001257psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001258{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001259 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001260 psa_status_t status; /* status of the last operation */
1261 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001262#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1263 psa_se_drv_table_entry_t *driver;
1264#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001265
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 if (mbedtls_svc_key_id_is_null(key)) {
1267 return PSA_SUCCESS;
1268 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001269
Ronald Cronf2911112020-10-29 17:51:10 +01001270 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001271 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001272 * key, this will load the key description from persistent memory if not
1273 * done yet. We cannot avoid this loading as without it we don't know if
1274 * the key is operated by an SE or not and this information is needed by
1275 * the current implementation.
1276 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001277 status = psa_get_and_lock_key_slot(key, &slot);
1278 if (status != PSA_SUCCESS) {
1279 return status;
1280 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001281
Ronald Cronf2911112020-10-29 17:51:10 +01001282 /*
1283 * If the key slot containing the key description is under access by the
1284 * library (apart from the present access), the key cannot be destroyed
1285 * yet. For the time being, just return in error. Eventually (to be
1286 * implemented), the key should be destroyed when all accesses have
1287 * stopped.
1288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 if (slot->lock_count > 1) {
1290 psa_unlock_key_slot(slot);
1291 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001292 }
1293
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001295 /* Refuse the destruction of a read-only key (which may or may not work
1296 * if we attempt it, depending on whether the key is merely read-only
1297 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001298 * Just do the best we can, which is to wipe the copy in memory
1299 * (done in this function's cleanup code). */
1300 overall_status = PSA_ERROR_NOT_PERMITTED;
1301 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001302 }
1303
Gilles Peskine354f7672019-07-12 23:46:38 +02001304#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1306 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001307 /* For a key in a secure element, we need to do three things:
1308 * remove the key file in internal storage, destroy the
1309 * key inside the secure element, and update the driver's
1310 * persistent data. Start a transaction that will encompass these
1311 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001313 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001315 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 status = psa_crypto_save_transaction();
1317 if (status != PSA_SUCCESS) {
1318 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001319 /* We should still try to destroy the key in the secure
1320 * element and the key metadata in storage. This is especially
1321 * important if the error is that the storage is full.
1322 * But how to do it exactly without risking an inconsistent
1323 * state after a reset?
1324 * https://github.com/ARMmbed/mbed-crypto/issues/215
1325 */
1326 overall_status = status;
1327 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001328 }
1329
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 status = psa_destroy_se_key(driver,
1331 psa_key_slot_get_slot_number(slot));
1332 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001333 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001335 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001336#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1337
Darryl Greend49a4992018-06-18 17:27:26 +01001338#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1340 status = psa_destroy_persistent_key(slot->attr.id);
1341 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001342 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001344
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001345 /* TODO: other slots may have a copy of the same key. We should
1346 * invalidate them.
1347 * https://github.com/ARMmbed/mbed-crypto/issues/214
1348 */
Darryl Greend49a4992018-06-18 17:27:26 +01001349 }
1350#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001351
Gilles Peskinefc762652019-07-22 19:30:34 +02001352#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 if (driver != NULL) {
1354 status = psa_save_se_persistent_data(driver);
1355 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001356 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 }
1358 status = psa_crypto_stop_transaction();
1359 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001360 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001362 }
1363#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1364
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001365exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001367 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001369 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 }
1371 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001372}
1373
Valerio Settib2bcedb2023-07-10 11:24:00 +02001374#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001375 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001376static psa_status_t psa_get_rsa_public_exponent(
1377 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001379{
1380 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001381 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001382 uint8_t *buffer = NULL;
1383 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001385
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1387 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001388 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 }
1390 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001391 /* It's the default value, which is reported as an empty string,
1392 * so there's nothing to do. */
1393 goto exit;
1394 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001395
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 buflen = mbedtls_mpi_size(&mpi);
1397 buffer = mbedtls_calloc(1, buflen);
1398 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001399 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1400 goto exit;
1401 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1403 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001404 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001406 attributes->domain_parameters = buffer;
1407 attributes->domain_parameters_size = buflen;
1408
1409exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001410 mbedtls_mpi_free(&mpi);
1411 if (ret != 0) {
1412 mbedtls_free(buffer);
1413 }
1414 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001415}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001416#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001417 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001418
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001419/** Retrieve all the publicly-accessible attributes of a key.
1420 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001421psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1422 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001423{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001425 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001426 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001427
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1431 if (status != PSA_SUCCESS) {
1432 return status;
1433 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001434
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001435 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1437 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001438
1439#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1441 psa_set_key_slot_number(attributes,
1442 psa_key_slot_get_slot_number(slot));
1443 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001444#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001445
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001447#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1448 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001449 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001450 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001451 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001452 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001453 * is not yet implemented.
1454 * https://github.com/ARMmbed/mbed-crypto/issues/216
1455 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001457 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001458
Ronald Cron90857082020-11-25 14:58:33 +01001459 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 slot->attr.type,
1461 slot->key.data,
1462 slot->key.bytes,
1463 &rsa);
1464 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001465 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001467
Gilles Peskine449bd832023-01-11 14:50:10 +01001468 status = psa_get_rsa_public_exponent(rsa,
1469 attributes);
1470 mbedtls_rsa_free(rsa);
1471 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001472 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001473 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001474#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1475 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001476 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001477 default:
1478 /* Nothing else to do. */
1479 break;
1480 }
1481
Gilles Peskine449bd832023-01-11 14:50:10 +01001482 if (status != PSA_SUCCESS) {
1483 psa_reset_key_attributes(attributes);
1484 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001485
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001487
Gilles Peskine449bd832023-01-11 14:50:10 +01001488 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001489}
1490
Gilles Peskinec8000c02019-08-02 20:15:51 +02001491#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1492psa_status_t psa_get_key_slot_number(
1493 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001495{
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001497 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 return PSA_SUCCESS;
1499 } else {
1500 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001501 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001502}
1503#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1504
Gilles Peskine449bd832023-01-11 14:50:10 +01001505static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1506 size_t key_buffer_size,
1507 uint8_t *data,
1508 size_t data_size,
1509 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001510{
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 if (key_buffer_size > data_size) {
1512 return PSA_ERROR_BUFFER_TOO_SMALL;
1513 }
1514 memcpy(data, key_buffer, key_buffer_size);
1515 memset(data + key_buffer_size, 0,
1516 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001517 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001519}
1520
Ronald Cron7285cda2020-11-26 14:46:37 +01001521psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001522 const psa_key_attributes_t *attributes,
1523 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001525{
Ronald Crond18b5f82020-11-25 16:46:05 +01001526 psa_key_type_t type = attributes->core.type;
1527
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 if (key_type_is_raw_bytes(type) ||
1529 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001530 PSA_KEY_TYPE_IS_ECC(type) ||
1531 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 return psa_export_key_buffer_internal(
1533 key_buffer, key_buffer_size,
1534 data, data_size, data_length);
1535 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001536 /* This shouldn't happen in the reference implementation, but
1537 it is valid for a special-purpose implementation to omit
1538 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001540 }
1541}
1542
Gilles Peskine449bd832023-01-11 14:50:10 +01001543psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1544 uint8_t *data,
1545 size_t data_size,
1546 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001547{
1548 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1549 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1550 psa_key_slot_t *slot;
1551
Ronald Crone907e552021-01-18 13:22:38 +01001552 /* Reject a zero-length output buffer now, since this can never be a
1553 * valid key representation. This way we know that data must be a valid
1554 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 if (data_size == 0) {
1556 return PSA_ERROR_BUFFER_TOO_SMALL;
1557 }
Ronald Crone907e552021-01-18 13:22:38 +01001558
Ronald Cron9486f9d2020-11-26 13:36:23 +01001559 /* Set the key to empty now, so that even when there are errors, we always
1560 * set data_length to a value between 0 and data_size. On error, setting
1561 * the key to empty is a good choice because an empty key representation is
1562 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001563 *data_length = 0;
1564
Ronald Cron9486f9d2020-11-26 13:36:23 +01001565 /* Export requires the EXPORT flag. There is an exception for public keys,
1566 * which don't require any flag, but
1567 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1568 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1570 PSA_KEY_USAGE_EXPORT, 0);
1571 if (status != PSA_SUCCESS) {
1572 return status;
1573 }
mohammad160306e79202018-03-28 13:17:44 +03001574
Ronald Crond18b5f82020-11-25 16:46:05 +01001575 psa_key_attributes_t attributes = {
1576 .core = slot->attr
1577 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 status = psa_driver_wrapper_export_key(&attributes,
1579 slot->key.data, slot->key.bytes,
1580 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001581
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001583
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001585}
1586
Ronald Cron7285cda2020-11-26 14:46:37 +01001587psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001588 const psa_key_attributes_t *attributes,
1589 const uint8_t *key_buffer,
1590 size_t key_buffer_size,
1591 uint8_t *data,
1592 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001594{
Ronald Crond18b5f82020-11-25 16:46:05 +01001595 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001596
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001597 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001598 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1599 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001600 /* Exporting public -> public */
1601 return psa_export_key_buffer_internal(
1602 key_buffer, key_buffer_size,
1603 data, data_size, data_length);
1604 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001605#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001606 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1607 return mbedtls_psa_rsa_export_public_key(attributes,
1608 key_buffer,
1609 key_buffer_size,
1610 data,
1611 data_size,
1612 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001613#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001614 /* We don't know how to convert a private RSA key to public. */
1615 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001616#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001617 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001618 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001619#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001620 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1621 return mbedtls_psa_ecp_export_public_key(attributes,
1622 key_buffer,
1623 key_buffer_size,
1624 data,
1625 data_size,
1626 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001627#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001628 /* We don't know how to convert a private ECC key to public */
1629 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001630#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001631 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001632 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001633#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001634 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001635 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001636 key_buffer,
1637 key_buffer_size,
1638 data, data_size,
1639 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001640#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001641 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001642#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001643 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001644 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001645 (void) key_buffer;
1646 (void) key_buffer_size;
1647 (void) data;
1648 (void) data_size;
1649 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001651 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001652}
Ronald Crond18b5f82020-11-25 16:46:05 +01001653
Gilles Peskine449bd832023-01-11 14:50:10 +01001654psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1655 uint8_t *data,
1656 size_t data_size,
1657 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001658{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001659 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001660 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001661 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001662 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001663
Ronald Crone907e552021-01-18 13:22:38 +01001664 /* Reject a zero-length output buffer now, since this can never be a
1665 * valid key representation. This way we know that data must be a valid
1666 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 if (data_size == 0) {
1668 return PSA_ERROR_BUFFER_TOO_SMALL;
1669 }
Ronald Crone907e552021-01-18 13:22:38 +01001670
Darryl Greendd8fb772018-11-07 16:00:44 +00001671 /* Set the key to empty now, so that even when there are errors, we always
1672 * set data_length to a value between 0 and data_size. On error, setting
1673 * the key to empty is a good choice because an empty key representation is
1674 * unlikely to be accepted anywhere. */
1675 *data_length = 0;
1676
1677 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1679 if (status != PSA_SUCCESS) {
1680 return status;
1681 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001682
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1684 status = PSA_ERROR_INVALID_ARGUMENT;
1685 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001686 }
1687
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001688 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001689 .core = slot->attr
1690 };
Ronald Cron67227982020-11-26 15:16:05 +01001691 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001692 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001694
1695exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001696 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001699}
1700
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001701MBEDTLS_STATIC_ASSERT(
1702 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1703 "One or more key attribute flag is listed as both external-only and dual-use")
1704MBEDTLS_STATIC_ASSERT(
1705 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1706 "One or more key attribute flag is listed as both internal-only and dual-use")
1707MBEDTLS_STATIC_ASSERT(
1708 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1709 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001710
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001711/** Validate that a key policy is internally well-formed.
1712 *
1713 * This function only rejects invalid policies. It does not validate the
1714 * consistency of the policy with respect to other attributes of the key
1715 * such as the key type.
1716 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001717static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001718{
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1720 PSA_KEY_USAGE_COPY |
1721 PSA_KEY_USAGE_ENCRYPT |
1722 PSA_KEY_USAGE_DECRYPT |
1723 PSA_KEY_USAGE_SIGN_MESSAGE |
1724 PSA_KEY_USAGE_VERIFY_MESSAGE |
1725 PSA_KEY_USAGE_SIGN_HASH |
1726 PSA_KEY_USAGE_VERIFY_HASH |
1727 PSA_KEY_USAGE_VERIFY_DERIVATION |
1728 PSA_KEY_USAGE_DERIVE)) != 0) {
1729 return PSA_ERROR_INVALID_ARGUMENT;
1730 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001731
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001733}
1734
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001735/** Validate the internal consistency of key attributes.
1736 *
1737 * This function only rejects invalid attribute values. If does not
1738 * validate the consistency of the attributes with any key data that may
1739 * be involved in the creation of the key.
1740 *
1741 * Call this function early in the key creation process.
1742 *
1743 * \param[in] attributes Key attributes for the new key.
1744 * \param[out] p_drv On any return, the driver for the key, if any.
1745 * NULL for a transparent key.
1746 *
1747 */
1748static psa_status_t psa_validate_key_attributes(
1749 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001751{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001752 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1754 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001755
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 status = psa_validate_key_location(lifetime, p_drv);
1757 if (status != PSA_SUCCESS) {
1758 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001759 }
1760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 status = psa_validate_key_persistence(lifetime);
1762 if (status != PSA_SUCCESS) {
1763 return status;
1764 }
1765
1766 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1767 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1768 return PSA_ERROR_INVALID_ARGUMENT;
1769 }
1770 } else {
1771 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1772 return PSA_ERROR_INVALID_ARGUMENT;
1773 }
1774 }
1775
1776 status = psa_validate_key_policy(&attributes->core.policy);
1777 if (status != PSA_SUCCESS) {
1778 return status;
1779 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001780
1781 /* Refuse to create overly large keys.
1782 * Note that this doesn't trigger on import if the attributes don't
1783 * explicitly specify a size (so psa_get_key_bits returns 0), so
1784 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1786 return PSA_ERROR_NOT_SUPPORTED;
1787 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001788
Gilles Peskine91e8c332019-08-02 19:19:39 +02001789 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001790 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1791 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1792 return PSA_ERROR_INVALID_ARGUMENT;
1793 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001794
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001796}
1797
Gilles Peskine4747d192019-04-17 15:05:45 +02001798/** Prepare a key slot to receive key material.
1799 *
1800 * This function allocates a key slot and sets its metadata.
1801 *
1802 * If this function fails, call psa_fail_key_creation().
1803 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001804 * This function is intended to be used as follows:
1805 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001806 * it with the specified attributes, and in case of a volatile key assign it
1807 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001808 * -# Populate the slot with the key material.
1809 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1810 * In case of failure at any step, stop the sequence and call
1811 * psa_fail_key_creation().
1812 *
Ronald Cron5c522922020-11-14 16:35:34 +01001813 * On success, the key slot is locked. It is the responsibility of the caller
1814 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001815 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001816 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001817 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001818 * \param[out] p_slot On success, a pointer to the prepared slot.
1819 * \param[out] p_drv On any return, the driver for the key, if any.
1820 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001821 *
1822 * \retval #PSA_SUCCESS
1823 * The key slot is ready to receive key material.
1824 * \return If this function fails, the key slot is an invalid state.
1825 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001826 */
1827static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001828 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001829 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001830 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001832{
1833 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001834 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001835 psa_key_slot_t *slot;
1836
Gilles Peskinedf179142019-07-15 22:02:14 +02001837 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001838 *p_drv = NULL;
1839
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 status = psa_validate_key_attributes(attributes, p_drv);
1841 if (status != PSA_SUCCESS) {
1842 return status;
1843 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001844
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1846 if (status != PSA_SUCCESS) {
1847 return status;
1848 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001849 slot = *p_slot;
1850
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001851 /* We're storing the declared bit-size of the key. It's up to each
1852 * creation mechanism to verify that this information is correct.
1853 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001854 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001855 * is optional (import, copy). In case of a volatile key, assign it the
1856 * volatile key identifier associated to the slot returned to contain its
1857 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001858
1859 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001861#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1862 slot->attr.id = volatile_key_id;
1863#else
1864 slot->attr.id.key_id = volatile_key_id;
1865#endif
1866 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001867
Gilles Peskine91e8c332019-08-02 19:19:39 +02001868 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001869 * external-only flags, query `attributes`. Thanks to the check
1870 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001871 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001872 * may have set. */
1873 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001874
Gilles Peskinecbaff462019-07-12 23:46:04 +02001875#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001876 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001877 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001878 * create the key file in internal storage, create the
1879 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001880 * persistent data. This is done by starting a transaction that will
1881 * encompass these three actions.
1882 * For registering a volatile key, we just need to find an appropriate
1883 * slot number inside the SE. Since the key is designated volatile, creating
1884 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001885 /* The first thing to do is to find a slot number for the new key.
1886 * We save the slot number in persistent storage as part of the
1887 * transaction data. It will be needed to recover if the power
1888 * fails during the key creation process, to clean up on the secure
1889 * element side after restarting. Obtaining a slot number from the
1890 * secure element driver updates its persistent state, but we do not yet
1891 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001892 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001893 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001894 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001895 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1896 &slot_number);
1897 if (status != PSA_SUCCESS) {
1898 return status;
1899 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001900
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1902 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001903 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001904 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001905 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001906 status = psa_crypto_save_transaction();
1907 if (status != PSA_SUCCESS) {
1908 (void) psa_crypto_stop_transaction();
1909 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001910 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001911 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001912
1913 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001915 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001916
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001918 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001919 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001920 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001921#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1922
Ryan Everett975d4112023-11-16 13:37:51 +00001923 slot->status = PSA_SLOT_OCCUPIED;
1924
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001926}
Gilles Peskine4747d192019-04-17 15:05:45 +02001927
1928/** Finalize the creation of a key once its key material has been set.
1929 *
1930 * This entails writing the key to persistent storage.
1931 *
1932 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001933 * See the documentation of psa_start_key_creation() for the intended use
1934 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001935 *
Ronald Cron5c522922020-11-14 16:35:34 +01001936 * If the finalization succeeds, the function unlocks the key slot (it was
1937 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1938 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001939 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001940 * \param[in,out] slot Pointer to the slot with key material.
1941 * \param[in] driver The secure element driver for the key,
1942 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001943 * \param[out] key On success, identifier of the key. Note that the
1944 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001945 *
1946 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001947 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001948 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1949 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1950 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1951 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1952 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1953 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001954 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001955 * \return If this function fails, the key slot is an invalid state.
1956 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001957 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001958static psa_status_t psa_finish_key_creation(
1959 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001960 psa_se_drv_table_entry_t *driver,
1961 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001962{
1963 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001964 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001965 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001966
1967#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001969#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001971 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001972 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001974
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001975 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1976 sizeof(data.slot_number),
1977 "Slot number size does not match psa_se_key_data_storage_t");
1978
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1980 status = psa_save_persistent_key(&slot->attr,
1981 (uint8_t *) &data,
1982 sizeof(data));
1983 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001984#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1985 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001986 /* Key material is saved in export representation in the slot, so
1987 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 status = psa_save_persistent_key(&slot->attr,
1989 slot->key.data,
1990 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001991 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001992 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001993#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1994
Gilles Peskinecbaff462019-07-12 23:46:04 +02001995#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001996 /* Finish the transaction for a key creation. This does not
1997 * happen when registering an existing key. Detect this case
1998 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001999 * creation of a persistent key in a secure element requires a transaction,
2000 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 if (driver != NULL &&
2002 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
2003 status = psa_save_se_persistent_data(driver);
2004 if (status != PSA_SUCCESS) {
2005 psa_destroy_persistent_key(slot->attr.id);
2006 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02002007 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02002009 }
2010#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2011
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002013 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 status = psa_unlock_key_slot(slot);
2015 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002016 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002018 }
Ronald Cron50972942020-11-14 11:28:25 +01002019
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002021}
2022
2023/** Abort the creation of a key.
2024 *
2025 * You may call this function after calling psa_start_key_creation(),
2026 * or after psa_finish_key_creation() fails. In other circumstances, this
2027 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002028 * See the documentation of psa_start_key_creation() for the intended use
2029 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002030 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002031 * \param[in,out] slot Pointer to the slot with key material.
2032 * \param[in] driver The secure element driver for the key,
2033 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002034 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002035static void psa_fail_key_creation(psa_key_slot_t *slot,
2036 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02002037{
Gilles Peskine011e4282019-06-26 18:34:38 +02002038 (void) driver;
2039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02002041 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 }
Gilles Peskine011e4282019-06-26 18:34:38 +02002043
2044#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002045 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002046 * element, and the failure happened later (when saving metadata
2047 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002048 * element.
2049 * https://github.com/ARMmbed/mbed-crypto/issues/217
2050 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002051
Gilles Peskined7729582019-08-05 15:55:54 +02002052 /* Abort the ongoing transaction if any (there may not be one if
2053 * the creation process failed before starting one, or if the
2054 * key creation is a registration of a key in a secure element).
2055 * Earlier functions must already have done what it takes to undo any
2056 * partial creation. All that's left is to update the transaction data
2057 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002059#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2060
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02002062}
2063
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002064/** Validate optional attributes during key creation.
2065 *
2066 * Some key attributes are optional during key creation. If they are
2067 * specified in the attributes structure, check that they are consistent
2068 * with the data in the slot.
2069 *
2070 * This function should be called near the end of key creation, after
2071 * the slot in memory is fully populated but before saving persistent data.
2072 */
2073static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002074 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002076{
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 if (attributes->core.type != 0) {
2078 if (attributes->core.type != slot->attr.type) {
2079 return PSA_ERROR_INVALID_ARGUMENT;
2080 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002081 }
2082
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002084#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2085 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2087 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002088 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002089 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002090 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002091
Ronald Cron90857082020-11-25 14:58:33 +01002092 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 slot->attr.type,
2094 slot->key.data,
2095 slot->key.bytes,
2096 &rsa);
2097 if (status != PSA_SUCCESS) {
2098 return status;
2099 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002100
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 mbedtls_mpi_init(&actual);
2102 mbedtls_mpi_init(&required);
2103 ret = mbedtls_rsa_export(rsa,
2104 NULL, NULL, NULL, NULL, &actual);
2105 mbedtls_rsa_free(rsa);
2106 mbedtls_free(rsa);
2107 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002108 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 }
2110 ret = mbedtls_mpi_read_binary(&required,
2111 attributes->domain_parameters,
2112 attributes->domain_parameters_size);
2113 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002114 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002115 }
2116 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002117 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 }
2119rsa_exit:
2120 mbedtls_mpi_free(&actual);
2121 mbedtls_mpi_free(&required);
2122 if (ret != 0) {
2123 return mbedtls_to_psa_error(ret);
2124 }
2125 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002126#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2127 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002128 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002129 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002131 }
2132 }
2133
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 if (attributes->core.bits != 0) {
2135 if (attributes->core.bits != slot->attr.bits) {
2136 return PSA_ERROR_INVALID_ARGUMENT;
2137 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002138 }
2139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002141}
2142
Gilles Peskine449bd832023-01-11 14:50:10 +01002143psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
2144 const uint8_t *data,
2145 size_t data_length,
2146 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002147{
2148 psa_status_t status;
2149 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002150 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002151 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302152 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002153
Ronald Cron81709fc2020-11-14 12:10:32 +01002154 *key = MBEDTLS_SVC_KEY_ID_INIT;
2155
Gilles Peskine0f84d622019-09-12 19:03:13 +02002156 /* Reject zero-length symmetric keys (including raw data key objects).
2157 * This also rejects any key which might be encoded as an empty string,
2158 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 if (data_length == 0) {
2160 return PSA_ERROR_INVALID_ARGUMENT;
2161 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002162
Archana449608b2021-09-08 15:36:05 +05302163 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 if (data_length > SIZE_MAX / 8) {
2165 return PSA_ERROR_NOT_SUPPORTED;
2166 }
Archana6ed4bda2021-08-04 10:47:15 +05302167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2169 &slot, &driver);
2170 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002171 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002173
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002174 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302175 * storage ( thus not in the case of importing a key in a secure element
2176 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2177 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 if (slot->key.data == NULL) {
2179 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302180 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 attributes, data, data_length, &storage_size);
2182 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302183 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 }
Archanad8a83dc2021-06-14 10:04:16 +05302185 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 status = psa_allocate_buffer_to_slot(slot, storage_size);
2187 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002188 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002190 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002191
2192 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 status = psa_driver_wrapper_import_key(attributes,
2194 data, data_length,
2195 slot->key.data,
2196 slot->key.bytes,
2197 &slot->key.bytes, &bits);
2198 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002199 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002203 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002205 status = PSA_ERROR_INVALID_ARGUMENT;
2206 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002207 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002208
Archana6ed4bda2021-08-04 10:47:15 +05302209 /* Enforce a size limit, and in particular ensure that the bit
2210 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302212 status = PSA_ERROR_NOT_SUPPORTED;
2213 goto exit;
2214 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 status = psa_validate_optional_attributes(slot, attributes);
2216 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002217 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002219
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002221exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 if (status != PSA_SUCCESS) {
2223 psa_fail_key_creation(slot, driver);
2224 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002227}
2228
Gilles Peskined7729582019-08-05 15:55:54 +02002229#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2230psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002232{
2233 psa_status_t status;
2234 psa_key_slot_t *slot = NULL;
2235 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002236 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002237
2238 /* Leaving attributes unspecified is not currently supported.
2239 * It could make sense to query the key type and size from the
2240 * secure element, but not all secure elements support this
2241 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2243 return PSA_ERROR_NOT_SUPPORTED;
2244 }
2245 if (psa_get_key_bits(attributes) == 0) {
2246 return PSA_ERROR_NOT_SUPPORTED;
2247 }
Gilles Peskined7729582019-08-05 15:55:54 +02002248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2250 &slot, &driver);
2251 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002252 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 }
Gilles Peskined7729582019-08-05 15:55:54 +02002254
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002256
2257exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 if (status != PSA_SUCCESS) {
2259 psa_fail_key_creation(slot, driver);
2260 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002261
Gilles Peskined7729582019-08-05 15:55:54 +02002262 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 psa_close_key(key);
2264 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002265}
2266#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2269 const psa_key_attributes_t *specified_attributes,
2270 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002271{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002272 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002273 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002274 psa_key_slot_t *source_slot = NULL;
2275 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002276 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002277 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302278 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002279
Ronald Cron81709fc2020-11-14 12:10:32 +01002280 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2281
Archana8a180362021-07-05 02:18:48 +05302282 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2284 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002285 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 status = psa_validate_optional_attributes(source_slot,
2289 specified_attributes);
2290 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002291 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002293
Archana9d17bf42021-09-10 06:22:44 +05302294 /* The target key type and number of bits have been validated by
2295 * psa_validate_optional_attributes() to be either equal to zero or
2296 * equal to the ones of the source key. So it is safe to inherit
2297 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302298 * */
Archana9d17bf42021-09-10 06:22:44 +05302299 actual_attributes.core.bits = source_slot->attr.bits;
2300 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302301
2302
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 status = psa_restrict_key_policy(source_slot->attr.type,
2304 &actual_attributes.core.policy,
2305 &source_slot->attr.policy);
2306 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002307 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2311 &target_slot, &driver);
2312 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002313 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 }
2315 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2316 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302317 /*
Archana9d17bf42021-09-10 06:22:44 +05302318 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302319 * the source key would need to be exported as plaintext and re-imported
2320 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302321 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302322 * appropriate API invocations from the application, if needed.
2323 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002324 status = PSA_ERROR_NOT_SUPPORTED;
2325 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002326 }
Archana8a180362021-07-05 02:18:48 +05302327 /*
2328 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302329 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302330 * - For opaque keys this translates to an invocation of the drivers'
2331 * copy_key entry point through the dispatch layer.
2332 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2334 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2335 &storage_size);
2336 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302337 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 }
Archana374fe5b2021-09-08 15:50:28 +05302339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2341 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302342 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 }
Archana374fe5b2021-09-08 15:50:28 +05302344
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 status = psa_driver_wrapper_copy_key(&actual_attributes,
2346 source_slot->key.data,
2347 source_slot->key.bytes,
2348 target_slot->key.data,
2349 target_slot->key.bytes,
2350 &target_slot->key.bytes);
2351 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302352 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 }
2354 } else {
2355 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302356 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 source_slot->key.bytes);
2358 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302359 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 }
Archana8a180362021-07-05 02:18:48 +05302361 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002363exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 if (status != PSA_SUCCESS) {
2365 psa_fail_key_creation(target_slot, driver);
2366 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002369
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002371}
2372
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002373
2374
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002375/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002376/* Message digests */
2377/****************************************************************/
2378
Gilles Peskine449bd832023-01-11 14:50:10 +01002379psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002380{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002381 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 if (operation->id == 0) {
2383 return PSA_SUCCESS;
2384 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002385
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002387 operation->id = 0;
2388
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002390}
2391
Gilles Peskine449bd832023-01-11 14:50:10 +01002392psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2393 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002394{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002395 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002396
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002397 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002399 status = PSA_ERROR_BAD_STATE;
2400 goto exit;
2401 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002404 status = PSA_ERROR_INVALID_ARGUMENT;
2405 goto exit;
2406 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002407
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002408 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2409 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002411
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002413
2414exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 if (status != PSA_SUCCESS) {
2416 psa_hash_abort(operation);
2417 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002418
2419 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002420}
2421
Gilles Peskine449bd832023-01-11 14:50:10 +01002422psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2423 const uint8_t *input,
2424 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002425{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002426 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2427
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002429 status = PSA_ERROR_BAD_STATE;
2430 goto exit;
2431 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002432
Steven Cooremanc8288352021-03-04 14:02:19 +01002433 /* Don't require hash implementations to behave correctly on a
2434 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 if (input_length == 0) {
2436 return PSA_SUCCESS;
2437 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002438
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002440
2441exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 if (status != PSA_SUCCESS) {
2443 psa_hash_abort(operation);
2444 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002445
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002447}
2448
Gilles Peskine449bd832023-01-11 14:50:10 +01002449psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2450 uint8_t *hash,
2451 size_t hash_size,
2452 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002453{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002454 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 if (operation->id == 0) {
2456 return PSA_ERROR_BAD_STATE;
2457 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002458
Steven Cooreman1e582352021-02-18 17:24:37 +01002459 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002460 operation, hash, hash_size, hash_length);
2461 psa_hash_abort(operation);
2462 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002463}
2464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2466 const uint8_t *hash,
2467 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002468{
Ronald Cron69a63422021-10-18 09:47:58 +02002469 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002470 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002471 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 operation,
2473 actual_hash, sizeof(actual_hash),
2474 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002475
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002477 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002481 status = PSA_ERROR_INVALID_SIGNATURE;
2482 goto exit;
2483 }
2484
Dave Rodgman78701152023-08-29 14:20:18 +01002485 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002486 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002488
2489exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002490 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2491 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002492 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002494
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002496}
2497
Gilles Peskine449bd832023-01-11 14:50:10 +01002498psa_status_t psa_hash_compute(psa_algorithm_t alg,
2499 const uint8_t *input, size_t input_length,
2500 uint8_t *hash, size_t hash_size,
2501 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002502{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002503 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 if (!PSA_ALG_IS_HASH(alg)) {
2505 return PSA_ERROR_INVALID_ARGUMENT;
2506 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002507
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2509 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002510}
2511
Gilles Peskine449bd832023-01-11 14:50:10 +01002512psa_status_t psa_hash_compare(psa_algorithm_t alg,
2513 const uint8_t *input, size_t input_length,
2514 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002515{
Ronald Cron69a63422021-10-18 09:47:58 +02002516 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002517 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002518
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 if (!PSA_ALG_IS_HASH(alg)) {
2520 return PSA_ERROR_INVALID_ARGUMENT;
2521 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002522
Steven Cooreman1e582352021-02-18 17:24:37 +01002523 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 alg, input, input_length,
2525 actual_hash, sizeof(actual_hash),
2526 &actual_hash_length);
2527 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002528 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 }
2530 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002531 status = PSA_ERROR_INVALID_SIGNATURE;
2532 goto exit;
2533 }
Dave Rodgman78701152023-08-29 14:20:18 +01002534 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002535 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002537
2538exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2540 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002541}
2542
Gilles Peskine449bd832023-01-11 14:50:10 +01002543psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2544 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002545{
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 if (source_operation->id == 0 ||
2547 target_operation->id != 0) {
2548 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002549 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2552 target_operation);
2553 if (status != PSA_SUCCESS) {
2554 psa_hash_abort(target_operation);
2555 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002558}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002559
2560
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002561/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002562/* MAC */
2563/****************************************************************/
2564
Gilles Peskine449bd832023-01-11 14:50:10 +01002565psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002566{
Steven Cooremane6804192021-03-19 18:28:56 +01002567 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 if (operation->id == 0) {
2569 return PSA_SUCCESS;
2570 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002573 operation->mac_size = 0;
2574 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002575 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002578}
2579
Ronald Cron2dff3b22021-06-17 16:33:22 +02002580static psa_status_t psa_mac_finalize_alg_and_key_validation(
2581 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002582 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002584{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002585 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 psa_key_type_t key_type = psa_get_key_type(attributes);
2587 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 if (!PSA_ALG_IS_MAC(alg)) {
2590 return PSA_ERROR_INVALID_ARGUMENT;
2591 }
Steven Cooremane6804192021-03-19 18:28:56 +01002592
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002593 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 status = psa_mac_key_can_do(alg, key_type);
2595 if (status != PSA_SUCCESS) {
2596 return status;
2597 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002598
Steven Cooremand1a68f12021-05-10 11:13:41 +02002599 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002601
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002603 /* A very short MAC is too short for security since it can be
2604 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2605 * so we make this our minimum, even though 32 bits is still
2606 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002608 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002609
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2611 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002612 /* It's impossible to "truncate" to a larger length than the full length
2613 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002615 }
2616
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002618 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2619 * that is disabled in the compile-time configuration. The result can
2620 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2621 * configuration into account. In this case, force a return of
2622 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2623 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2624 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2625 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2626 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002628 }
2629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002631}
2632
Gilles Peskine449bd832023-01-11 14:50:10 +01002633static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2634 mbedtls_svc_key_id_t key,
2635 psa_algorithm_t alg,
2636 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002637{
2638 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2639 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002640 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002641 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002642
2643 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002645 status = PSA_ERROR_BAD_STATE;
2646 goto exit;
2647 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002648
2649 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 key,
2651 &slot,
2652 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2653 alg);
2654 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002655 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002657
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002658 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002659 .core = slot->attr
2660 };
2661
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2663 &operation->mac_size);
2664 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002665 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002667
2668 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002669 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 if (is_sign) {
2671 status = psa_driver_wrapper_mac_sign_setup(operation,
2672 &attributes,
2673 slot->key.data,
2674 slot->key.bytes,
2675 alg);
2676 } else {
2677 status = psa_driver_wrapper_mac_verify_setup(operation,
2678 &attributes,
2679 slot->key.data,
2680 slot->key.bytes,
2681 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002682 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002683
Gilles Peskinefbfac682018-07-08 20:51:54 +02002684exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 if (status != PSA_SUCCESS) {
2686 psa_mac_abort(operation);
2687 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002688
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002690
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002692}
2693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2695 mbedtls_svc_key_id_t key,
2696 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002697{
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002699}
2700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2702 mbedtls_svc_key_id_t key,
2703 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002704{
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002706}
2707
Gilles Peskine449bd832023-01-11 14:50:10 +01002708psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2709 const uint8_t *input,
2710 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002711{
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 if (operation->id == 0) {
2713 return PSA_ERROR_BAD_STATE;
2714 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002715
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002716 /* Don't require hash implementations to behave correctly on a
2717 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 if (input_length == 0) {
2719 return PSA_SUCCESS;
2720 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002721
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2723 input, input_length);
2724 if (status != PSA_SUCCESS) {
2725 psa_mac_abort(operation);
2726 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002727
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002729}
2730
Gilles Peskine449bd832023-01-11 14:50:10 +01002731psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2732 uint8_t *mac,
2733 size_t mac_size,
2734 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002735{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002736 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2737 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002738
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002740 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002741 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002742 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002743
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002745 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002746 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002747 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002748
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002749 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2750 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002752 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002753 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002754 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002755
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002757 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002758 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002759 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 status = psa_driver_wrapper_mac_sign_finish(operation,
2762 mac, operation->mac_size,
2763 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002764
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002765exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002766 /* In case of success, set the potential excess room in the output buffer
2767 * to an invalid value, to avoid potentially leaking a longer MAC.
2768 * In case of error, set the output length and content to a safe default,
2769 * such that in case the caller misses an error check, the output would be
2770 * an unachievable MAC.
2771 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002772 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002773 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002774 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002775 }
mohammad16036df908f2018-04-02 08:34:15 -07002776
Paul Elliottdc42ca82023-02-24 18:11:59 +00002777 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002778
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002782}
2783
Gilles Peskine449bd832023-01-11 14:50:10 +01002784psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2785 const uint8_t *mac,
2786 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002787{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002788 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2789 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002792 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002793 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002794 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002795
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002797 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002798 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002799 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002802 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002803 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002804 }
2805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 status = psa_driver_wrapper_mac_verify_finish(operation,
2807 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002808
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002809exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002811
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002813}
2814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2816 psa_algorithm_t alg,
2817 const uint8_t *input,
2818 size_t input_length,
2819 uint8_t *mac,
2820 size_t mac_size,
2821 size_t *mac_length,
2822 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002823{
2824 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002825 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2826 psa_key_slot_t *slot;
2827 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002828 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002829
Ronald Cron51131b52021-06-17 17:17:20 +02002830 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 key,
2832 &slot,
2833 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2834 alg);
2835 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002836 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002838
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002839 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002840 .core = slot->attr
2841 };
2842
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2844 &operation_mac_size);
2845 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002846 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002848
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002850 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002851 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002852 }
2853
2854 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 &attributes,
2856 slot->key.data, slot->key.bytes,
2857 alg,
2858 input, input_length,
2859 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002860
2861exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002862 /* In case of success, set the potential excess room in the output buffer
2863 * to an invalid value, to avoid potentially leaking a longer MAC.
2864 * In case of error, set the output length and content to a safe default,
2865 * such that in case the caller misses an error check, the output would be
2866 * an unachievable MAC.
2867 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002869 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002870 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002871 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002872
2873 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002878}
2879
Gilles Peskine449bd832023-01-11 14:50:10 +01002880psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002881 psa_algorithm_t alg,
2882 const uint8_t *input,
2883 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 uint8_t *mac,
2885 size_t mac_size,
2886 size_t *mac_length)
2887{
2888 return psa_mac_compute_internal(key, alg,
2889 input, input_length,
2890 mac, mac_size, mac_length, 1);
2891}
2892
2893psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2894 psa_algorithm_t alg,
2895 const uint8_t *input,
2896 size_t input_length,
2897 const uint8_t *mac,
2898 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002899{
2900 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002901 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2902 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002903
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 status = psa_mac_compute_internal(key, alg,
2905 input, input_length,
2906 actual_mac, sizeof(actual_mac),
2907 &actual_mac_length, 0);
2908 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002909 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002913 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002914 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002915 }
Dave Rodgman78701152023-08-29 14:20:18 +01002916 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002917 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002918 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002919 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002920
2921exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002925}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002926
Gilles Peskinee59236f2018-01-27 23:32:46 +01002927/****************************************************************/
2928/* Asymmetric cryptography */
2929/****************************************************************/
2930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2932 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002933{
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 if (input_is_message) {
2935 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2936 return PSA_ERROR_INVALID_ARGUMENT;
2937 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002938
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2940 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2941 return PSA_ERROR_INVALID_ARGUMENT;
2942 }
2943 }
2944 } else {
2945 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2946 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002947 }
2948 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002949
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002951}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002952
Gilles Peskine449bd832023-01-11 14:50:10 +01002953static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2954 int input_is_message,
2955 psa_algorithm_t alg,
2956 const uint8_t *input,
2957 size_t input_length,
2958 uint8_t *signature,
2959 size_t signature_size,
2960 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002961{
2962 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2963 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2964 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002965 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002966
2967 *signature_length = 0;
2968
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 status = psa_sign_verify_check_alg(input_is_message, alg);
2970 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002971 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002973
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002974 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002975 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002976 * buffer can in principle be empty since it doesn't actually have
2977 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 if (signature_size == 0) {
2979 return PSA_ERROR_BUFFER_TOO_SMALL;
2980 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002981
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002982 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 key, &slot,
2984 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2985 PSA_KEY_USAGE_SIGN_HASH,
2986 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002987
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002989 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002993 status = PSA_ERROR_INVALID_ARGUMENT;
2994 goto exit;
2995 }
2996
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002997 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002999 };
3000
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003002 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003003 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003004 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 signature, signature_size, signature_length);
3006 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003007
3008 status = psa_driver_wrapper_sign_hash(
3009 &attributes, slot->key.data, slot->key.bytes,
3010 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003012 }
3013
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003014
3015exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003016 psa_wipe_tag_output_buffer(signature, status, signature_size,
3017 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003020
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003022}
3023
Gilles Peskine449bd832023-01-11 14:50:10 +01003024static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3025 int input_is_message,
3026 psa_algorithm_t alg,
3027 const uint8_t *input,
3028 size_t input_length,
3029 const uint8_t *signature,
3030 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003031{
3032 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3033 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3034 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003035
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 status = psa_sign_verify_check_alg(input_is_message, alg);
3037 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003038 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003040
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003041 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 key, &slot,
3043 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3044 PSA_KEY_USAGE_VERIFY_HASH,
3045 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003046
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 if (status != PSA_SUCCESS) {
3048 return status;
3049 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003050
3051 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003053 };
3054
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003056 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003057 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003058 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 signature, signature_length);
3060 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003061 status = psa_driver_wrapper_verify_hash(
3062 &attributes, slot->key.data, slot->key.bytes,
3063 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003065 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003066
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003068
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003070
3071}
3072
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003073psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003074 const psa_key_attributes_t *attributes,
3075 const uint8_t *key_buffer,
3076 size_t key_buffer_size,
3077 psa_algorithm_t alg,
3078 const uint8_t *input,
3079 size_t input_length,
3080 uint8_t *signature,
3081 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003083{
3084 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003085
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003087 size_t hash_length;
3088 uint8_t hash[PSA_HASH_MAX_SIZE];
3089
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003090 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 PSA_ALG_SIGN_GET_HASH(alg),
3092 input, input_length,
3093 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003094
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003096 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003098
3099 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 attributes, key_buffer, key_buffer_size,
3101 alg, hash, hash_length,
3102 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003103 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003104
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003106}
3107
Gilles Peskine449bd832023-01-11 14:50:10 +01003108psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3109 psa_algorithm_t alg,
3110 const uint8_t *input,
3111 size_t input_length,
3112 uint8_t *signature,
3113 size_t signature_size,
3114 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003115{
3116 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003117 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003119}
3120
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003121psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003122 const psa_key_attributes_t *attributes,
3123 const uint8_t *key_buffer,
3124 size_t key_buffer_size,
3125 psa_algorithm_t alg,
3126 const uint8_t *input,
3127 size_t input_length,
3128 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003130{
3131 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003132
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003134 size_t hash_length;
3135 uint8_t hash[PSA_HASH_MAX_SIZE];
3136
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003137 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 PSA_ALG_SIGN_GET_HASH(alg),
3139 input, input_length,
3140 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003141
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003143 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003145
3146 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 attributes, key_buffer, key_buffer_size,
3148 alg, hash, hash_length,
3149 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003150 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003151
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003153}
3154
Gilles Peskine449bd832023-01-11 14:50:10 +01003155psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3156 psa_algorithm_t alg,
3157 const uint8_t *input,
3158 size_t input_length,
3159 const uint8_t *signature,
3160 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003161{
3162 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003163 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003165}
3166
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003167psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003168 const psa_key_attributes_t *attributes,
3169 const uint8_t *key_buffer, size_t key_buffer_size,
3170 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003172{
Gilles Peskine449bd832023-01-11 14:50:10 +01003173 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3174 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3175 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003176#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3178 return mbedtls_psa_rsa_sign_hash(
3179 attributes,
3180 key_buffer, key_buffer_size,
3181 alg, hash, hash_length,
3182 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003183#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3184 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003185 } else {
3186 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003187 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003188 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3189 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003190#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003191 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3192 return mbedtls_psa_ecdsa_sign_hash(
3193 attributes,
3194 key_buffer, key_buffer_size,
3195 alg, hash, hash_length,
3196 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003197#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3198 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 } else {
3200 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003201 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003202 }
Ronald Cron4501c982021-03-19 20:09:32 +01003203
Gilles Peskine449bd832023-01-11 14:50:10 +01003204 (void) key_buffer;
3205 (void) key_buffer_size;
3206 (void) hash;
3207 (void) hash_length;
3208 (void) signature;
3209 (void) signature_size;
3210 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003211
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003213}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003214
Gilles Peskine449bd832023-01-11 14:50:10 +01003215psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3216 psa_algorithm_t alg,
3217 const uint8_t *hash,
3218 size_t hash_length,
3219 uint8_t *signature,
3220 size_t signature_size,
3221 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003222{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003223 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003224 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003225 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003226}
3227
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003228psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003229 const psa_key_attributes_t *attributes,
3230 const uint8_t *key_buffer, size_t key_buffer_size,
3231 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003233{
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3235 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3236 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003237#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3239 return mbedtls_psa_rsa_verify_hash(
3240 attributes,
3241 key_buffer, key_buffer_size,
3242 alg, hash, hash_length,
3243 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003244#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3245 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 } else {
3247 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003248 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003249 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3250 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003251#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3253 return mbedtls_psa_ecdsa_verify_hash(
3254 attributes,
3255 key_buffer, key_buffer_size,
3256 alg, hash, hash_length,
3257 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003258#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3259 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003260 } else {
3261 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003262 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003263 }
Ronald Cron4501c982021-03-19 20:09:32 +01003264
Gilles Peskine449bd832023-01-11 14:50:10 +01003265 (void) key_buffer;
3266 (void) key_buffer_size;
3267 (void) hash;
3268 (void) hash_length;
3269 (void) signature;
3270 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003271
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003273}
3274
Gilles Peskine449bd832023-01-11 14:50:10 +01003275psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3276 psa_algorithm_t alg,
3277 const uint8_t *hash,
3278 size_t hash_length,
3279 const uint8_t *signature,
3280 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003281{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003282 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003283 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003284 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003285}
3286
Gilles Peskine449bd832023-01-11 14:50:10 +01003287psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3288 psa_algorithm_t alg,
3289 const uint8_t *input,
3290 size_t input_length,
3291 const uint8_t *salt,
3292 size_t salt_length,
3293 uint8_t *output,
3294 size_t output_size,
3295 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003296{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003297 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003298 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003299 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003300 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003301
Darryl Green5cc689a2018-07-24 15:34:10 +01003302 (void) input;
3303 (void) input_length;
3304 (void) salt;
3305 (void) output;
3306 (void) output_size;
3307
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003308 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003309
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3311 return PSA_ERROR_INVALID_ARGUMENT;
3312 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003313
Ronald Cron5c522922020-11-14 16:35:34 +01003314 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3316 if (status != PSA_SUCCESS) {
3317 return status;
3318 }
3319 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3320 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003321 status = PSA_ERROR_INVALID_ARGUMENT;
3322 goto exit;
3323 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003324
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003325 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003327 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003328
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003329 status = psa_driver_wrapper_asymmetric_encrypt(
3330 &attributes, slot->key.data, slot->key.bytes,
3331 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003333exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003334 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003335
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003337}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003338
Gilles Peskine449bd832023-01-11 14:50:10 +01003339psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3340 psa_algorithm_t alg,
3341 const uint8_t *input,
3342 size_t input_length,
3343 const uint8_t *salt,
3344 size_t salt_length,
3345 uint8_t *output,
3346 size_t output_size,
3347 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003348{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003349 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003350 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003351 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003352 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003353
Darryl Green5cc689a2018-07-24 15:34:10 +01003354 (void) input;
3355 (void) input_length;
3356 (void) salt;
3357 (void) output;
3358 (void) output_size;
3359
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003360 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003361
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3363 return PSA_ERROR_INVALID_ARGUMENT;
3364 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003365
Ronald Cron5c522922020-11-14 16:35:34 +01003366 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3368 if (status != PSA_SUCCESS) {
3369 return status;
3370 }
3371 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003372 status = PSA_ERROR_INVALID_ARGUMENT;
3373 goto exit;
3374 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003375
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003376 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003377 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003378 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003379
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003380 status = psa_driver_wrapper_asymmetric_decrypt(
3381 &attributes, slot->key.data, slot->key.bytes,
3382 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003383 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003384
3385exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003387
Gilles Peskine449bd832023-01-11 14:50:10 +01003388 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003389}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003390
Paul Elliott9fe12f62022-11-30 19:16:02 +00003391/****************************************************************/
3392/* Asymmetric interruptible cryptography */
3393/****************************************************************/
3394
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003395static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3396
Paul Elliott9fe12f62022-11-30 19:16:02 +00003397void psa_interruptible_set_max_ops(uint32_t max_ops)
3398{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003399 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003400}
3401
3402uint32_t psa_interruptible_get_max_ops(void)
3403{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003404 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003405}
3406
Paul Elliott9fe12f62022-11-30 19:16:02 +00003407uint32_t psa_sign_hash_get_num_ops(
3408 const psa_sign_hash_interruptible_operation_t *operation)
3409{
Paul Elliott296ede92022-12-15 17:00:30 +00003410 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003411}
3412
3413uint32_t psa_verify_hash_get_num_ops(
3414 const psa_verify_hash_interruptible_operation_t *operation)
3415{
Paul Elliott296ede92022-12-15 17:00:30 +00003416 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003417}
3418
Paul Elliott59ad9452022-12-18 15:09:02 +00003419static psa_status_t psa_sign_hash_abort_internal(
3420 psa_sign_hash_interruptible_operation_t *operation)
3421{
3422 if (operation->id == 0) {
3423 /* The object has (apparently) been initialized but it is not (yet)
3424 * in use. It's ok to call abort on such an object, and there's
3425 * nothing to do. */
3426 return PSA_SUCCESS;
3427 }
3428
3429 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3430
3431 status = psa_driver_wrapper_sign_hash_abort(operation);
3432
3433 operation->id = 0;
3434
Paul Elliotte6145dc2023-02-07 12:51:21 +00003435 /* Do not clear either the error_occurred or num_ops elements here as they
3436 * only want to be cleared by the application calling abort, not by abort
3437 * being called at completion of an operation. */
3438
Paul Elliott59ad9452022-12-18 15:09:02 +00003439 return status;
3440}
3441
Paul Elliott9fe12f62022-11-30 19:16:02 +00003442psa_status_t psa_sign_hash_start(
3443 psa_sign_hash_interruptible_operation_t *operation,
3444 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3445 const uint8_t *hash, size_t hash_length)
3446{
3447 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3448 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3449 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003450 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003451
Paul Elliottc9774412023-02-06 15:14:07 +00003452 /* Check that start has not been previously called, or operation has not
3453 * previously errored. */
3454 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003455 return PSA_ERROR_BAD_STATE;
3456 }
3457
Paul Elliott9fe12f62022-11-30 19:16:02 +00003458 status = psa_sign_verify_check_alg(0, alg);
3459 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003460 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003461 return status;
3462 }
3463
3464 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3465 PSA_KEY_USAGE_SIGN_HASH,
3466 alg);
3467
3468 if (status != PSA_SUCCESS) {
3469 goto exit;
3470 }
3471
3472 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3473 status = PSA_ERROR_INVALID_ARGUMENT;
3474 goto exit;
3475 }
3476
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003477 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003478 .core = slot->attr
3479 };
3480
Paul Elliott296ede92022-12-15 17:00:30 +00003481 /* Ensure ops count gets reset, in case of operation re-use. */
3482 operation->num_ops = 0;
3483
Paul Elliott9fe12f62022-11-30 19:16:02 +00003484 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3485 slot->key.data,
3486 slot->key.bytes, alg,
3487 hash, hash_length);
3488exit:
3489
3490 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003491 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003492 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003493 }
3494
3495 unlock_status = psa_unlock_key_slot(slot);
3496
Paul Elliottc9774412023-02-06 15:14:07 +00003497 if (unlock_status != PSA_SUCCESS) {
3498 operation->error_occurred = 1;
3499 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003500
Paul Elliottc9774412023-02-06 15:14:07 +00003501 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003502}
3503
3504
3505psa_status_t psa_sign_hash_complete(
3506 psa_sign_hash_interruptible_operation_t *operation,
3507 uint8_t *signature, size_t signature_size,
3508 size_t *signature_length)
3509{
3510 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3511
3512 *signature_length = 0;
3513
Paul Elliottc9774412023-02-06 15:14:07 +00003514 /* Check that start has been called first, and that operation has not
3515 * previously errored. */
3516 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003517 status = PSA_ERROR_BAD_STATE;
3518 goto exit;
3519 }
3520
Paul Elliott096abc42023-02-03 18:33:23 +00003521 /* Immediately reject a zero-length signature buffer. This guarantees that
3522 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003523 if (signature_size == 0) {
3524 status = PSA_ERROR_BUFFER_TOO_SMALL;
3525 goto exit;
3526 }
3527
3528 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3529 signature_size,
3530 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003531
Paul Elliott296ede92022-12-15 17:00:30 +00003532 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003533 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003534
Paul Elliottebe225c2023-02-10 14:32:53 +00003535exit:
3536
Paul Elliott59200a22023-02-21 15:07:40 +00003537 psa_wipe_tag_output_buffer(signature, status, signature_size,
3538 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003539
Paul Elliott53bb3122023-02-10 14:22:22 +00003540 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003541 if (status != PSA_SUCCESS) {
3542 operation->error_occurred = 1;
3543 }
3544
Paul Elliott59ad9452022-12-18 15:09:02 +00003545 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003546 }
3547
3548 return status;
3549}
3550
3551psa_status_t psa_sign_hash_abort(
3552 psa_sign_hash_interruptible_operation_t *operation)
3553{
Paul Elliott59ad9452022-12-18 15:09:02 +00003554 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3555
3556 status = psa_sign_hash_abort_internal(operation);
3557
3558 /* We clear the number of ops done here, so that it is not cleared when
3559 * the operation fails or succeeds, only on manual abort. */
3560 operation->num_ops = 0;
3561
Paul Elliottc9774412023-02-06 15:14:07 +00003562 /* Likewise, failure state. */
3563 operation->error_occurred = 0;
3564
Paul Elliott59ad9452022-12-18 15:09:02 +00003565 return status;
3566}
3567
3568static psa_status_t psa_verify_hash_abort_internal(
3569 psa_verify_hash_interruptible_operation_t *operation)
3570{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003571 if (operation->id == 0) {
3572 /* The object has (apparently) been initialized but it is not (yet)
3573 * in use. It's ok to call abort on such an object, and there's
3574 * nothing to do. */
3575 return PSA_SUCCESS;
3576 }
3577
Paul Elliott59ad9452022-12-18 15:09:02 +00003578 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3579
3580 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003581
3582 operation->id = 0;
3583
Paul Elliotte6145dc2023-02-07 12:51:21 +00003584 /* Do not clear either the error_occurred or num_ops elements here as they
3585 * only want to be cleared by the application calling abort, not by abort
3586 * being called at completion of an operation. */
3587
Paul Elliott59ad9452022-12-18 15:09:02 +00003588 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003589}
3590
3591psa_status_t psa_verify_hash_start(
3592 psa_verify_hash_interruptible_operation_t *operation,
3593 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3594 const uint8_t *hash, size_t hash_length,
3595 const uint8_t *signature, size_t signature_length)
3596{
3597 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3598 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3599 psa_key_slot_t *slot;
3600
Paul Elliottc9774412023-02-06 15:14:07 +00003601 /* Check that start has not been previously called, or operation has not
3602 * previously errored. */
3603 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003604 return PSA_ERROR_BAD_STATE;
3605 }
3606
3607 status = psa_sign_verify_check_alg(0, alg);
3608 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003609 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003610 return status;
3611 }
3612
3613 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3614 PSA_KEY_USAGE_VERIFY_HASH,
3615 alg);
3616
3617 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003618 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003619 return status;
3620 }
3621
3622 psa_key_attributes_t attributes = {
3623 .core = slot->attr
3624 };
3625
Paul Elliott296ede92022-12-15 17:00:30 +00003626 /* Ensure ops count gets reset, in case of operation re-use. */
3627 operation->num_ops = 0;
3628
Paul Elliott9fe12f62022-11-30 19:16:02 +00003629 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3630 slot->key.data,
3631 slot->key.bytes,
3632 alg, hash, hash_length,
3633 signature, signature_length);
3634
3635 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003636 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003637 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003638 }
3639
3640 unlock_status = psa_unlock_key_slot(slot);
3641
Paul Elliottc9774412023-02-06 15:14:07 +00003642 if (unlock_status != PSA_SUCCESS) {
3643 operation->error_occurred = 1;
3644 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003645
Paul Elliottc9774412023-02-06 15:14:07 +00003646 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003647}
3648
3649psa_status_t psa_verify_hash_complete(
3650 psa_verify_hash_interruptible_operation_t *operation)
3651{
3652 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3653
Paul Elliottc9774412023-02-06 15:14:07 +00003654 /* Check that start has been called first, and that operation has not
3655 * previously errored. */
3656 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003657 status = PSA_ERROR_BAD_STATE;
3658 goto exit;
3659 }
3660
3661 status = psa_driver_wrapper_verify_hash_complete(operation);
3662
Paul Elliott296ede92022-12-15 17:00:30 +00003663 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003664 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003665 operation);
3666
Paul Elliottebe225c2023-02-10 14:32:53 +00003667exit:
3668
Paul Elliott9fe12f62022-11-30 19:16:02 +00003669 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003670 if (status != PSA_SUCCESS) {
3671 operation->error_occurred = 1;
3672 }
3673
Paul Elliott59ad9452022-12-18 15:09:02 +00003674 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003675 }
3676
3677 return status;
3678}
3679
3680psa_status_t psa_verify_hash_abort(
3681 psa_verify_hash_interruptible_operation_t *operation)
3682{
Paul Elliott59ad9452022-12-18 15:09:02 +00003683 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003684
Paul Elliott59ad9452022-12-18 15:09:02 +00003685 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003686
Paul Elliott59ad9452022-12-18 15:09:02 +00003687 /* We clear the number of ops done here, so that it is not cleared when
3688 * the operation fails or succeeds, only on manual abort. */
3689 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003690
Paul Elliottc9774412023-02-06 15:14:07 +00003691 /* Likewise, failure state. */
3692 operation->error_occurred = 0;
3693
Paul Elliott59ad9452022-12-18 15:09:02 +00003694 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003695}
3696
Paul Elliott588f8ed2022-12-02 18:10:26 +00003697/****************************************************************/
3698/* Asymmetric interruptible cryptography internal */
3699/* implementations */
3700/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003701
Paul Elliott588f8ed2022-12-02 18:10:26 +00003702void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3703{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003704
Paul Elliott588f8ed2022-12-02 18:10:26 +00003705#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3706 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3707 defined(MBEDTLS_ECP_RESTARTABLE)
3708
3709 /* Internal implementation uses zero to indicate infinite number max ops,
3710 * therefore avoid this value, and set to minimum possible. */
3711 if (max_ops == 0) {
3712 max_ops = 1;
3713 }
3714
Paul Elliott588f8ed2022-12-02 18:10:26 +00003715 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003716#else
3717 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003718#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3719 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3720 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3721}
3722
Paul Elliott588f8ed2022-12-02 18:10:26 +00003723uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003724 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003725{
3726#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3727 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3728 defined(MBEDTLS_ECP_RESTARTABLE)
3729
Paul Elliott93d9ca82023-02-15 18:14:21 +00003730 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003731#else
3732 (void) operation;
3733 return 0;
3734#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3735 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3736 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3737}
3738
3739uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003740 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003741{
3742 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3743 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3744 defined(MBEDTLS_ECP_RESTARTABLE)
3745
Paul Elliott93d9ca82023-02-15 18:14:21 +00003746 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003747#else
3748 (void) operation;
3749 return 0;
3750#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3751 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3752 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3753}
3754
3755psa_status_t mbedtls_psa_sign_hash_start(
3756 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3757 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3758 size_t key_buffer_size, psa_algorithm_t alg,
3759 const uint8_t *hash, size_t hash_length)
3760{
3761 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003762 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003763
Paul Elliott068fe072023-01-16 13:59:15 +00003764 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3765 return PSA_ERROR_NOT_SUPPORTED;
3766 }
3767
3768 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003769 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003770 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003771
3772#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003773 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3774 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003775
Paul Elliotta1c94092023-02-15 16:38:04 +00003776 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3777
Paul Elliott93d9ca82023-02-15 18:14:21 +00003778 /* Ensure num_ops is zero'ed in case of context re-use. */
3779 operation->num_ops = 0;
3780
Paul Elliott068fe072023-01-16 13:59:15 +00003781 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3782 attributes->core.bits,
3783 key_buffer,
3784 key_buffer_size,
3785 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003786
Paul Elliott068fe072023-01-16 13:59:15 +00003787 if (status != PSA_SUCCESS) {
3788 return status;
3789 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003790
Paul Elliott1bc59df2023-02-05 13:41:57 +00003791 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003792 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003793
Paul Elliott068fe072023-01-16 13:59:15 +00003794 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003795 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003796 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003797
Paul Elliott0290a762023-02-09 14:30:24 +00003798 /* We only need to store the same length of hash as the private key size
3799 * here, it would be truncated by the internal implementation anyway. */
3800 required_hash_length = (hash_length < operation->coordinate_bytes ?
3801 hash_length : operation->coordinate_bytes);
3802
Paul Elliottba70ad42023-02-15 18:23:53 +00003803 if (required_hash_length > sizeof(operation->hash)) {
3804 /* Shouldn't happen, but better safe than sorry. */
3805 return PSA_ERROR_CORRUPTION_DETECTED;
3806 }
3807
Paul Elliott0290a762023-02-09 14:30:24 +00003808 memcpy(operation->hash, hash, required_hash_length);
3809 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003810
3811 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003812
3813#else
Paul Elliott068fe072023-01-16 13:59:15 +00003814 (void) operation;
3815 (void) key_buffer;
3816 (void) key_buffer_size;
3817 (void) alg;
3818 (void) hash;
3819 (void) hash_length;
3820 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003821 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003822
Paul Elliott068fe072023-01-16 13:59:15 +00003823 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003824#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3825 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3826 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003827}
3828
3829psa_status_t mbedtls_psa_sign_hash_complete(
3830 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3831 uint8_t *signature, size_t signature_size,
3832 size_t *signature_length)
3833{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003834#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3835 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3836 defined(MBEDTLS_ECP_RESTARTABLE)
3837
Paul Elliotta1c94092023-02-15 16:38:04 +00003838 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003839 mbedtls_mpi r;
3840 mbedtls_mpi s;
3841
Paul Elliott46845252023-02-03 14:59:11 +00003842 mbedtls_mpi_init(&r);
3843 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003844
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003845 /* Ensure max_ops is set to the current value (or default). */
3846 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3847
Paul Elliotta1c94092023-02-15 16:38:04 +00003848 if (signature_size < 2 * operation->coordinate_bytes) {
3849 status = PSA_ERROR_BUFFER_TOO_SMALL;
3850 goto exit;
3851 }
3852
Paul Elliott588f8ed2022-12-02 18:10:26 +00003853 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003854
Paul Elliott588f8ed2022-12-02 18:10:26 +00003855#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3856 status = mbedtls_to_psa_error(
3857 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003858 &r,
3859 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003860 &operation->ctx->d,
3861 operation->hash,
3862 operation->hash_length,
3863 operation->md_alg,
3864 mbedtls_psa_get_random,
3865 MBEDTLS_PSA_RANDOM_STATE,
3866 &operation->restart_ctx));
3867#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003868 status = PSA_ERROR_NOT_SUPPORTED;
3869 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003870#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3871 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003872 status = mbedtls_to_psa_error(
3873 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003874 &r,
3875 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003876 &operation->ctx->d,
3877 operation->hash,
3878 operation->hash_length,
3879 mbedtls_psa_get_random,
3880 MBEDTLS_PSA_RANDOM_STATE,
3881 mbedtls_psa_get_random,
3882 MBEDTLS_PSA_RANDOM_STATE,
3883 &operation->restart_ctx));
3884 }
3885
Paul Elliottf8e5b562023-02-19 18:43:45 +00003886 /* Hide the fact that the restart context only holds a delta of number of
3887 * ops done during the last operation, not an absolute value. */
3888 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3889
Paul Elliott724bd252023-02-08 12:35:08 +00003890 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003891 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003892 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003893 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003894 operation->coordinate_bytes)
3895 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003896
3897 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003898 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003899 }
3900
3901 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003902 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003903 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003904 operation->coordinate_bytes,
3905 operation->coordinate_bytes)
3906 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003907
3908 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003909 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003910 }
3911
Paul Elliott1bc59df2023-02-05 13:41:57 +00003912 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003913
Paul Elliott724bd252023-02-08 12:35:08 +00003914 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003915 }
Paul Elliott724bd252023-02-08 12:35:08 +00003916
3917exit:
3918
3919 mbedtls_mpi_free(&r);
3920 mbedtls_mpi_free(&s);
3921 return status;
3922
Paul Elliott588f8ed2022-12-02 18:10:26 +00003923 #else
3924
3925 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003926 (void) signature;
3927 (void) signature_size;
3928 (void) signature_length;
3929
3930 return PSA_ERROR_NOT_SUPPORTED;
3931
3932#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3933 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3934 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3935}
3936
3937psa_status_t mbedtls_psa_sign_hash_abort(
3938 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3939{
3940
3941#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3942 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3943 defined(MBEDTLS_ECP_RESTARTABLE)
3944
3945 if (operation->ctx) {
3946 mbedtls_ecdsa_free(operation->ctx);
3947 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003948 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003949 }
3950
3951 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3952
Paul Elliott93d9ca82023-02-15 18:14:21 +00003953 operation->num_ops = 0;
3954
Paul Elliott588f8ed2022-12-02 18:10:26 +00003955 return PSA_SUCCESS;
3956
3957#else
3958
3959 (void) operation;
3960
3961 return PSA_ERROR_NOT_SUPPORTED;
3962
3963#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3964 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3965 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3966}
3967
3968psa_status_t mbedtls_psa_verify_hash_start(
3969 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3970 const psa_key_attributes_t *attributes,
3971 const uint8_t *key_buffer, size_t key_buffer_size,
3972 psa_algorithm_t alg,
3973 const uint8_t *hash, size_t hash_length,
3974 const uint8_t *signature, size_t signature_length)
3975{
3976 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003977 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003978 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003979
Paul Elliott068fe072023-01-16 13:59:15 +00003980 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3981 return PSA_ERROR_NOT_SUPPORTED;
3982 }
3983
3984 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003985 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003986 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003987
3988#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003989 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3990 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003991
Paul Elliotta1c94092023-02-15 16:38:04 +00003992 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3993 mbedtls_mpi_init(&operation->r);
3994 mbedtls_mpi_init(&operation->s);
3995
Paul Elliott93d9ca82023-02-15 18:14:21 +00003996 /* Ensure num_ops is zero'ed in case of context re-use. */
3997 operation->num_ops = 0;
3998
Paul Elliott068fe072023-01-16 13:59:15 +00003999 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4000 attributes->core.bits,
4001 key_buffer,
4002 key_buffer_size,
4003 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004004
Paul Elliott068fe072023-01-16 13:59:15 +00004005 if (status != PSA_SUCCESS) {
4006 return status;
4007 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004008
Paul Elliottc569fc22023-02-10 13:02:54 +00004009 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004010
Paul Elliott1bc59df2023-02-05 13:41:57 +00004011 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004012 return PSA_ERROR_INVALID_SIGNATURE;
4013 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004014
Paul Elliott068fe072023-01-16 13:59:15 +00004015 status = mbedtls_to_psa_error(
4016 mbedtls_mpi_read_binary(&operation->r,
4017 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004018 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004019
Paul Elliott068fe072023-01-16 13:59:15 +00004020 if (status != PSA_SUCCESS) {
4021 return status;
4022 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004023
Paul Elliott068fe072023-01-16 13:59:15 +00004024 status = mbedtls_to_psa_error(
4025 mbedtls_mpi_read_binary(&operation->s,
4026 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004027 coordinate_bytes,
4028 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004029
Paul Elliott068fe072023-01-16 13:59:15 +00004030 if (status != PSA_SUCCESS) {
4031 return status;
4032 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004033
Paul Elliott2c9843f2023-02-15 17:32:42 +00004034 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004035
Paul Elliott2c9843f2023-02-15 17:32:42 +00004036 if (status != PSA_SUCCESS) {
4037 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004038 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004039
Paul Elliott0290a762023-02-09 14:30:24 +00004040 /* We only need to store the same length of hash as the private key size
4041 * here, it would be truncated by the internal implementation anyway. */
4042 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4043 coordinate_bytes);
4044
Paul Elliottba70ad42023-02-15 18:23:53 +00004045 if (required_hash_length > sizeof(operation->hash)) {
4046 /* Shouldn't happen, but better safe than sorry. */
4047 return PSA_ERROR_CORRUPTION_DETECTED;
4048 }
4049
Paul Elliott0290a762023-02-09 14:30:24 +00004050 memcpy(operation->hash, hash, required_hash_length);
4051 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004052
4053 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004054#else
Paul Elliott068fe072023-01-16 13:59:15 +00004055 (void) operation;
4056 (void) key_buffer;
4057 (void) key_buffer_size;
4058 (void) alg;
4059 (void) hash;
4060 (void) hash_length;
4061 (void) signature;
4062 (void) signature_length;
4063 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004064 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004065 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004066
Paul Elliott068fe072023-01-16 13:59:15 +00004067 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004068#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4069 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4070 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004071}
4072
4073psa_status_t mbedtls_psa_verify_hash_complete(
4074 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4075{
4076
4077#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4078 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4079 defined(MBEDTLS_ECP_RESTARTABLE)
4080
Paul Elliottf8e5b562023-02-19 18:43:45 +00004081 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4082
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004083 /* Ensure max_ops is set to the current value (or default). */
4084 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4085
Paul Elliottf8e5b562023-02-19 18:43:45 +00004086 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004087 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4088 operation->hash,
4089 operation->hash_length,
4090 &operation->ctx->Q,
4091 &operation->r,
4092 &operation->s,
4093 &operation->restart_ctx));
4094
Paul Elliottf8e5b562023-02-19 18:43:45 +00004095 /* Hide the fact that the restart context only holds a delta of number of
4096 * ops done during the last operation, not an absolute value. */
4097 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4098
4099 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004100#else
4101 (void) operation;
4102
4103 return PSA_ERROR_NOT_SUPPORTED;
4104
4105#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4106 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4107 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4108}
4109
4110psa_status_t mbedtls_psa_verify_hash_abort(
4111 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4112{
4113
4114#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4115 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4116 defined(MBEDTLS_ECP_RESTARTABLE)
4117
4118 if (operation->ctx) {
4119 mbedtls_ecdsa_free(operation->ctx);
4120 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004121 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004122 }
4123
4124 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4125
Paul Elliott93d9ca82023-02-15 18:14:21 +00004126 operation->num_ops = 0;
4127
Paul Elliott588f8ed2022-12-02 18:10:26 +00004128 mbedtls_mpi_free(&operation->r);
4129 mbedtls_mpi_free(&operation->s);
4130
4131 return PSA_SUCCESS;
4132
4133#else
4134 (void) operation;
4135
4136 return PSA_ERROR_NOT_SUPPORTED;
4137
4138#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4139 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4140 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4141}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004142
mohammad1603503973b2018-03-12 15:59:30 +02004143/****************************************************************/
4144/* Symmetric cryptography */
4145/****************************************************************/
4146
Gilles Peskine449bd832023-01-11 14:50:10 +01004147static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4148 mbedtls_svc_key_id_t key,
4149 psa_algorithm_t alg,
4150 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004151{
4152 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4153 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004154 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4156 PSA_KEY_USAGE_ENCRYPT :
4157 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004158 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004159
4160 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004162 status = PSA_ERROR_BAD_STATE;
4163 goto exit;
4164 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004165
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004167 status = PSA_ERROR_INVALID_ARGUMENT;
4168 goto exit;
4169 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004170
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4172 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004173 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004175
Ronald Cron49fafa92021-03-10 08:34:23 +01004176 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004177 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004178 * so we only set it (in the driver wrapper) after resources have been
4179 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004180 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004181 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004182 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004184 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 }
4186 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004187
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004188 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004190 };
4191
Ronald Cronab99ac22020-10-01 16:38:28 +02004192 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 if (cipher_operation == MBEDTLS_ENCRYPT) {
4194 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4195 &attributes,
4196 slot->key.data,
4197 slot->key.bytes,
4198 alg);
4199 } else {
4200 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4201 &attributes,
4202 slot->key.data,
4203 slot->key.bytes,
4204 alg);
4205 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004206
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004207exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 if (status != PSA_SUCCESS) {
4209 psa_cipher_abort(operation);
4210 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004211
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004213
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004215}
4216
Gilles Peskine449bd832023-01-11 14:50:10 +01004217psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4218 mbedtls_svc_key_id_t key,
4219 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004220{
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004222}
4223
Gilles Peskine449bd832023-01-11 14:50:10 +01004224psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4225 mbedtls_svc_key_id_t key,
4226 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004227{
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004229}
4230
Gilles Peskine449bd832023-01-11 14:50:10 +01004231psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4232 uint8_t *iv,
4233 size_t iv_size,
4234 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004235{
Ronald Cron6d051732020-10-01 14:10:20 +02004236 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004237 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004238 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004239
Gilles Peskine449bd832023-01-11 14:50:10 +01004240 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004241 status = PSA_ERROR_BAD_STATE;
4242 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004243 }
4244
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004246 status = PSA_ERROR_BAD_STATE;
4247 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004248 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004249
Ronald Cron2fb90522021-07-05 12:31:44 +02004250 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004252 status = PSA_ERROR_BUFFER_TOO_SMALL;
4253 goto exit;
4254 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004255
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004257 status = PSA_ERROR_GENERIC_ERROR;
4258 goto exit;
4259 }
4260
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 status = psa_generate_random(local_iv, default_iv_length);
4262 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004263 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 }
Ronald Cron5618a392021-03-26 09:52:26 +01004265
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 status = psa_driver_wrapper_cipher_set_iv(operation,
4267 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004268
4269exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 if (status == PSA_SUCCESS) {
4271 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004272 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004273 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004275 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004277 }
Ronald Cron6d051732020-10-01 14:10:20 +02004278
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004280}
4281
Gilles Peskine449bd832023-01-11 14:50:10 +01004282psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4283 const uint8_t *iv,
4284 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004285{
Ronald Cron6d051732020-10-01 14:10:20 +02004286 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004287
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004289 status = PSA_ERROR_BAD_STATE;
4290 goto exit;
4291 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004292
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004294 status = PSA_ERROR_BAD_STATE;
4295 goto exit;
4296 }
Ronald Crona0d68172021-03-26 10:15:08 +01004297
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004299 status = PSA_ERROR_INVALID_ARGUMENT;
4300 goto exit;
4301 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004302
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 status = psa_driver_wrapper_cipher_set_iv(operation,
4304 iv,
4305 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004306
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004307exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004309 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 } else {
4311 psa_cipher_abort(operation);
4312 }
4313 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004314}
4315
Gilles Peskine449bd832023-01-11 14:50:10 +01004316psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4317 const uint8_t *input,
4318 size_t input_length,
4319 uint8_t *output,
4320 size_t output_size,
4321 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004322{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004323 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004324
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004326 status = PSA_ERROR_BAD_STATE;
4327 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004328 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004329
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004331 status = PSA_ERROR_BAD_STATE;
4332 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004333 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004334
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 status = psa_driver_wrapper_cipher_update(operation,
4336 input,
4337 input_length,
4338 output,
4339 output_size,
4340 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004341
4342exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 if (status != PSA_SUCCESS) {
4344 psa_cipher_abort(operation);
4345 }
Ronald Cron6d051732020-10-01 14:10:20 +02004346
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004348}
4349
Gilles Peskine449bd832023-01-11 14:50:10 +01004350psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4351 uint8_t *output,
4352 size_t output_size,
4353 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004354{
David Saadab4ecc272019-02-14 13:48:10 +02004355 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004356
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004358 status = PSA_ERROR_BAD_STATE;
4359 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004360 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004361
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004363 status = PSA_ERROR_BAD_STATE;
4364 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004365 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004366
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 status = psa_driver_wrapper_cipher_finish(operation,
4368 output,
4369 output_size,
4370 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004371
4372exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 if (status == PSA_SUCCESS) {
4374 return psa_cipher_abort(operation);
4375 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004376 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004378
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004380 }
mohammad1603503973b2018-03-12 15:59:30 +02004381}
4382
Gilles Peskine449bd832023-01-11 14:50:10 +01004383psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004384{
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004386 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004387 * in use. It's ok to call abort on such an object, and there's
4388 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004390 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004391
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004393
Ronald Cron49fafa92021-03-10 08:34:23 +01004394 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004395 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004396 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004397
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004399}
4400
Gilles Peskine449bd832023-01-11 14:50:10 +01004401psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4402 psa_algorithm_t alg,
4403 const uint8_t *input,
4404 size_t input_length,
4405 uint8_t *output,
4406 size_t output_size,
4407 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004408{
4409 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004410 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004411 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004412 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4413 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004414 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004415
David Horstmanne9a88ab2023-11-29 17:07:13 +00004416 SWAP_FOR_LOCAL_INPUT(input, input_length);
4417 SWAP_FOR_LOCAL_OUTPUT(output, output_size);
David Horstmannc6977b42023-11-27 17:43:05 +00004418
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004420 status = PSA_ERROR_INVALID_ARGUMENT;
4421 goto exit;
4422 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004423
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4425 PSA_KEY_USAGE_ENCRYPT,
4426 alg);
4427 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004428 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004430
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004431 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004433 };
4434
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4436 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004437 status = PSA_ERROR_GENERIC_ERROR;
4438 goto exit;
4439 }
4440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 if (default_iv_length > 0) {
4442 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004443 status = PSA_ERROR_BUFFER_TOO_SMALL;
4444 goto exit;
4445 }
4446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 status = psa_generate_random(local_iv, default_iv_length);
4448 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004449 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004451 }
4452
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004453 status = psa_driver_wrapper_cipher_encrypt(
4454 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004455 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004456 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004458
4459exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 unlock_status = psa_unlock_key_slot(slot);
4461 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004462 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004463 }
Ronald Cron23919522021-07-08 19:00:07 +02004464
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 if (status == PSA_SUCCESS) {
4466 if (default_iv_length > 0) {
4467 memcpy(output, local_iv, default_iv_length);
4468 }
4469 *output_length += default_iv_length;
4470 } else {
4471 *output_length = 0;
4472 }
4473
David Horstmanne9a88ab2023-11-29 17:07:13 +00004474 FREE_LOCAL_INPUT(input);
4475 FREE_LOCAL_OUTPUT(output);
David Horstmannc6977b42023-11-27 17:43:05 +00004476
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004478}
4479
Gilles Peskine449bd832023-01-11 14:50:10 +01004480psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4481 psa_algorithm_t alg,
4482 const uint8_t *input,
4483 size_t input_length,
4484 uint8_t *output,
4485 size_t output_size,
4486 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004487{
4488 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004489 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004490 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004491 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004492
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004494 status = PSA_ERROR_INVALID_ARGUMENT;
4495 goto exit;
4496 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4499 PSA_KEY_USAGE_DECRYPT,
4500 alg);
4501 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004502 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004504
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004505 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004507 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004508
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4510 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004511 status = PSA_ERROR_INVALID_ARGUMENT;
4512 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004514 status = PSA_ERROR_INVALID_ARGUMENT;
4515 goto exit;
4516 }
4517
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004518 status = psa_driver_wrapper_cipher_decrypt(
4519 &attributes, slot->key.data, slot->key.bytes,
4520 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004522
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004523exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 unlock_status = psa_unlock_key_slot(slot);
4525 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004526 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004528
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004530 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 }
Ronald Cron23919522021-07-08 19:00:07 +02004532
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004534}
4535
4536
mohammad16035955c982018-04-26 00:53:03 +03004537/****************************************************************/
4538/* AEAD */
4539/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004540
Paul Elliottbaff51c2021-09-28 17:44:45 +01004541/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004542static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004543{
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004545}
4546
4547/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004548static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4549 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004550{
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004552
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004554#if defined(PSA_WANT_ALG_GCM)
4555 case PSA_ALG_GCM:
4556 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 * arbitrarily large nonces. Please note that we do not generally
4558 * recommend the usage of nonces of greater length than
4559 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4560 * size, which can then lead to collisions if you encrypt a very
4561 * large number of messages.*/
4562 if (nonce_length != 0) {
4563 return PSA_SUCCESS;
4564 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004565 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004566#endif /* PSA_WANT_ALG_GCM */
4567#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004568 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 if (nonce_length >= 7 && nonce_length <= 13) {
4570 return PSA_SUCCESS;
4571 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004572 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004573#endif /* PSA_WANT_ALG_CCM */
4574#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004575 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 if (nonce_length == 12) {
4577 return PSA_SUCCESS;
4578 } else if (nonce_length == 8) {
4579 return PSA_ERROR_NOT_SUPPORTED;
4580 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004581 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004582#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004583 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004584 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004586 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004587
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004589}
4590
Gilles Peskine449bd832023-01-11 14:50:10 +01004591static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004592{
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4594 return PSA_ERROR_INVALID_ARGUMENT;
4595 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004596
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004598}
4599
Gilles Peskine449bd832023-01-11 14:50:10 +01004600psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4601 psa_algorithm_t alg,
4602 const uint8_t *nonce,
4603 size_t nonce_length,
4604 const uint8_t *additional_data,
4605 size_t additional_data_length,
4606 const uint8_t *plaintext,
4607 size_t plaintext_length,
4608 uint8_t *ciphertext,
4609 size_t ciphertext_size,
4610 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004611{
Ronald Cron215633c2021-03-16 17:15:37 +01004612 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4613 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004614
mohammad1603f08a5502018-06-03 15:05:47 +03004615 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004616
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 status = psa_aead_check_algorithm(alg);
4618 if (status != PSA_SUCCESS) {
4619 return status;
4620 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004621
Ronald Cron9a986162021-03-26 12:40:07 +01004622 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4624 if (status != PSA_SUCCESS) {
4625 return status;
4626 }
mohammad16035955c982018-04-26 00:53:03 +03004627
Ronald Cron215633c2021-03-16 17:15:37 +01004628 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004630 };
mohammad16035955c982018-04-26 00:53:03 +03004631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 status = psa_aead_check_nonce_length(alg, nonce_length);
4633 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004634 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004636
Ronald Cronde822812021-03-17 16:08:20 +01004637 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004638 &attributes, slot->key.data, slot->key.bytes,
4639 alg,
4640 nonce, nonce_length,
4641 additional_data, additional_data_length,
4642 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004644
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4646 memset(ciphertext, 0, ciphertext_size);
4647 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004648
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004649exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004651
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004653}
4654
Gilles Peskine449bd832023-01-11 14:50:10 +01004655psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4656 psa_algorithm_t alg,
4657 const uint8_t *nonce,
4658 size_t nonce_length,
4659 const uint8_t *additional_data,
4660 size_t additional_data_length,
4661 const uint8_t *ciphertext,
4662 size_t ciphertext_length,
4663 uint8_t *plaintext,
4664 size_t plaintext_size,
4665 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004666{
Ronald Cron215633c2021-03-16 17:15:37 +01004667 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4668 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004669
Gilles Peskineee652a32018-06-01 19:23:52 +02004670 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004671
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 status = psa_aead_check_algorithm(alg);
4673 if (status != PSA_SUCCESS) {
4674 return status;
4675 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004676
Ronald Cron9a986162021-03-26 12:40:07 +01004677 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4679 if (status != PSA_SUCCESS) {
4680 return status;
4681 }
mohammad16035955c982018-04-26 00:53:03 +03004682
Ronald Cron215633c2021-03-16 17:15:37 +01004683 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004685 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 status = psa_aead_check_nonce_length(alg, nonce_length);
4688 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004689 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004691
Ronald Cronde822812021-03-17 16:08:20 +01004692 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004693 &attributes, slot->key.data, slot->key.bytes,
4694 alg,
4695 nonce, nonce_length,
4696 additional_data, additional_data_length,
4697 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004699
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 if (status != PSA_SUCCESS && plaintext_size != 0) {
4701 memset(plaintext, 0, plaintext_size);
4702 }
mohammad160360a64d02018-06-03 17:20:42 +03004703
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004704exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 return status;
mohammad16035955c982018-04-26 00:53:03 +03004708}
4709
Gilles Peskine449bd832023-01-11 14:50:10 +01004710static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4711{
4712 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004713
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004715#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004717 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4719 return PSA_ERROR_INVALID_ARGUMENT;
4720 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004721 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004722#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004723
Przemek Stekiel86679c72022-10-06 17:06:56 +02004724#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004726 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4728 return PSA_ERROR_INVALID_ARGUMENT;
4729 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004730 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004731#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004732
Przemek Stekiel86679c72022-10-06 17:06:56 +02004733#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004735 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if (tag_len != 16) {
4737 return PSA_ERROR_INVALID_ARGUMENT;
4738 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004739 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004740#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004741
4742 default:
4743 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004745 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004747}
4748
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004749/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004750static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4751 int is_encrypt,
4752 mbedtls_svc_key_id_t key,
4753 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004754{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004755 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4756 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4757 psa_key_slot_t *slot = NULL;
4758 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004759 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004760
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 status = psa_aead_check_algorithm(alg);
4762 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004763 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004765
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004767 status = PSA_ERROR_BAD_STATE;
4768 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004769 }
4770
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (operation->nonce_set || operation->lengths_set ||
4772 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004773 status = PSA_ERROR_BAD_STATE;
4774 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004775 }
4776
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004778 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004780 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004782
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4784 alg);
4785 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004786 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004788
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004789 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004790 .core = slot->attr
4791 };
4792
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004794 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004796
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if (is_encrypt) {
4798 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4799 &attributes,
4800 slot->key.data,
4801 slot->key.bytes,
4802 alg);
4803 } else {
4804 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4805 &attributes,
4806 slot->key.data,
4807 slot->key.bytes,
4808 alg);
4809 }
4810 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004811 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004815
4816exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004818
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004820 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004822 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 } else {
4824 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004825 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004826
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004828}
4829
Paul Elliott302ff6b2021-04-20 18:10:30 +01004830/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004831psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4832 mbedtls_svc_key_id_t key,
4833 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004834{
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004836}
4837
4838/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004839psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4840 mbedtls_svc_key_id_t key,
4841 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004842{
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004844}
4845
4846/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004847psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4848 uint8_t *nonce,
4849 size_t nonce_size,
4850 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004851{
4852 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004853 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004854 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004855
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004856 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004857
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004859 status = PSA_ERROR_BAD_STATE;
4860 goto exit;
4861 }
4862
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004864 status = PSA_ERROR_BAD_STATE;
4865 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004866 }
4867
Paul Elliotte193ea82021-10-01 13:00:16 +01004868 /* For CCM, this size may not be correct according to the PSA
4869 * specification. The PSA Crypto 1.0.1 specification states:
4870 *
4871 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4872 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4873 *
4874 * However this restriction that L has to be the smallest integer is not
4875 * applied in practice, and it is not implementable here since the
4876 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4878 operation->alg);
4879 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004880 status = PSA_ERROR_BUFFER_TOO_SMALL;
4881 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004882 }
4883
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 status = psa_generate_random(local_nonce, required_nonce_size);
4885 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004886 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004888
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004890
Paul Elliott39dc6b82021-05-11 19:16:09 +01004891exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 if (status == PSA_SUCCESS) {
4893 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004894 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 } else {
4896 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004897 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004898
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004900}
4901
4902/* Set the nonce for a multipart authenticated encryption or decryption
4903 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004904psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4905 const uint8_t *nonce,
4906 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004907{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004908 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4909
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004911 status = PSA_ERROR_BAD_STATE;
4912 goto exit;
4913 }
4914
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004916 status = PSA_ERROR_BAD_STATE;
4917 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004918 }
4919
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4921 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004922 status = PSA_ERROR_INVALID_ARGUMENT;
4923 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004924 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004925
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4927 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004928
Paul Elliott39dc6b82021-05-11 19:16:09 +01004929exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004931 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 } else {
4933 psa_aead_abort(operation);
4934 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004935
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004937}
4938
4939/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004940psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4941 size_t ad_length,
4942 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004943{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004944 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4945
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004947 status = PSA_ERROR_BAD_STATE;
4948 goto exit;
4949 }
4950
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 if (operation->lengths_set || operation->ad_started ||
4952 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004953 status = PSA_ERROR_BAD_STATE;
4954 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004955 }
4956
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004958#if defined(PSA_WANT_ALG_GCM)
4959 case PSA_ALG_GCM:
4960 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 * bits. Without the guard this code will generate warnings on 32bit
4962 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004963#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 if (((uint64_t) ad_length) >> 61 != 0 ||
4965 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004966 status = PSA_ERROR_INVALID_ARGUMENT;
4967 goto exit;
4968 }
Paul Elliott325d3742021-09-27 17:56:28 +01004969#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004970 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004971#endif /* PSA_WANT_ALG_GCM */
4972#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004973 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004975 status = PSA_ERROR_INVALID_ARGUMENT;
4976 goto exit;
4977 }
4978 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004979#endif /* PSA_WANT_ALG_CCM */
4980#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004981 case PSA_ALG_CHACHA20_POLY1305:
4982 /* No length restrictions for ChaChaPoly. */
4983 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004984#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004985 default:
4986 break;
4987 }
Paul Elliott325d3742021-09-27 17:56:28 +01004988
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4990 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004991
Paul Elliott39dc6b82021-05-11 19:16:09 +01004992exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004994 operation->ad_remaining = ad_length;
4995 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004996 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 } else {
4998 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004999 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005000
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005002}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005003
5004/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005005psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5006 const uint8_t *input,
5007 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005008{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005009 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5010
Gilles Peskine449bd832023-01-11 14:50:10 +01005011 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005012 status = PSA_ERROR_BAD_STATE;
5013 goto exit;
5014 }
5015
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005017 status = PSA_ERROR_BAD_STATE;
5018 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005019 }
5020
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 if (operation->lengths_set) {
5022 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005023 status = PSA_ERROR_INVALID_ARGUMENT;
5024 goto exit;
5025 }
5026
5027 operation->ad_remaining -= input_length;
5028 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005029#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005031 status = PSA_ERROR_BAD_STATE;
5032 goto exit;
5033 }
5034#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005035
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 status = psa_driver_wrapper_aead_update_ad(operation, input,
5037 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005038
Paul Elliott39dc6b82021-05-11 19:16:09 +01005039exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005041 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 } else {
5043 psa_aead_abort(operation);
5044 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005045
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005047}
5048
5049/* Encrypt or decrypt a message fragment in an active multipart AEAD
5050 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005051psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5052 const uint8_t *input,
5053 size_t input_length,
5054 uint8_t *output,
5055 size_t output_size,
5056 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005057{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005058 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005059
5060 *output_length = 0;
5061
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005063 status = PSA_ERROR_BAD_STATE;
5064 goto exit;
5065 }
5066
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005068 status = PSA_ERROR_BAD_STATE;
5069 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005070 }
5071
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005073 /* Additional data length was supplied, but not all the additional
5074 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005076 status = PSA_ERROR_INVALID_ARGUMENT;
5077 goto exit;
5078 }
5079
5080 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005082 status = PSA_ERROR_INVALID_ARGUMENT;
5083 goto exit;
5084 }
5085
5086 operation->body_remaining -= input_length;
5087 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005088#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005090 status = PSA_ERROR_BAD_STATE;
5091 goto exit;
5092 }
5093#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005094
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5096 output, output_size,
5097 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005098
Paul Elliott39dc6b82021-05-11 19:16:09 +01005099exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005101 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 } else {
5103 psa_aead_abort(operation);
5104 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005105
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005107}
5108
Gilles Peskine449bd832023-01-11 14:50:10 +01005109static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005110{
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 if (operation->id == 0 || !operation->nonce_set) {
5112 return PSA_ERROR_BAD_STATE;
5113 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005114
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5116 operation->body_remaining != 0)) {
5117 return PSA_ERROR_INVALID_ARGUMENT;
5118 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005119
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005121}
5122
Paul Elliott302ff6b2021-04-20 18:10:30 +01005123/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005124psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5125 uint8_t *ciphertext,
5126 size_t ciphertext_size,
5127 size_t *ciphertext_length,
5128 uint8_t *tag,
5129 size_t tag_size,
5130 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005131{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005132 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5133
Paul Elliott302ff6b2021-04-20 18:10:30 +01005134 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005135 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005136
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 status = psa_aead_final_checks(operation);
5138 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005139 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005141
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005143 status = PSA_ERROR_BAD_STATE;
5144 goto exit;
5145 }
5146
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5148 ciphertext_size,
5149 ciphertext_length,
5150 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005151
Paul Elliott39dc6b82021-05-11 19:16:09 +01005152exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005153
5154
Paul Elliottf47b0952021-05-21 18:02:33 +01005155 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005156 * the zero tag size, make sure the tag is set to something implausible.
5157 * Even if the operation succeeds, make sure we clear the rest of the
5158 * buffer to prevent potential leakage of anything previously placed in
5159 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005160 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005163
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005165}
5166
5167/* Finish authenticating and decrypting a message in a multipart AEAD
5168 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005169psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5170 uint8_t *plaintext,
5171 size_t plaintext_size,
5172 size_t *plaintext_length,
5173 const uint8_t *tag,
5174 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005175{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005176 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5177
Paul Elliott302ff6b2021-04-20 18:10:30 +01005178 *plaintext_length = 0;
5179
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 status = psa_aead_final_checks(operation);
5181 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005182 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005184
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005186 status = PSA_ERROR_BAD_STATE;
5187 goto exit;
5188 }
5189
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5191 plaintext_size,
5192 plaintext_length,
5193 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005194
5195exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005197
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005199}
5200
5201/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005202psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005203{
5204 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5205
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005207 /* The object has (apparently) been initialized but it is not (yet)
5208 * in use. It's ok to call abort on such an object, and there's
5209 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005211 }
5212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005214
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005218}
5219
Gilles Peskinee59236f2018-01-27 23:32:46 +01005220/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005221/* Generators */
5222/****************************************************************/
5223
Przemek Stekiel69c46792022-06-10 12:59:51 +02005224#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005225 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005226 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305227 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305228 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005229#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005230#endif /* At least one builtin KDF */
5231
Przemek Stekiel69c46792022-06-10 12:59:51 +02005232#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005233 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5234 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5235static psa_status_t psa_key_derivation_start_hmac(
5236 psa_mac_operation_t *operation,
5237 psa_algorithm_t hash_alg,
5238 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005240{
5241 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5242 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5244 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5245 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005246
Steven Cooreman72f736a2021-05-07 14:14:37 +02005247 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005249
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 status = psa_driver_wrapper_mac_sign_setup(operation,
5251 &attributes,
5252 hmac_key, hmac_key_length,
5253 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005254
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 psa_reset_key_attributes(&attributes);
5256 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005257}
5258#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005259
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005260#define HKDF_STATE_INIT 0 /* no input yet */
5261#define HKDF_STATE_STARTED 1 /* got salt */
5262#define HKDF_STATE_KEYED 2 /* got key */
5263#define HKDF_STATE_OUTPUT 3 /* output started */
5264
Gilles Peskinecbe66502019-05-16 16:59:18 +02005265static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005267{
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5269 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5270 } else {
5271 return operation->alg;
5272 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005273}
5274
Gilles Peskine449bd832023-01-11 14:50:10 +01005275psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005276{
5277 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5279 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005280 /* The object has (apparently) been initialized but it is not
5281 * in use. It's ok to call abort on such an object, and there's
5282 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005284#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5286 mbedtls_free(operation->ctx.hkdf.info);
5287 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5288 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005289#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005290#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5291 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5293 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5294 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5295 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005296 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005298 }
5299
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005301 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005303 }
5304
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005306 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005308 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005309#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005311 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005312 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005313 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005314#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005315 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005316
5317 /* We leave the fields Ai and output_block to be erased safely by the
5318 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005320#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5321 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005322#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5324 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5325 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5326 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005327#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305328#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305329 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305330 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005331 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305332 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305333 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305334
5335 status = PSA_SUCCESS;
5336 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305337#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005338 {
5339 status = PSA_ERROR_BAD_STATE;
5340 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 mbedtls_platform_zeroize(operation, sizeof(*operation));
5342 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005343}
5344
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005345psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005347{
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005349 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005351 }
5352
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005353 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005355}
5356
Gilles Peskine449bd832023-01-11 14:50:10 +01005357psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5358 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005359{
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 if (operation->alg == 0) {
5361 return PSA_ERROR_BAD_STATE;
5362 }
5363 if (capacity > operation->capacity) {
5364 return PSA_ERROR_INVALID_ARGUMENT;
5365 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005366 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005368}
5369
Przemek Stekiel69c46792022-06-10 12:59:51 +02005370#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005371/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005372static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5373 psa_algorithm_t kdf_alg,
5374 uint8_t *output,
5375 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005376{
Gilles Peskine449bd832023-01-11 14:50:10 +01005377 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5378 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005379 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005380 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005381#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005383#else
5384 const uint8_t last_block = 0xff;
5385#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005386
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 if (hkdf->state < HKDF_STATE_KEYED ||
5388 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005389#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005391#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 )) {
5393 return PSA_ERROR_BAD_STATE;
5394 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005395 hkdf->state = HKDF_STATE_OUTPUT;
5396
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005398 /* Copy what remains of the current block */
5399 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005401 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 }
5403 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005404 output += n;
5405 output_length -= n;
5406 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005408 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005410 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005411 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005412 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005413 * object was corrupted or if this function is called directly
5414 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 if (hkdf->block_number == last_block) {
5416 return PSA_ERROR_BAD_STATE;
5417 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005418
5419 /* We need a new block */
5420 ++hkdf->block_number;
5421 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005422
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5424 hash_alg,
5425 hkdf->prk,
5426 hash_length);
5427 if (status != PSA_SUCCESS) {
5428 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005429 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005430
5431 if (hkdf->block_number != 1) {
5432 status = psa_mac_update(&hkdf->hmac,
5433 hkdf->output_block,
5434 hash_length);
5435 if (status != PSA_SUCCESS) {
5436 return status;
5437 }
5438 }
5439 status = psa_mac_update(&hkdf->hmac,
5440 hkdf->info,
5441 hkdf->info_length);
5442 if (status != PSA_SUCCESS) {
5443 return status;
5444 }
5445 status = psa_mac_update(&hkdf->hmac,
5446 &hkdf->block_number, 1);
5447 if (status != PSA_SUCCESS) {
5448 return status;
5449 }
5450 status = psa_mac_sign_finish(&hkdf->hmac,
5451 hkdf->output_block,
5452 sizeof(hkdf->output_block),
5453 &hmac_output_length);
5454 if (status != PSA_SUCCESS) {
5455 return status;
5456 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005457 }
5458
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005460}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005461#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005462
John Durkop07cc04a2020-11-16 22:08:34 -08005463#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5464 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005465static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5466 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005468{
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5470 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005471 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5472 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005473 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005474
Janos Follath7742fee2019-06-17 12:58:10 +01005475 /* We can't be wanting more output after block 0xff, otherwise
5476 * the capacity check in psa_key_derivation_output_bytes() would have
5477 * prevented this call. It could happen only if the operation
5478 * object was corrupted or if this function is called directly
5479 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 if (tls12_prf->block_number == 0xff) {
5481 return PSA_ERROR_CORRUPTION_DETECTED;
5482 }
Janos Follath7742fee2019-06-17 12:58:10 +01005483
5484 /* We need a new block */
5485 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005486 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005487
5488 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5489 *
5490 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5491 *
5492 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5493 * HMAC_hash(secret, A(2) + seed) +
5494 * HMAC_hash(secret, A(3) + seed) + ...
5495 *
5496 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005497 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005498 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005499 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005500 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005501 * is currently extracted as `output_block` and where i is
5502 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005503 */
5504
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 status = psa_key_derivation_start_hmac(&hmac,
5506 hash_alg,
5507 tls12_prf->secret,
5508 tls12_prf->secret_length);
5509 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005510 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005512
5513 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005515 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5516 * the variable seed and in this instance means it in the context of the
5517 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 status = psa_mac_update(&hmac,
5519 tls12_prf->label,
5520 tls12_prf->label_length);
5521 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005522 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 }
5524 status = psa_mac_update(&hmac,
5525 tls12_prf->seed,
5526 tls12_prf->seed_length);
5527 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005528 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 }
5530 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005531 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5533 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005534 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005536 }
5537
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 status = psa_mac_sign_finish(&hmac,
5539 tls12_prf->Ai, hash_length,
5540 &hmac_output_length);
5541 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005542 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 }
5544 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005545 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005547
5548 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005549 status = psa_key_derivation_start_hmac(&hmac,
5550 hash_alg,
5551 tls12_prf->secret,
5552 tls12_prf->secret_length);
5553 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005554 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 }
5556 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5557 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005558 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 }
5560 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5561 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005562 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 }
5564 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5565 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005566 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 }
5568 status = psa_mac_sign_finish(&hmac,
5569 tls12_prf->output_block, hash_length,
5570 &hmac_output_length);
5571 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005572 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005574
Janos Follath7742fee2019-06-17 12:58:10 +01005575
5576cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005577 cleanup_status = psa_mac_abort(&hmac);
5578 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005579 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005581
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005583}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005584
Janos Follath844eb0e2019-06-19 12:10:49 +01005585static psa_status_t psa_key_derivation_tls12_prf_read(
5586 psa_tls12_prf_key_derivation_t *tls12_prf,
5587 psa_algorithm_t alg,
5588 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005590{
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5592 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005593 psa_status_t status;
5594 uint8_t offset, length;
5595
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005597 case PSA_TLS12_PRF_STATE_LABEL_SET:
5598 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5599 break;
5600 case PSA_TLS12_PRF_STATE_OUTPUT:
5601 break;
5602 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005604 }
5605
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005607 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 if (tls12_prf->left_in_block == 0) {
5609 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5610 alg);
5611 if (status != PSA_SUCCESS) {
5612 return status;
5613 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005614
5615 continue;
5616 }
5617
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005619 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005621 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005623
5624 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005625 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005626 output += length;
5627 output_length -= length;
5628 tls12_prf->left_in_block -= length;
5629 }
5630
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005632}
John Durkop07cc04a2020-11-16 22:08:34 -08005633#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5634 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005635
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005636#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5637static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5638 psa_tls12_ecjpake_to_pms_t *ecjpake,
5639 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005641{
5642 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005643 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005644
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 if (output_length != 32) {
5646 return PSA_ERROR_INVALID_ARGUMENT;
5647 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005648
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5650 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5651 &output_size);
5652 if (status != PSA_SUCCESS) {
5653 return status;
5654 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005655
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 if (output_size != output_length) {
5657 return PSA_ERROR_GENERIC_ERROR;
5658 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005659
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005661}
5662#endif
5663
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305664#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305665static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5666 psa_pbkdf2_key_derivation_t *pbkdf2,
5667 psa_algorithm_t prf_alg,
5668 uint8_t prf_output_length,
5669 psa_key_attributes_t *attributes)
5670{
5671 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305672 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305673 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305674 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305675 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305676 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305677 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305678
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305679 mac_operation.is_sign = 1;
5680 mac_operation.mac_size = prf_output_length;
5681 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305682
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305683 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5684 attributes,
5685 pbkdf2->password,
5686 pbkdf2->password_length,
5687 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305688 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305689 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305690 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305691 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5692 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305693 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305694 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305695 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305696 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305697 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305698 }
5699 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5700 &mac_output_length);
5701 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305702 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305703 }
5704
5705 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305706 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305707 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305708 }
5709
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305710 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305711
5712 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305713 /* We are passing prf_output_length as mac_size because the driver
5714 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305715 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305716 status = psa_driver_wrapper_mac_compute(attributes,
5717 pbkdf2->password,
5718 pbkdf2->password_length,
5719 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305720 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305721 &mac_output_length);
5722 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305723 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305724 }
5725
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305726 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305727 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305728
5729cleanup:
5730 /* Zeroise buffers to clear sensitive data from memory. */
5731 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5732 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305733}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305734
5735static psa_status_t psa_key_derivation_pbkdf2_read(
5736 psa_pbkdf2_key_derivation_t *pbkdf2,
5737 psa_algorithm_t kdf_alg,
5738 uint8_t *output,
5739 size_t output_length)
5740{
5741 psa_status_t status;
5742 psa_algorithm_t prf_alg;
5743 uint8_t prf_output_length;
5744 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5745 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5746 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5747
5748 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5749 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5750 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5751 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305752 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5753 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305754 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305755 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305756 } else {
5757 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305758 }
5759
5760 switch (pbkdf2->state) {
5761 case PSA_PBKDF2_STATE_PASSWORD_SET:
5762 /* Initially we need a new block so bytes_used is equal to block size*/
5763 pbkdf2->bytes_used = prf_output_length;
5764 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5765 break;
5766 case PSA_PBKDF2_STATE_OUTPUT:
5767 break;
5768 default:
5769 return PSA_ERROR_BAD_STATE;
5770 }
5771
5772 while (output_length != 0) {
5773 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5774 if (n > output_length) {
5775 n = (uint8_t) output_length;
5776 }
5777 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5778 output += n;
5779 output_length -= n;
5780 pbkdf2->bytes_used += n;
5781
5782 if (output_length == 0) {
5783 break;
5784 }
5785
5786 /* We need a new block */
5787 pbkdf2->bytes_used = 0;
5788 pbkdf2->block_number++;
5789
5790 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5791 prf_output_length,
5792 &attributes);
5793 if (status != PSA_SUCCESS) {
5794 return status;
5795 }
5796 }
5797
5798 return PSA_SUCCESS;
5799}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305800#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305801
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005802psa_status_t psa_key_derivation_output_bytes(
5803 psa_key_derivation_operation_t *operation,
5804 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005806{
5807 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005809
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005811 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005813 }
5814
Gilles Peskine449bd832023-01-11 14:50:10 +01005815 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005816 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005817 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005818 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005819 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005820 goto exit;
5821 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005823 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005824 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005825 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5826 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005827 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005828 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005830 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005831 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005832
Przemek Stekiel69c46792022-06-10 12:59:51 +02005833#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5835 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5836 output, output_length);
5837 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005838#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005839#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5840 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5842 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5843 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5844 kdf_alg, output,
5845 output_length);
5846 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005847#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5848 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005849#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005851 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5853 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005854#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305855#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305856 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305857 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5858 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305859 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305860#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005861
Gilles Peskineeab56e42018-07-12 17:12:33 +02005862 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005863 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005865 }
5866
5867exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005868 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005869 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005870 * This allows us to differentiate between exhausted operations and
5871 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5872 * operations. */
5873 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005875 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005877 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005879}
5880
David Brown7807bf72021-02-09 16:28:23 -07005881#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005882static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005883{
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 if (data_size >= 8) {
5885 mbedtls_des_key_set_parity(data);
5886 }
5887 if (data_size >= 16) {
5888 mbedtls_des_key_set_parity(data + 8);
5889 }
5890 if (data_size >= 24) {
5891 mbedtls_des_key_set_parity(data + 16);
5892 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005893}
David Brown7807bf72021-02-09 16:28:23 -07005894#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005895
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005896/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 * ECC keys on a Weierstrass elliptic curve require the generation
5898 * of a private key which is an integer
5899 * in the range [1, N - 1], where N is the boundary of the private key domain:
5900 * N is the prime p for Diffie-Hellman, or the order of the
5901 * curve’s base point for ECC.
5902 *
5903 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5904 * This function generates the private key using the following process:
5905 *
5906 * 1. Draw a byte string of length ceiling(m/8) bytes.
5907 * 2. If m is not a multiple of 8, set the most significant
5908 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5909 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5910 * 4. If k > N - 2, discard the result and return to step 1.
5911 * 5. Output k + 1 as the private key.
5912 *
5913 * This method allows compliance to NIST standards, specifically the methods titled
5914 * Key-Pair Generation by Testing Candidates in the following publications:
5915 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5916 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5917 * Diffie-Hellman keys.
5918 *
5919 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5920 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5921 *
5922 * Note: Function allocates memory for *data buffer, so given *data should be
5923 * always NULL.
5924 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005925#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5926#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005927static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005928 psa_key_slot_t *slot,
5929 size_t bits,
5930 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005931 uint8_t **data
5932 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005933{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005934 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005935 mbedtls_mpi k;
5936 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005937 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005938 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005939 size_t m;
5940 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005941
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 mbedtls_mpi_init(&k);
5943 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005944
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005945 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005947 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005949
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005951 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005952 goto cleanup;
5953 }
5954
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005955 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005957
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005959
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005960 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005961 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005962 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005963
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005964 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005965
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005966 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005968
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005969 /* Note: This function is always called with *data == NULL and it
5970 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 *data = mbedtls_calloc(1, m_bytes);
5972 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005973 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005974 goto cleanup;
5975 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005976
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005978 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005980 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005982
5983 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005985 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005986 * (8 * ceiling(m/8) - m) bits of the first byte in
5987 * the string to zero.
5988 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005990 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005991 }
5992
5993 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 * big-endian byte string.
5995 */
5996 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005997
5998 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 * Result of comparison is returned. When it indicates error
6000 * then this function is called again.
6001 */
6002 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006003 }
6004
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006005 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6007 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006008cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 if (ret != 0) {
6010 status = mbedtls_to_psa_error(ret);
6011 }
6012 if (status != PSA_SUCCESS) {
6013 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006014 *data = NULL;
6015 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 mbedtls_mpi_free(&k);
6017 mbedtls_mpi_free(&diff_N_2);
6018 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006019}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006020
6021/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6022 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6023 *
6024 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6025 * draw a 32-byte string and process it as specified in
6026 * Elliptic Curves for Security [RFC7748] §5.
6027 *
6028 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6029 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6030 *
6031 * Note: Function allocates memory for *data buffer, so given *data should be
6032 * always NULL.
6033 */
6034
6035static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6036 size_t bits,
6037 psa_key_derivation_operation_t *operation,
6038 uint8_t **data
6039 )
6040{
6041 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006042 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006043
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006045 case 255:
6046 output_length = 32;
6047 break;
6048 case 448:
6049 output_length = 56;
6050 break;
6051 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006053 break;
6054 }
6055
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006057
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 if (*data == NULL) {
6059 return PSA_ERROR_INSUFFICIENT_MEMORY;
6060 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006061
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006063
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006065 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006067
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006069 case 255:
6070 (*data)[0] &= 248;
6071 (*data)[31] &= 127;
6072 (*data)[31] |= 64;
6073 break;
6074 case 448:
6075 (*data)[0] &= 252;
6076 (*data)[55] |= 128;
6077 break;
6078 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006080 break;
6081 }
6082
6083 return status;
6084}
Valerio Setti86587ab2023-06-27 13:09:30 +02006085#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6086static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6087 psa_key_slot_t *slot, size_t bits,
6088 psa_key_derivation_operation_t *operation, uint8_t **data)
6089{
6090 (void) slot;
6091 (void) bits;
6092 (void) operation;
6093 (void) data;
6094 return PSA_ERROR_NOT_SUPPORTED;
6095}
6096
6097static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6098 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6099{
6100 (void) bits;
6101 (void) operation;
6102 (void) data;
6103 return PSA_ERROR_NOT_SUPPORTED;
6104}
6105#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6106#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006107
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006108static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006109 psa_key_slot_t *slot,
6110 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006112{
6113 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306115 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006116 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006117 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006118
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6120 return PSA_ERROR_INVALID_ARGUMENT;
6121 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006122
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006123#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006124 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6126 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6127 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006128 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6130 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006131 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 }
6133 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006134 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6136 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006137 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006139 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006140 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006141#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006142 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006143 if (key_type_is_raw_bytes(slot->attr.type)) {
6144 if (bits % 8 != 0) {
6145 return PSA_ERROR_INVALID_ARGUMENT;
6146 }
6147 data = mbedtls_calloc(1, bytes);
6148 if (data == NULL) {
6149 return PSA_ERROR_INSUFFICIENT_MEMORY;
6150 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006151
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 status = psa_key_derivation_output_bytes(operation, data, bytes);
6153 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006154 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 }
David Brown12ca5032021-02-11 11:02:00 -07006156#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6158 psa_des_set_key_parity(data, bytes);
6159 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006160#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 } else {
6162 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006163 }
Ronald Crondd04d422020-11-28 15:14:42 +01006164
Ronald Cronbf33c932020-11-28 18:06:53 +01006165 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006166 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006168 };
6169
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6171 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6172 &storage_size);
6173 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306174 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 }
Archanad8a83dc2021-06-14 10:04:16 +05306176 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 status = psa_allocate_buffer_to_slot(slot, storage_size);
6178 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306179 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 }
Archanad8a83dc2021-06-14 10:04:16 +05306181
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 status = psa_driver_wrapper_import_key(&attributes,
6183 data, bytes,
6184 slot->key.data,
6185 slot->key.bytes,
6186 &slot->key.bytes, &bits);
6187 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006188 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006190
6191exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 mbedtls_free(data);
6193 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006194}
6195
Gilles Peskine449bd832023-01-11 14:50:10 +01006196psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6197 psa_key_derivation_operation_t *operation,
6198 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006199{
6200 psa_status_t status;
6201 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006202 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006203
Ronald Cron81709fc2020-11-14 12:10:32 +01006204 *key = MBEDTLS_SVC_KEY_ID_INIT;
6205
Gilles Peskine0f84d622019-09-12 19:03:13 +02006206 /* Reject any attempt to create a zero-length key so that we don't
6207 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 if (psa_get_key_bits(attributes) == 0) {
6209 return PSA_ERROR_INVALID_ARGUMENT;
6210 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006211
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 if (operation->alg == PSA_ALG_NONE) {
6213 return PSA_ERROR_BAD_STATE;
6214 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006215
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 if (!operation->can_output_key) {
6217 return PSA_ERROR_NOT_PERMITTED;
6218 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006219
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6221 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006222#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006224 /* Deriving a key in a secure element is not implemented yet. */
6225 status = PSA_ERROR_NOT_SUPPORTED;
6226 }
6227#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 if (status == PSA_SUCCESS) {
6229 status = psa_generate_derived_key_internal(slot,
6230 attributes->core.bits,
6231 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006232 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 if (status == PSA_SUCCESS) {
6234 status = psa_finish_key_creation(slot, driver, key);
6235 }
6236 if (status != PSA_SUCCESS) {
6237 psa_fail_key_creation(slot, driver);
6238 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006239
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006241}
6242
Gilles Peskineeab56e42018-07-12 17:12:33 +02006243
6244
6245/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006246/* Key derivation */
6247/****************************************************************/
6248
Steven Cooreman932ffb72021-02-15 12:14:32 +01006249#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006250static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006251{
6252#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6254 return 1;
6255 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006256#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006257#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6259 return 1;
6260 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006261#endif
6262#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6264 return 1;
6265 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006266#endif
6267#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6269 return 1;
6270 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006271#endif
6272#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6274 return 1;
6275 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006276#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006277#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6279 return 1;
6280 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006281#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306282#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6283 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6284 return 1;
6285 }
6286#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306287#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6288 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6289 return 1;
6290 }
6291#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006293}
6294
Gilles Peskine449bd832023-01-11 14:50:10 +01006295static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006296{
6297 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 psa_status_t status = psa_hash_setup(&operation, alg);
6299 psa_hash_abort(&operation);
6300 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006301}
6302
Gilles Peskine969c5d62019-01-16 15:53:06 +01006303static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006304 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006306{
Janos Follath5fe19732019-06-20 15:09:30 +01006307 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6308 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006310
Gilles Peskine969c5d62019-01-16 15:53:06 +01006311 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 if (!is_kdf_alg_supported(kdf_alg)) {
6313 return PSA_ERROR_NOT_SUPPORTED;
6314 }
John Durkop07cc04a2020-11-16 22:08:34 -08006315
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006316 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306317 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6319 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306320 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6321 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6322 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306323 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306324 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 if (hash_size == 0) {
6326 return PSA_ERROR_NOT_SUPPORTED;
6327 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006328
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006329 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6330 * we might fail later, which is somewhat unfriendly and potentially
6331 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 psa_status_t status = psa_hash_try_support(hash_alg);
6333 if (status != PSA_SUCCESS) {
6334 return status;
6335 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006336 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006337
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6339 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6340 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6341 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006342 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006343#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006344 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6346 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006347 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006348 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006349#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6350 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 operation->capacity = 255 * hash_size;
6352 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006353}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006354
Gilles Peskine449bd832023-01-11 14:50:10 +01006355static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006356{
6357#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 if (alg == PSA_ALG_ECDH) {
6359 return PSA_SUCCESS;
6360 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006361#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006362#if defined(PSA_WANT_ALG_FFDH)
6363 if (alg == PSA_ALG_FFDH) {
6364 return PSA_SUCCESS;
6365 }
6366#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006367 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006369}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006370
6371static int psa_key_derivation_allows_free_form_secret_input(
6372 psa_algorithm_t kdf_alg)
6373{
6374#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6375 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6376 return 0;
6377 }
6378#endif
6379 (void) kdf_alg;
6380 return 1;
6381}
John Durkop07cc04a2020-11-16 22:08:34 -08006382#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006383
Gilles Peskine449bd832023-01-11 14:50:10 +01006384psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6385 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006386{
6387 psa_status_t status;
6388
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 if (operation->alg != 0) {
6390 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006391 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006392
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6394 return PSA_ERROR_INVALID_ARGUMENT;
6395 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6396#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6397 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6398 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6399 status = psa_key_agreement_try_support(ka_alg);
6400 if (status != PSA_SUCCESS) {
6401 return status;
6402 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006403 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6404 return PSA_ERROR_INVALID_ARGUMENT;
6405 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6407#else
6408 return PSA_ERROR_NOT_SUPPORTED;
6409#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6410 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6411#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6412 status = psa_key_derivation_setup_kdf(operation, alg);
6413#else
6414 return PSA_ERROR_NOT_SUPPORTED;
6415#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6416 } else {
6417 return PSA_ERROR_INVALID_ARGUMENT;
6418 }
6419
6420 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006421 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 }
6423 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006424}
6425
Przemek Stekiel69c46792022-06-10 12:59:51 +02006426#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006427static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6428 psa_algorithm_t kdf_alg,
6429 psa_key_derivation_step_t step,
6430 const uint8_t *data,
6431 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006432{
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006434 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006436 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006437#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6439 return PSA_ERROR_INVALID_ARGUMENT;
6440 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006441#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 if (hkdf->state != HKDF_STATE_INIT) {
6443 return PSA_ERROR_BAD_STATE;
6444 } else {
6445 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6446 hash_alg,
6447 data, data_length);
6448 if (status != PSA_SUCCESS) {
6449 return status;
6450 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006451 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006453 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006454 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006455#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006457 /* We shouldn't be in different state as HKDF_EXPAND only allows
6458 * two inputs: SECRET (this case) and INFO which does not modify
6459 * the state. It could happen only if the hkdf
6460 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 if (hkdf->state != HKDF_STATE_INIT) {
6462 return PSA_ERROR_BAD_STATE;
6463 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006464
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006465 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6467 return PSA_ERROR_INVALID_ARGUMENT;
6468 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006469
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 memcpy(hkdf->prk, data, data_length);
6471 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006472#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006473 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006474 /* HKDF: If no salt was provided, use an empty salt.
6475 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006477#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6479 return PSA_ERROR_BAD_STATE;
6480 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006481#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6483 hash_alg,
6484 NULL, 0);
6485 if (status != PSA_SUCCESS) {
6486 return status;
6487 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006488 hkdf->state = HKDF_STATE_STARTED;
6489 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 if (hkdf->state != HKDF_STATE_STARTED) {
6491 return PSA_ERROR_BAD_STATE;
6492 }
6493 status = psa_mac_update(&hkdf->hmac,
6494 data, data_length);
6495 if (status != PSA_SUCCESS) {
6496 return status;
6497 }
6498 status = psa_mac_sign_finish(&hkdf->hmac,
6499 hkdf->prk,
6500 sizeof(hkdf->prk),
6501 &data_length);
6502 if (status != PSA_SUCCESS) {
6503 return status;
6504 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006505 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006506
Gilles Peskine2b522db2019-04-12 15:11:49 +02006507 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006508 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006509#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006510 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006511 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006512 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006513 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006515#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006516 {
6517 /* Block 0 is empty, and the next block will be
6518 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006520 }
6521
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006523 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006524#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6526 return PSA_ERROR_INVALID_ARGUMENT;
6527 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006528#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006529#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6531 hkdf->state == HKDF_STATE_INIT) {
6532 return PSA_ERROR_BAD_STATE;
6533 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006534#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 if (hkdf->state == HKDF_STATE_OUTPUT) {
6536 return PSA_ERROR_BAD_STATE;
6537 }
6538 if (hkdf->info_set) {
6539 return PSA_ERROR_BAD_STATE;
6540 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006541 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 if (data_length != 0) {
6543 hkdf->info = mbedtls_calloc(1, data_length);
6544 if (hkdf->info == NULL) {
6545 return PSA_ERROR_INSUFFICIENT_MEMORY;
6546 }
6547 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006548 }
6549 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006551 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006553 }
6554}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006555#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006556
John Durkop07cc04a2020-11-16 22:08:34 -08006557#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6558 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006559static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6560 const uint8_t *data,
6561 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006562{
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6564 return PSA_ERROR_BAD_STATE;
6565 }
Janos Follathf08e2652019-06-13 09:05:41 +01006566
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 if (data_length != 0) {
6568 prf->seed = mbedtls_calloc(1, data_length);
6569 if (prf->seed == NULL) {
6570 return PSA_ERROR_INSUFFICIENT_MEMORY;
6571 }
Janos Follathf08e2652019-06-13 09:05:41 +01006572
Gilles Peskine449bd832023-01-11 14:50:10 +01006573 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006574 prf->seed_length = data_length;
6575 }
Janos Follathf08e2652019-06-13 09:05:41 +01006576
Gilles Peskine43f958b2020-12-13 14:55:14 +01006577 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006578
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006580}
6581
Gilles Peskine449bd832023-01-11 14:50:10 +01006582static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6583 const uint8_t *data,
6584 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006585{
Gilles Peskine449bd832023-01-11 14:50:10 +01006586 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6587 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6588 return PSA_ERROR_BAD_STATE;
6589 }
Janos Follath81550542019-06-13 14:26:34 +01006590
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 if (data_length != 0) {
6592 prf->secret = mbedtls_calloc(1, data_length);
6593 if (prf->secret == NULL) {
6594 return PSA_ERROR_INSUFFICIENT_MEMORY;
6595 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006596
Gilles Peskine449bd832023-01-11 14:50:10 +01006597 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006598 prf->secret_length = data_length;
6599 }
Janos Follath81550542019-06-13 14:26:34 +01006600
Gilles Peskine43f958b2020-12-13 14:55:14 +01006601 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006602
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006604}
6605
Gilles Peskine449bd832023-01-11 14:50:10 +01006606static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6607 const uint8_t *data,
6608 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006609{
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6611 return PSA_ERROR_BAD_STATE;
6612 }
Janos Follath63028dd2019-06-13 09:15:47 +01006613
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 if (data_length != 0) {
6615 prf->label = mbedtls_calloc(1, data_length);
6616 if (prf->label == NULL) {
6617 return PSA_ERROR_INSUFFICIENT_MEMORY;
6618 }
Janos Follath63028dd2019-06-13 09:15:47 +01006619
Gilles Peskine449bd832023-01-11 14:50:10 +01006620 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006621 prf->label_length = data_length;
6622 }
Janos Follath63028dd2019-06-13 09:15:47 +01006623
Gilles Peskine43f958b2020-12-13 14:55:14 +01006624 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006625
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006627}
6628
Gilles Peskine449bd832023-01-11 14:50:10 +01006629static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6630 psa_key_derivation_step_t step,
6631 const uint8_t *data,
6632 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006633{
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006635 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006637 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006639 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006641 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006642 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006643 }
6644}
John Durkop07cc04a2020-11-16 22:08:34 -08006645#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6646 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6647
6648#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6649static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6650 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006651 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006653{
6654 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006655 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6656 4 + data_length + prf->other_secret_length :
6657 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006658
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6660 return PSA_ERROR_INVALID_ARGUMENT;
6661 }
John Durkop07cc04a2020-11-16 22:08:34 -08006662
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 uint8_t *pms = mbedtls_calloc(1, pms_len);
6664 if (pms == NULL) {
6665 return PSA_ERROR_INSUFFICIENT_MEMORY;
6666 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006667 uint8_t *cur = pms;
6668
6669 /* pure-PSK:
6670 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006671 *
6672 * The premaster secret is formed as follows: if the PSK is N octets
6673 * long, concatenate a uint16 with the value N, N zero octets, a second
6674 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006675 *
6676 * mixed-PSK:
6677 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6678 * follows: concatenate a uint16 with the length of the other secret,
6679 * the other secret itself, uint16 with the length of PSK, and the
6680 * PSK itself.
6681 * For details please check:
6682 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6683 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6684 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006685 */
6686
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6688 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6689 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6690 if (prf->other_secret_length != 0) {
6691 memcpy(cur, prf->other_secret, prf->other_secret_length);
6692 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006693 cur += prf->other_secret_length;
6694 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006695 } else {
6696 *cur++ = MBEDTLS_BYTE_1(data_length);
6697 *cur++ = MBEDTLS_BYTE_0(data_length);
6698 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006699 cur += data_length;
6700 }
6701
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 *cur++ = MBEDTLS_BYTE_1(data_length);
6703 *cur++ = MBEDTLS_BYTE_0(data_length);
6704 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006705 cur += data_length;
6706
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006707 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006708
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006709 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006710 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006711}
Janos Follath6660f0e2019-06-17 08:44:03 +01006712
Przemek Stekiele47201b2022-04-19 13:53:28 +02006713static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6714 psa_tls12_prf_key_derivation_t *prf,
6715 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006716 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006717{
Gilles Peskine449bd832023-01-11 14:50:10 +01006718 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6719 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006720 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006721
6722 if (data_length != 0) {
6723 prf->other_secret = mbedtls_calloc(1, data_length);
6724 if (prf->other_secret == NULL) {
6725 return PSA_ERROR_INSUFFICIENT_MEMORY;
6726 }
6727
6728 memcpy(prf->other_secret, data, data_length);
6729 prf->other_secret_length = data_length;
6730 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006731 prf->other_secret_length = 0;
6732 }
6733
6734 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6735
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006737}
6738
Janos Follath6660f0e2019-06-17 08:44:03 +01006739static psa_status_t psa_tls12_prf_psk_to_ms_input(
6740 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006741 psa_key_derivation_step_t step,
6742 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006744{
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006746 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 return psa_tls12_prf_psk_to_ms_set_key(prf,
6748 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006749 break;
6750 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6752 data,
6753 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006754 break;
6755 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006757 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006758
Przemek Stekiele47201b2022-04-19 13:53:28 +02006759 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006760}
John Durkop07cc04a2020-11-16 22:08:34 -08006761#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006762
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006763#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6764static psa_status_t psa_tls12_ecjpake_to_pms_input(
6765 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006766 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006767 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006769{
Gilles Peskine449bd832023-01-11 14:50:10 +01006770 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6771 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6772 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006773 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006774
6775 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 if (data[0] != 0x04) {
6777 return PSA_ERROR_INVALID_ARGUMENT;
6778 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006779
6780 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006782
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006784}
6785#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306786
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306787#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306788static psa_status_t psa_pbkdf2_set_input_cost(
6789 psa_pbkdf2_key_derivation_t *pbkdf2,
6790 psa_key_derivation_step_t step,
6791 uint64_t data)
6792{
6793 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6794 return PSA_ERROR_INVALID_ARGUMENT;
6795 }
6796
6797 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6798 return PSA_ERROR_BAD_STATE;
6799 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306800
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306801 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306802 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306803 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306804
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306805 if (data == 0) {
6806 return PSA_ERROR_INVALID_ARGUMENT;
6807 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306808
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306809 pbkdf2->input_cost = data;
6810 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6811
6812 return PSA_SUCCESS;
6813}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306814
6815static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6816 const uint8_t *data,
6817 size_t data_length)
6818{
Gilles Peskineead17662023-08-20 22:02:51 +02006819 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6820 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6821 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6822 /* Appending to existing salt. No state change. */
6823 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306824 return PSA_ERROR_BAD_STATE;
6825 }
6826
Gilles Peskineca57d782023-07-20 19:08:06 +02006827 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006828 /* Appending an empty string, nothing to do. */
6829 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306830 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306831
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306832 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6833 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306834 return PSA_ERROR_INSUFFICIENT_MEMORY;
6835 }
6836
Gilles Peskineead17662023-08-20 22:02:51 +02006837 if (pbkdf2->salt_length != 0) {
6838 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6839 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306840 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306841 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306842 mbedtls_free(pbkdf2->salt);
6843 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306844 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306845 return PSA_SUCCESS;
6846}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306847
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306848#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306849static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306850 const uint8_t *input,
6851 size_t input_len,
6852 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306853 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306854{
6855 psa_status_t status = PSA_SUCCESS;
6856 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6857 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306858 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306859 } else {
6860 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306861 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306862 }
6863 return status;
6864}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306865#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306866
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306867#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306868static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6869 size_t input_len,
6870 uint8_t *output,
6871 size_t *output_len)
6872{
6873 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306874 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306875 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306876 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306877 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6878 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6879 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306880 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306881 * mac_size as the driver function sets mac_output_length = mac_size
6882 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306883 status = psa_driver_wrapper_mac_compute(&attributes,
6884 zeros, sizeof(zeros),
6885 PSA_ALG_CMAC, input, input_len,
6886 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306887 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6888 128U,
6889 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306890 output_len);
6891 } else {
6892 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306893 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306894 }
6895 return status;
6896}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306897#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306898
6899static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306900 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306901 const uint8_t *data,
6902 size_t data_length)
6903{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306904 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306905 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6906 return PSA_ERROR_BAD_STATE;
6907 }
6908
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306909#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306910 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6911 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6912 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6913 pbkdf2->password,
6914 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306915 } else
6916#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6917#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6918 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306919 status = psa_pbkdf2_cmac_set_password(data, data_length,
6920 pbkdf2->password,
6921 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306922 } else
6923#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6924 {
6925 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306926 }
6927
6928 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6929
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306930 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306931}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306932
6933static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306934 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306935 psa_key_derivation_step_t step,
6936 const uint8_t *data,
6937 size_t data_length)
6938{
6939 switch (step) {
6940 case PSA_KEY_DERIVATION_INPUT_SALT:
6941 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6942 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306943 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306944 default:
6945 return PSA_ERROR_INVALID_ARGUMENT;
6946 }
6947}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306948#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306949
Gilles Peskineb8965192019-09-24 16:21:10 +02006950/** Check whether the given key type is acceptable for the given
6951 * input step of a key derivation.
6952 *
6953 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6954 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6955 * Both secret and non-secret inputs can alternatively have the type
6956 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6957 * that the input was passed as a buffer rather than via a key object.
6958 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006959static int psa_key_derivation_check_input_type(
6960 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006961 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006962{
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006964 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 if (key_type == PSA_KEY_TYPE_DERIVE) {
6966 return PSA_SUCCESS;
6967 }
6968 if (key_type == PSA_KEY_TYPE_NONE) {
6969 return PSA_SUCCESS;
6970 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006971 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006972 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 if (key_type == PSA_KEY_TYPE_DERIVE) {
6974 return PSA_SUCCESS;
6975 }
6976 if (key_type == PSA_KEY_TYPE_NONE) {
6977 return PSA_SUCCESS;
6978 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006979 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006980 case PSA_KEY_DERIVATION_INPUT_LABEL:
6981 case PSA_KEY_DERIVATION_INPUT_SALT:
6982 case PSA_KEY_DERIVATION_INPUT_INFO:
6983 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6985 return PSA_SUCCESS;
6986 }
6987 if (key_type == PSA_KEY_TYPE_NONE) {
6988 return PSA_SUCCESS;
6989 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006990 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306991 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6992 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6993 return PSA_SUCCESS;
6994 }
6995 if (key_type == PSA_KEY_TYPE_DERIVE) {
6996 return PSA_SUCCESS;
6997 }
6998 if (key_type == PSA_KEY_TYPE_NONE) {
6999 return PSA_SUCCESS;
7000 }
7001 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007002 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007003 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007004}
7005
Janos Follathb80a94e2019-06-12 15:54:46 +01007006static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007007 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007008 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007009 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007010 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007012{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007013 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007015
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 status = psa_key_derivation_check_input_type(step, key_type);
7017 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007018 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007019 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007020
Przemek Stekiel69c46792022-06-10 12:59:51 +02007021#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7023 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7024 step, data, data_length);
7025 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007026#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007027#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007028 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7029 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7030 step, data, data_length);
7031 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007032#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7033#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007034 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7035 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7036 step, data, data_length);
7037 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007038#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007039#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007041 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7043 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007044#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307045#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307046 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307047 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7048 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307049 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307050#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007051 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007052 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007053 (void) data;
7054 (void) data_length;
7055 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007057 }
7058
Gilles Peskine224b0d62019-09-23 18:13:17 +02007059exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 if (status != PSA_SUCCESS) {
7061 psa_key_derivation_abort(operation);
7062 }
7063 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007064}
7065
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307066static psa_status_t psa_key_derivation_input_integer_internal(
7067 psa_key_derivation_operation_t *operation,
7068 psa_key_derivation_step_t step,
7069 uint64_t value)
7070{
7071 psa_status_t status;
7072 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7073
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307074#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307075 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307076 status = psa_pbkdf2_set_input_cost(
7077 &operation->ctx.pbkdf2, step, value);
7078 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307079#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307080 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307081 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307082 (void) value;
7083 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307084 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307085 }
7086
7087 if (status != PSA_SUCCESS) {
7088 psa_key_derivation_abort(operation);
7089 }
7090 return status;
7091}
7092
Janos Follath51f4a0f2019-06-14 11:35:55 +01007093psa_status_t psa_key_derivation_input_bytes(
7094 psa_key_derivation_operation_t *operation,
7095 psa_key_derivation_step_t step,
7096 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007098{
Gilles Peskine449bd832023-01-11 14:50:10 +01007099 return psa_key_derivation_input_internal(operation, step,
7100 PSA_KEY_TYPE_NONE,
7101 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007102}
7103
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307104psa_status_t psa_key_derivation_input_integer(
7105 psa_key_derivation_operation_t *operation,
7106 psa_key_derivation_step_t step,
7107 uint64_t value)
7108{
7109 return psa_key_derivation_input_integer_internal(operation, step, value);
7110}
7111
Janos Follath51f4a0f2019-06-14 11:35:55 +01007112psa_status_t psa_key_derivation_input_key(
7113 psa_key_derivation_operation_t *operation,
7114 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007116{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007117 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007118 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007119 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007120
Ronald Cron5c522922020-11-14 16:35:34 +01007121 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7123 if (status != PSA_SUCCESS) {
7124 psa_key_derivation_abort(operation);
7125 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007126 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007127
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307128 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7129 * permission to output to a key object. */
7130 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7131 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007132 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007134
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 status = psa_key_derivation_input_internal(operation,
7136 step, slot->attr.type,
7137 slot->key.data,
7138 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007139
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007141
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007143}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007144
7145
7146
7147/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007148/* Key agreement */
7149/****************************************************************/
7150
Gilles Peskine449bd832023-01-11 14:50:10 +01007151psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7152 const uint8_t *key_buffer,
7153 size_t key_buffer_size,
7154 psa_algorithm_t alg,
7155 const uint8_t *peer_key,
7156 size_t peer_key_length,
7157 uint8_t *shared_secret,
7158 size_t shared_secret_size,
7159 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007160{
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007162#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007163 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7165 key_buffer_size, alg,
7166 peer_key, peer_key_length,
7167 shared_secret,
7168 shared_secret_size,
7169 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007170#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007171
7172#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7173 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007174 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007175 peer_key,
7176 peer_key_length,
7177 key_buffer,
7178 key_buffer_size,
7179 shared_secret,
7180 shared_secret_size,
7181 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007182#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7183
Gilles Peskine01d718c2018-09-18 12:01:02 +02007184 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007185 (void) attributes;
7186 (void) key_buffer;
7187 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007188 (void) peer_key;
7189 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007190 (void) shared_secret;
7191 (void) shared_secret_size;
7192 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007194 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007195}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007196
Aditya Deshpande17845b82022-10-13 17:21:01 +01007197/** Internal function for raw key agreement
7198 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007199 * to the driver's implementation if a driver is present.
7200 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007201 * (psa_key_agreement_raw_builtin).
7202 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007203static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7204 psa_key_slot_t *private_key,
7205 const uint8_t *peer_key,
7206 size_t peer_key_length,
7207 uint8_t *shared_secret,
7208 size_t shared_secret_size,
7209 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007210{
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7212 return PSA_ERROR_NOT_SUPPORTED;
7213 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007214
7215 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007217 };
7218
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 return psa_driver_wrapper_key_agreement(&attributes,
7220 private_key->key.data,
7221 private_key->key.bytes, alg,
7222 peer_key, peer_key_length,
7223 shared_secret,
7224 shared_secret_size,
7225 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007226}
7227
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007228/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007229 * to potentially free embedded data structures and wipe confidential data.
7230 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007231static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7232 psa_key_derivation_step_t step,
7233 psa_key_slot_t *private_key,
7234 const uint8_t *peer_key,
7235 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007236{
7237 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007238 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007239 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007241
7242 /* Step 1: run the secret agreement algorithm to generate the shared
7243 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 status = psa_key_agreement_raw_internal(ka_alg,
7245 private_key,
7246 peer_key, peer_key_length,
7247 shared_secret,
7248 sizeof(shared_secret),
7249 &shared_secret_length);
7250 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007251 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007253
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007254 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007255 * the shared secret. A shared secret is permitted wherever a key
7256 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 status = psa_key_derivation_input_internal(operation, step,
7258 PSA_KEY_TYPE_DERIVE,
7259 shared_secret,
7260 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007261exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7263 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007264}
7265
Gilles Peskine449bd832023-01-11 14:50:10 +01007266psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7267 psa_key_derivation_step_t step,
7268 mbedtls_svc_key_id_t private_key,
7269 const uint8_t *peer_key,
7270 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007271{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007272 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007273 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007274 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007275
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7277 return PSA_ERROR_INVALID_ARGUMENT;
7278 }
Ronald Cron5c522922020-11-14 16:35:34 +01007279 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7281 if (status != PSA_SUCCESS) {
7282 return status;
7283 }
7284 status = psa_key_agreement_internal(operation, step,
7285 slot,
7286 peer_key, peer_key_length);
7287 if (status != PSA_SUCCESS) {
7288 psa_key_derivation_abort(operation);
7289 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007290 /* If a private key has been added as SECRET, we allow the derived
7291 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007292 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007293 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007295 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007296
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007298
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007300}
7301
Gilles Peskine449bd832023-01-11 14:50:10 +01007302psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7303 mbedtls_svc_key_id_t private_key,
7304 const uint8_t *peer_key,
7305 size_t peer_key_length,
7306 uint8_t *output,
7307 size_t output_size,
7308 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007309{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007310 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007311 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007312 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007313 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007314
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007316 status = PSA_ERROR_INVALID_ARGUMENT;
7317 goto exit;
7318 }
Ronald Cron5c522922020-11-14 16:35:34 +01007319 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007320 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7321 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007322 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007324
Gilles Peskine3e561302022-04-14 00:17:15 +02007325 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7326 * for the output size. The PSA specification only guarantees that this
7327 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7328 * but it might be nice to allow smaller buffers if the output fits.
7329 * At the time of writing this comment, with only ECDH implemented,
7330 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7331 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7332 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007333 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7335 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007336 status = PSA_ERROR_BUFFER_TOO_SMALL;
7337 goto exit;
7338 }
7339
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 status = psa_key_agreement_raw_internal(alg, slot,
7341 peer_key, peer_key_length,
7342 output, output_size,
7343 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007344
7345exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007346 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007347 /* If an error happens and is not handled properly, the output
7348 * may be used as a key to protect sensitive data. Arrange for such
7349 * a key to be random, which is likely to result in decryption or
7350 * verification errors. This is better than filling the buffer with
7351 * some constant data such as zeros, which would result in the data
7352 * being protected with a reproducible, easily knowable key.
7353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007355 *output_length = output_size;
7356 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007357
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007359
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007361}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007362
7363
Gilles Peskine30524eb2020-11-13 17:02:26 +01007364
Gilles Peskine86a440b2018-11-12 18:39:40 +01007365/****************************************************************/
7366/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007367/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007368
Gilles Peskine672a7712023-04-28 21:00:28 +02007369#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7370#include "entropy_poll.h"
7371#endif
7372
Gilles Peskine30524eb2020-11-13 17:02:26 +01007373/** Initialize the PSA random generator.
7374 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007375static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007376{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007377#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007379#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7380
Gilles Peskine30524eb2020-11-13 17:02:26 +01007381 /* Set default configuration if
7382 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007383 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007384 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 }
7386 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007387 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007389
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007391#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7392 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7393 /* The PSA entropy injection feature depends on using NV seed as an entropy
7394 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007395 mbedtls_entropy_add_source(&rng->entropy,
7396 mbedtls_nv_seed_poll, NULL,
7397 MBEDTLS_ENTROPY_BLOCK_SIZE,
7398 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007399#endif
7400
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007402#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007403}
7404
7405/** Deinitialize the PSA random generator.
7406 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007407static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007408{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007409#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007411#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7413 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007414#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007415}
7416
7417/** Seed the PSA random generator.
7418 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007419static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007420{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007421#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7422 /* Do nothing: the external RNG seeds itself. */
7423 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007425#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007426 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7428 drbg_seed, sizeof(drbg_seed) - 1);
7429 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007430#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007431}
7432
Gilles Peskine449bd832023-01-11 14:50:10 +01007433psa_status_t psa_generate_random(uint8_t *output,
7434 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007435{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007436 GUARD_MODULE_INITIALIZED;
7437
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007438#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7439
7440 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7442 output, output_size,
7443 &output_length);
7444 if (status != PSA_SUCCESS) {
7445 return status;
7446 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007447 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007448 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 if (output_length != output_size) {
7450 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7451 }
7452 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007453
7454#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7455
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007457 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7459 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7460 output_size);
7461 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7462 output, request_size);
7463 if (ret != 0) {
7464 return mbedtls_to_psa_error(ret);
7465 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007466 output_size -= request_size;
7467 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007468 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007470#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007471}
7472
Gilles Peskine8814fc42020-12-14 15:33:44 +01007473/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007474 *
7475 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7476 * `psa_generate_random(...)`. The state parameter is ignored since the
7477 * PSA API doesn't support passing an explicit state.
7478 *
7479 * In the non-external case, psa_generate_random() calls an
7480 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7481 * and semantics as mbedtls_psa_get_random(). As an optimization,
7482 * instead of doing this back-and-forth between the PSA API and the
7483 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7484 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007485 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007486#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7487int mbedtls_psa_get_random(void *p_rng,
7488 unsigned char *output,
7489 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007490{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007491 /* This function takes a pointer to the RNG state because that's what
7492 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7493 * its own state internally and doesn't let the caller access that state.
7494 * So we just ignore the state parameter, and in practice we'll pass
7495 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007496 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 psa_status_t status = psa_generate_random(output, output_size);
7498 if (status == PSA_SUCCESS) {
7499 return 0;
7500 } else {
7501 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7502 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007503}
7504#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7505
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007506#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007507psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7508 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007509{
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 if (global_data.initialized) {
7511 return PSA_ERROR_NOT_PERMITTED;
7512 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007513
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7515 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7516 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7517 return PSA_ERROR_INVALID_ARGUMENT;
7518 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007519
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007521}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007522#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007523
Ronald Cron3772afe2021-02-08 16:10:05 +01007524/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007525 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007526 * \param type The key type
7527 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007528 *
7529 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007530 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007531 * \retval #PSA_ERROR_INVALID_ARGUMENT
7532 * The size in bits of the key is not valid.
7533 * \retval #PSA_ERROR_NOT_SUPPORTED
7534 * The type and/or the size in bits of the key or the combination of
7535 * the two is not supported.
7536 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007537static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007539{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007540 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007541
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 if (key_type_is_raw_bytes(type)) {
7543 status = psa_validate_unstructured_key_bit_size(type, bits);
7544 if (status != PSA_SUCCESS) {
7545 return status;
7546 }
7547 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007548#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7550 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7551 return PSA_ERROR_NOT_SUPPORTED;
7552 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007553 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007554 return PSA_ERROR_NOT_SUPPORTED;
7555 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007556
Ronald Cron01b2aba2020-10-05 09:42:02 +02007557 /* Accept only byte-aligned keys, for the same reasons as
7558 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 if (bits % 8 != 0) {
7560 return PSA_ERROR_NOT_SUPPORTED;
7561 }
7562 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007563#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007564
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007565#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007567 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 return PSA_SUCCESS;
7569 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007570#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007571
Valerio Settia55f0422023-07-10 15:34:41 +02007572#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007573 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007574 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007575 return PSA_ERROR_NOT_SUPPORTED;
7576 }
7577 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007578#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007579 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007581 }
7582
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007584}
7585
Ronald Cron55ed0592020-10-05 10:30:40 +02007586psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007587 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007589{
7590 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007591 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007592
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 if ((attributes->domain_parameters == NULL) &&
7594 (attributes->domain_parameters_size != 0)) {
7595 return PSA_ERROR_INVALID_ARGUMENT;
7596 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007597
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 if (key_type_is_raw_bytes(type)) {
7599 status = psa_generate_random(key_buffer, key_buffer_size);
7600 if (status != PSA_SUCCESS) {
7601 return status;
7602 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007603
David Brown12ca5032021-02-11 11:02:00 -07007604#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 if (type == PSA_KEY_TYPE_DES) {
7606 psa_des_set_key_parity(key_buffer, key_buffer_size);
7607 }
David Brown8107e312021-02-12 08:08:46 -07007608#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007610
Valerio Setti76df8c12023-07-11 14:11:28 +02007611#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7613 return mbedtls_psa_rsa_generate_key(attributes,
7614 key_buffer,
7615 key_buffer_size,
7616 key_buffer_length);
7617 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007618#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007619
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007620#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7622 return mbedtls_psa_ecp_generate_key(attributes,
7623 key_buffer,
7624 key_buffer_size,
7625 key_buffer_length);
7626 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007627#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007628
Valerio Settia55f0422023-07-10 15:34:41 +02007629#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007630 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7631 return mbedtls_psa_ffdh_generate_key(attributes,
7632 key_buffer,
7633 key_buffer_size,
7634 key_buffer_length);
7635 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007636#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007637 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 (void) key_buffer_length;
7639 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007640 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007641
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007643}
Darryl Green0c6575a2018-11-07 16:05:30 +00007644
Gilles Peskine449bd832023-01-11 14:50:10 +01007645psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7646 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007647{
7648 psa_status_t status;
7649 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007650 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007651 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007652
Ronald Cron81709fc2020-11-14 12:10:32 +01007653 *key = MBEDTLS_SVC_KEY_ID_INIT;
7654
Gilles Peskine0f84d622019-09-12 19:03:13 +02007655 /* Reject any attempt to create a zero-length key so that we don't
7656 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 if (psa_get_key_bits(attributes) == 0) {
7658 return PSA_ERROR_INVALID_ARGUMENT;
7659 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007660
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007661 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007662 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7663 return PSA_ERROR_INVALID_ARGUMENT;
7664 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007665
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7667 &slot, &driver);
7668 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007669 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007670 }
Gilles Peskine11792082019-08-06 18:36:36 +02007671
Ronald Cron977c2472020-10-13 08:32:21 +02007672 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307673 * storage ( thus not in the case of generating a key in a secure element
7674 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7675 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 if (slot->key.data == NULL) {
7677 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7678 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007679 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 attributes->core.type, attributes->core.bits);
7681 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007682 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007684
7685 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 attributes->core.type,
7687 attributes->core.bits);
7688 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007689 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007690 attributes, &key_buffer_size);
7691 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007692 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007693 }
Ronald Cron977c2472020-10-13 08:32:21 +02007694 }
Ronald Cron977c2472020-10-13 08:32:21 +02007695
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7697 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007698 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 }
Ronald Cron977c2472020-10-13 08:32:21 +02007700 }
7701
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 status = psa_driver_wrapper_generate_key(attributes,
7703 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007704
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 if (status != PSA_SUCCESS) {
7706 psa_remove_key_data_from_memory(slot);
7707 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007708
Gilles Peskine11792082019-08-06 18:36:36 +02007709exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 if (status == PSA_SUCCESS) {
7711 status = psa_finish_key_creation(slot, driver, key);
7712 }
7713 if (status != PSA_SUCCESS) {
7714 psa_fail_key_creation(slot, driver);
7715 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007716
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007718}
7719
Gilles Peskinee59236f2018-01-27 23:32:46 +01007720/****************************************************************/
7721/* Module setup */
7722/****************************************************************/
7723
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007724#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007725psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007726 void (* entropy_init)(mbedtls_entropy_context *ctx),
7727 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007728{
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7730 return PSA_ERROR_BAD_STATE;
7731 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007732 global_data.rng.entropy_init = entropy_init;
7733 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007735}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007736#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007737
Gilles Peskine449bd832023-01-11 14:50:10 +01007738void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007739{
Gilles Peskine449bd832023-01-11 14:50:10 +01007740 psa_wipe_all_key_slots();
7741 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7742 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007743 }
7744 /* Wipe all remaining data, including configuration.
7745 * In particular, this sets all state indicator to the value
7746 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007747 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007748
7749 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007751}
7752
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007753#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7754/** Recover a transaction that was interrupted by a power failure.
7755 *
7756 * This function is called during initialization, before psa_crypto_init()
7757 * returns. If this function returns a failure status, the initialization
7758 * fails.
7759 */
7760static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007761 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007762{
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007764 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7765 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 /* TODO - fall through to the failure case until this
7767 * is implemented.
7768 * https://github.com/ARMmbed/mbed-crypto/issues/218
7769 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007770 default:
7771 /* We found an unsupported transaction in the storage.
7772 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007773 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007774 }
7775}
7776#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7777
Gilles Peskine449bd832023-01-11 14:50:10 +01007778psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007779{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007780 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007781
Gilles Peskinec6b69072018-11-20 21:42:52 +01007782 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 if (global_data.initialized != 0) {
7784 return PSA_SUCCESS;
7785 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007786
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007787 /* Init drivers */
7788 status = psa_driver_wrapper_init();
7789 if (status != PSA_SUCCESS) {
7790 goto exit;
7791 }
7792 global_data.drivers_initialized = 1;
7793
Gilles Peskine30524eb2020-11-13 17:02:26 +01007794 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007795 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007796 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007797 status = mbedtls_psa_random_seed(&global_data.rng);
7798 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007799 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007801 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007802
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 status = psa_initialize_key_slots();
7804 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01007805 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007807
Gilles Peskine4b734222019-07-24 15:56:31 +02007808#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 status = psa_crypto_load_transaction();
7810 if (status == PSA_SUCCESS) {
7811 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7812 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007813 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 }
7815 status = psa_crypto_stop_transaction();
7816 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007817 /* There's no transaction to complete. It's all good. */
7818 status = PSA_SUCCESS;
7819 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007820#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007821
Gilles Peskinec6b69072018-11-20 21:42:52 +01007822 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007823 global_data.initialized = 1;
7824
7825exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 if (status != PSA_SUCCESS) {
7827 mbedtls_psa_crypto_free();
7828 }
7829 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007830}
7831
Yanray Wangffc3c482023-07-11 12:01:04 +08007832#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007833psa_status_t psa_crypto_driver_pake_get_password_len(
7834 const psa_crypto_driver_pake_inputs_t *inputs,
7835 size_t *password_len)
7836{
7837 if (inputs->password_len == 0) {
7838 return PSA_ERROR_BAD_STATE;
7839 }
7840
7841 *password_len = inputs->password_len;
7842
7843 return PSA_SUCCESS;
7844}
7845
7846psa_status_t psa_crypto_driver_pake_get_password(
7847 const psa_crypto_driver_pake_inputs_t *inputs,
7848 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7849{
7850 if (inputs->password_len == 0) {
7851 return PSA_ERROR_BAD_STATE;
7852 }
7853
7854 if (buffer_size < inputs->password_len) {
7855 return PSA_ERROR_BUFFER_TOO_SMALL;
7856 }
7857
7858 memcpy(buffer, inputs->password, inputs->password_len);
7859 *buffer_length = inputs->password_len;
7860
7861 return PSA_SUCCESS;
7862}
7863
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007864psa_status_t psa_crypto_driver_pake_get_user_len(
7865 const psa_crypto_driver_pake_inputs_t *inputs,
7866 size_t *user_len)
7867{
7868 if (inputs->user_len == 0) {
7869 return PSA_ERROR_BAD_STATE;
7870 }
7871
7872 *user_len = inputs->user_len;
7873
7874 return PSA_SUCCESS;
7875}
7876
7877psa_status_t psa_crypto_driver_pake_get_user(
7878 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007879 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007880{
7881 if (inputs->user_len == 0) {
7882 return PSA_ERROR_BAD_STATE;
7883 }
7884
Przemek Stekielc0e62502023-03-14 11:49:36 +01007885 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007886 return PSA_ERROR_BUFFER_TOO_SMALL;
7887 }
7888
Przemek Stekielc0e62502023-03-14 11:49:36 +01007889 memcpy(user_id, inputs->user, inputs->user_len);
7890 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007891
7892 return PSA_SUCCESS;
7893}
7894
7895psa_status_t psa_crypto_driver_pake_get_peer_len(
7896 const psa_crypto_driver_pake_inputs_t *inputs,
7897 size_t *peer_len)
7898{
7899 if (inputs->peer_len == 0) {
7900 return PSA_ERROR_BAD_STATE;
7901 }
7902
7903 *peer_len = inputs->peer_len;
7904
7905 return PSA_SUCCESS;
7906}
7907
7908psa_status_t psa_crypto_driver_pake_get_peer(
7909 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007910 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007911{
7912 if (inputs->peer_len == 0) {
7913 return PSA_ERROR_BAD_STATE;
7914 }
7915
Przemek Stekielc0e62502023-03-14 11:49:36 +01007916 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007917 return PSA_ERROR_BUFFER_TOO_SMALL;
7918 }
7919
Przemek Stekielc0e62502023-03-14 11:49:36 +01007920 memcpy(peer_id, inputs->peer, inputs->peer_len);
7921 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007922
7923 return PSA_SUCCESS;
7924}
7925
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007926psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7927 const psa_crypto_driver_pake_inputs_t *inputs,
7928 psa_pake_cipher_suite_t *cipher_suite)
7929{
7930 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7931 return PSA_ERROR_BAD_STATE;
7932 }
7933
7934 *cipher_suite = inputs->cipher_suite;
7935
7936 return PSA_SUCCESS;
7937}
7938
Neil Armstronga7d08c32022-06-01 18:21:20 +02007939psa_status_t psa_pake_setup(
7940 psa_pake_operation_t *operation,
7941 const psa_pake_cipher_suite_t *cipher_suite)
7942{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007943 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007944
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007945 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007946 status = PSA_ERROR_BAD_STATE;
7947 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007948 }
7949
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007950 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007951 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007952 status = PSA_ERROR_INVALID_ARGUMENT;
7953 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007954 }
7955
Przemek Stekiel51eac532022-12-07 11:04:51 +01007956 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7957
Przemek Stekiele12ed362022-12-21 12:54:46 +01007958 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007959 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7960 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007961 operation->data.inputs.cipher_suite = *cipher_suite;
7962
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007963#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007964 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007965 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007966 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007967
David Horstmann16f01512023-06-14 17:21:07 +01007968 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007969 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007970 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007971#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007972 {
7973 status = PSA_ERROR_NOT_SUPPORTED;
7974 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007975 }
7976
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007977 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7978
Przemek Stekiel51eac532022-12-07 11:04:51 +01007979 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007980exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007981 psa_pake_abort(operation);
7982 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007983}
7984
7985psa_status_t psa_pake_set_password_key(
7986 psa_pake_operation_t *operation,
7987 mbedtls_svc_key_id_t password)
7988{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007989 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007990 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7991 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007992 psa_key_attributes_t attributes;
7993 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007994
Przemek Stekiel51eac532022-12-07 11:04:51 +01007995 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007996 status = PSA_ERROR_BAD_STATE;
7997 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007998 }
7999
Przemek Stekiel6c764412022-11-22 14:05:12 +01008000 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8001 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008002 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008003 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008004 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008005 }
8006
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008007 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008008 .core = slot->attr
8009 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008010
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008011 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008012
Przemek Stekiel51eac532022-12-07 11:04:51 +01008013 if (type != PSA_KEY_TYPE_PASSWORD &&
8014 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8015 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008016 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008017 }
8018
Przemek Stekiel51eac532022-12-07 11:04:51 +01008019 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8020 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008021 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008022 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008023 }
8024
8025 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8026 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008027 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008028exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008029 if (status != PSA_SUCCESS) {
8030 psa_pake_abort(operation);
8031 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008032 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008033 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008034}
8035
8036psa_status_t psa_pake_set_user(
8037 psa_pake_operation_t *operation,
8038 const uint8_t *user_id,
8039 size_t user_id_len)
8040{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008041 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008042
8043 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008044 status = PSA_ERROR_BAD_STATE;
8045 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008046 }
8047
Przemek Stekiel51eac532022-12-07 11:04:51 +01008048 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008049 status = PSA_ERROR_INVALID_ARGUMENT;
8050 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008051 }
8052
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008053 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008054 status = PSA_ERROR_BAD_STATE;
8055 goto exit;
8056 }
8057
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008058 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8059 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008060 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8061 goto exit;
8062 }
8063
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008064 memcpy(operation->data.inputs.user, user_id, user_id_len);
8065 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008066
8067 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008068exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008069 psa_pake_abort(operation);
8070 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008071}
8072
8073psa_status_t psa_pake_set_peer(
8074 psa_pake_operation_t *operation,
8075 const uint8_t *peer_id,
8076 size_t peer_id_len)
8077{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008078 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008079
8080 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008081 status = PSA_ERROR_BAD_STATE;
8082 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008083 }
8084
Przemek Stekiel51eac532022-12-07 11:04:51 +01008085 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008086 status = PSA_ERROR_INVALID_ARGUMENT;
8087 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008088 }
8089
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008090 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008091 status = PSA_ERROR_BAD_STATE;
8092 goto exit;
8093 }
8094
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008095 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8096 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008097 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8098 goto exit;
8099 }
8100
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008101 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8102 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008103
8104 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008105exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008106 psa_pake_abort(operation);
8107 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008108}
8109
8110psa_status_t psa_pake_set_role(
8111 psa_pake_operation_t *operation,
8112 psa_pake_role_t role)
8113{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008114 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008115
Przemek Stekiel51eac532022-12-07 11:04:51 +01008116 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008117 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008118 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008119 }
8120
Przemek Stekiel09104b82023-03-06 14:11:51 +01008121 switch (operation->alg) {
8122#if defined(PSA_WANT_ALG_JPAKE)
8123 case PSA_ALG_JPAKE:
8124 if (role == PSA_PAKE_ROLE_NONE) {
8125 return PSA_SUCCESS;
8126 }
8127 status = PSA_ERROR_INVALID_ARGUMENT;
8128 break;
8129#endif
8130 default:
8131 (void) role;
8132 status = PSA_ERROR_NOT_SUPPORTED;
8133 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008134 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008135exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008136 psa_pake_abort(operation);
8137 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008138}
8139
David Horstmanne7f21e62023-05-12 18:17:21 +01008140/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008141#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008142static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008143 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008144{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008145 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008146 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008147 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008148
David Horstmann024e5c52023-06-14 15:48:21 +01008149 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008150 is_x1 = (stage->outputs < 1);
8151 } else {
8152 is_x1 = (stage->inputs < 1);
8153 }
8154
David Horstmann74a3d8c2023-06-14 18:28:19 +01008155 key_share_step = is_x1 ?
8156 PSA_JPAKE_X1_STEP_KEY_SHARE :
8157 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008158 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008159 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8160 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8161 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8162 } else {
8163 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008164 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008165 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008166}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008167#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008168
Przemek Stekiel2797d372022-12-22 11:19:22 +01008169static psa_status_t psa_pake_complete_inputs(
8170 psa_pake_operation_t *operation)
8171{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008172 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008173 /* Create copy of the inputs on stack as inputs share memory
8174 with the driver context which will be setup by the driver. */
8175 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008176
Przemek Stekielfde11282023-03-13 16:06:09 +01008177 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008178 return PSA_ERROR_BAD_STATE;
8179 }
8180
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008181 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008182 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8183 return PSA_ERROR_BAD_STATE;
8184 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008185 }
8186
Przemek Stekiel18620a32023-01-17 16:34:52 +01008187 /* Clear driver context */
8188 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8189
8190 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008191
8192 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008193 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008194
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008195 /* User and peer are translated to role. */
8196 mbedtls_free(inputs.user);
8197 mbedtls_free(inputs.peer);
8198
Przemek Stekiel2797d372022-12-22 11:19:22 +01008199 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008200#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008201 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008202 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008203 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008204#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008205 {
8206 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008207 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008208 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008209 return status;
8210}
8211
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008212#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008213static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008214 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008215 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008216 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008217{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008218 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8219 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8220 step != PSA_PAKE_STEP_ZK_PROOF) {
8221 return PSA_ERROR_INVALID_ARGUMENT;
8222 }
8223
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008224 psa_jpake_computation_stage_t *computation_stage =
8225 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008226
David Horstmann5da95602023-06-08 15:37:12 +01008227 if (computation_stage->round != PSA_JPAKE_FIRST &&
8228 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008229 return PSA_ERROR_BAD_STATE;
8230 }
8231
David Horstmanne7f21e62023-05-12 18:17:21 +01008232 /* Check that the step we are given is the one we were expecting */
8233 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008234 return PSA_ERROR_BAD_STATE;
8235 }
8236
David Horstmanne7f21e62023-05-12 18:17:21 +01008237 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8238 computation_stage->inputs == 0 &&
8239 computation_stage->outputs == 0) {
8240 /* Start of the round, so function decides whether we are inputting
8241 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008242 computation_stage->io_mode = io_mode;
8243 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008244 /* Middle of the round so the mode we are in must match the function
8245 * called by the user */
8246 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008247 }
8248
8249 return PSA_SUCCESS;
8250}
8251
David Horstmanne7f21e62023-05-12 18:17:21 +01008252static psa_status_t psa_jpake_epilogue(
8253 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008254 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008255{
David Horstmanne7f21e62023-05-12 18:17:21 +01008256 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008257 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008258
David Horstmanne7f21e62023-05-12 18:17:21 +01008259 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8260 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008261 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008262 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008263 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008264 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008265 }
8266 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008267 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008268 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008269 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008270 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008271 }
8272 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008273 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8274 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008275 /* End of a round, move to the next round */
8276 stage->inputs = 0;
8277 stage->outputs = 0;
8278 stage->round++;
8279 }
8280 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008281 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008282 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008283 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008284 return PSA_SUCCESS;
8285}
David Horstmanne7f21e62023-05-12 18:17:21 +01008286
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008287#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008288
Neil Armstronga7d08c32022-06-01 18:21:20 +02008289psa_status_t psa_pake_output(
8290 psa_pake_operation_t *operation,
8291 psa_pake_step_t step,
8292 uint8_t *output,
8293 size_t output_size,
8294 size_t *output_length)
8295{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008296 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008297 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008298 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008299
8300 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008301 status = psa_pake_complete_inputs(operation);
8302 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008303 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008304 }
8305 }
8306
8307 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008308 status = PSA_ERROR_BAD_STATE;
8309 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008310 }
8311
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008312 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008313 status = PSA_ERROR_INVALID_ARGUMENT;
8314 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008315 }
8316
Przemek Stekiele12ed362022-12-21 12:54:46 +01008317 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008318#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008319 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008320 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008321 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008322 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008323 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008324 driver_step = convert_jpake_computation_stage_to_driver_step(
8325 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008326 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008327#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008328 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008329 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008330 status = PSA_ERROR_NOT_SUPPORTED;
8331 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008332 }
8333
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008334 status = psa_driver_wrapper_pake_output(operation, driver_step,
8335 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008336
8337 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008338 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008339 }
8340
8341 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008342#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008343 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008344 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008345 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008346 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008347 }
8348 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008349#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008350 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008351 status = PSA_ERROR_NOT_SUPPORTED;
8352 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008353 }
8354
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008355 return PSA_SUCCESS;
8356exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008357 psa_pake_abort(operation);
8358 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008359}
8360
8361psa_status_t psa_pake_input(
8362 psa_pake_operation_t *operation,
8363 psa_pake_step_t step,
8364 const uint8_t *input,
8365 size_t input_length)
8366{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008367 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008368 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008369 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8370 operation->primitive,
8371 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008372
8373 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008374 status = psa_pake_complete_inputs(operation);
8375 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008376 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008377 }
8378 }
8379
8380 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008381 status = PSA_ERROR_BAD_STATE;
8382 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008383 }
8384
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008385 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008386 status = PSA_ERROR_INVALID_ARGUMENT;
8387 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008388 }
8389
Przemek Stekiele12ed362022-12-21 12:54:46 +01008390 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008391#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008392 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008393 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008394 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008395 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008396 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008397 driver_step = convert_jpake_computation_stage_to_driver_step(
8398 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008399 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008400#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008401 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008402 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008403 status = PSA_ERROR_NOT_SUPPORTED;
8404 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008405 }
8406
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008407 status = psa_driver_wrapper_pake_input(operation, driver_step,
8408 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008409
8410 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008411 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008412 }
8413
8414 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008415#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008416 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008417 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008418 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008419 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008420 }
8421 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008422#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008423 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008424 status = PSA_ERROR_NOT_SUPPORTED;
8425 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008426 }
8427
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008428 return PSA_SUCCESS;
8429exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008430 psa_pake_abort(operation);
8431 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008432}
8433
8434psa_status_t psa_pake_get_implicit_key(
8435 psa_pake_operation_t *operation,
8436 psa_key_derivation_operation_t *output)
8437{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008438 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008439 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008440 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008441 size_t shared_key_len = 0;
8442
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008443 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008444 status = PSA_ERROR_BAD_STATE;
8445 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008446 }
8447
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008448#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008449 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008450 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008451 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008452 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008453 status = PSA_ERROR_BAD_STATE;
8454 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008455 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008456 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008457#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008458 {
8459 status = PSA_ERROR_NOT_SUPPORTED;
8460 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008461 }
8462
Przemek Stekiel0c781802022-11-29 14:53:13 +01008463 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8464 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008465 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008466 &shared_key_len);
8467
8468 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008469 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008470 }
8471
8472 status = psa_key_derivation_input_bytes(output,
8473 PSA_KEY_DERIVATION_INPUT_SECRET,
8474 shared_key,
8475 shared_key_len);
8476
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008477 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008478exit:
8479 abort_status = psa_pake_abort(operation);
8480 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008481}
8482
8483psa_status_t psa_pake_abort(
8484 psa_pake_operation_t *operation)
8485{
Przemek Stekield69dca92023-01-31 19:59:20 +01008486 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008487
Przemek Stekield69dca92023-01-31 19:59:20 +01008488 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008489 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008490 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008491
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008492 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8493 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008494 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008495 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008496 }
8497 if (operation->data.inputs.user != NULL) {
8498 mbedtls_free(operation->data.inputs.user);
8499 }
8500 if (operation->data.inputs.peer != NULL) {
8501 mbedtls_free(operation->data.inputs.peer);
8502 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008503 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008504 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008505
Przemek Stekield69dca92023-01-31 19:59:20 +01008506 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008507}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008508#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008509
David Horstmann00d7a042023-12-07 18:39:17 +00008510/* Memory copying test hooks. These are called before input copy, after input
8511 * copy, before output copy and after output copy, respectively.
8512 * They are used by memory-poisoning tests to temporarily unpoison buffers
8513 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008514#if defined(MBEDTLS_TEST_HOOKS)
8515void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8516void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8517void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8518void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8519#endif
David Horstmannfde97392023-10-30 20:29:43 +00008520
David Horstmann1b7279a2023-11-15 15:18:30 +00008521/** Copy from an input buffer to a local copy.
8522 *
8523 * \param[in] input Pointer to input buffer.
8524 * \param[in] input_len Length of the input buffer.
8525 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8526 * \param[out] input_copy_len Length of the local copy buffer.
8527 * \return #PSA_SUCCESS, if the buffer was successfully
8528 * copied.
8529 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8530 * copy is too small to hold contents of the
8531 * input buffer.
8532 */
8533MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008534psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8535 uint8_t *input_copy, size_t input_copy_len)
8536{
8537 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008538 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008539 }
8540
David Horstmann372b8bb2023-11-24 16:21:04 +00008541#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008542 if (psa_input_pre_copy_hook != NULL) {
8543 psa_input_pre_copy_hook(input, input_len);
8544 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008545#endif
8546
David Horstmann777e7412023-11-15 17:33:47 +00008547 if (input_len > 0) {
8548 memcpy(input_copy, input, input_len);
8549 }
David Horstmannfde97392023-10-30 20:29:43 +00008550
David Horstmann372b8bb2023-11-24 16:21:04 +00008551#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008552 if (psa_input_post_copy_hook != NULL) {
8553 psa_input_post_copy_hook(input, input_len);
8554 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008555#endif
8556
David Horstmannfde97392023-10-30 20:29:43 +00008557 return PSA_SUCCESS;
8558}
8559
David Horstmann1b7279a2023-11-15 15:18:30 +00008560/** Copy from a local output buffer into a user-supplied one.
8561 *
8562 * \param[in] output_copy Pointer to a local buffer containing the output.
8563 * \param[in] output_copy_len Length of the local buffer.
8564 * \param[out] output Pointer to user-supplied output buffer.
8565 * \param[out] output_len Length of the user-supplied output buffer.
8566 * \return #PSA_SUCCESS, if the buffer was successfully
8567 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008568 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008569 * user-supplied output buffer is too small to
8570 * hold the contents of the local buffer.
8571 */
8572MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008573psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8574 uint8_t *output, size_t output_len)
8575{
8576 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008577 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008578 }
David Horstmann777e7412023-11-15 17:33:47 +00008579
David Horstmann372b8bb2023-11-24 16:21:04 +00008580#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008581 if (psa_output_pre_copy_hook != NULL) {
8582 psa_output_pre_copy_hook(output, output_len);
8583 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008584#endif
8585
David Horstmann777e7412023-11-15 17:33:47 +00008586 if (output_copy_len > 0) {
8587 memcpy(output, output_copy, output_copy_len);
8588 }
8589
David Horstmann372b8bb2023-11-24 16:21:04 +00008590#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008591 if (psa_output_post_copy_hook != NULL) {
8592 psa_output_post_copy_hook(output, output_len);
8593 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008594#endif
8595
David Horstmann8978f5c2023-10-30 20:37:12 +00008596 return PSA_SUCCESS;
8597}
8598
David Horstmannf1734052023-11-20 17:15:32 +00008599psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8600 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008601{
8602 psa_status_t status;
8603
David Horstmann9db14482023-11-23 15:50:37 +00008604 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008605
David Horstmannc5cc1c32023-11-15 18:11:26 +00008606 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008607 return PSA_SUCCESS;
8608 }
8609
David Horstmannf1734052023-11-20 17:15:32 +00008610 local_input->buffer = mbedtls_calloc(input_len, 1);
8611 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008612 /* Since we dealt with the zero-length case above, we know that
8613 * a NULL return value means a failure of allocation. */
8614 return PSA_ERROR_INSUFFICIENT_MEMORY;
8615 }
David Horstmannf1734052023-11-20 17:15:32 +00008616 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008617
David Horstmannf1734052023-11-20 17:15:32 +00008618 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008619
8620 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008621 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008622 if (status != PSA_SUCCESS) {
8623 goto error;
8624 }
8625
8626 return PSA_SUCCESS;
8627
8628error:
David Horstmannf1734052023-11-20 17:15:32 +00008629 mbedtls_free(local_input->buffer);
8630 local_input->buffer = NULL;
8631 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008632 return status;
8633}
8634
David Horstmannf1734052023-11-20 17:15:32 +00008635void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008636{
David Horstmannf1734052023-11-20 17:15:32 +00008637 mbedtls_free(local_input->buffer);
8638 local_input->buffer = NULL;
8639 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008640}
8641
David Horstmann89875a42023-11-20 12:54:09 +00008642psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8643 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008644{
David Horstmann9db14482023-11-23 15:50:37 +00008645 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008646
David Horstmannc5cc1c32023-11-15 18:11:26 +00008647 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008648 return PSA_SUCCESS;
8649 }
David Horstmann89875a42023-11-20 12:54:09 +00008650 local_output->buffer = mbedtls_calloc(output_len, 1);
8651 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008652 /* Since we dealt with the zero-length case above, we know that
8653 * a NULL return value means a failure of allocation. */
8654 return PSA_ERROR_INSUFFICIENT_MEMORY;
8655 }
David Horstmann89875a42023-11-20 12:54:09 +00008656 local_output->length = output_len;
8657 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008658
8659 return PSA_SUCCESS;
8660}
8661
David Horstmann89875a42023-11-20 12:54:09 +00008662psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008663{
David Horstmannc335a4e2023-11-15 15:57:32 +00008664 psa_status_t status;
8665
David Horstmann89875a42023-11-20 12:54:09 +00008666 if (local_output->buffer == NULL) {
8667 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008668 return PSA_SUCCESS;
8669 }
David Horstmann89875a42023-11-20 12:54:09 +00008670 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008671 /* We have an internal copy but nothing to copy back to. */
8672 return PSA_ERROR_CORRUPTION_DETECTED;
8673 }
8674
David Horstmann89875a42023-11-20 12:54:09 +00008675 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8676 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008677 if (status != PSA_SUCCESS) {
8678 return status;
8679 }
David Horstmann9467ea32023-11-08 17:44:18 +00008680
David Horstmann89875a42023-11-20 12:54:09 +00008681 mbedtls_free(local_output->buffer);
8682 local_output->buffer = NULL;
8683 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008684
8685 return PSA_SUCCESS;
8686}
8687
Gilles Peskinee59236f2018-01-27 23:32:46 +01008688#endif /* MBEDTLS_PSA_CRYPTO_C */