blob: 159b3c5bd497d7131a6f8b261e2097b0ea18f53d [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskinee59236f2018-01-27 23:32:46 +01007 */
8
Gilles Peskinedb09ef62020-06-03 01:43:33 +02009#include "common.h"
Ronald Cronafbc7ed2023-01-24 16:02:04 +010010#include "psa_crypto_core_common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010011
12#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030013
John Durkop07cc04a2020-11-16 22:08:34 -080014#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
15#include "check_crypto_config.h"
16#endif
17
Gilles Peskinee59236f2018-01-27 23:32:46 +010018#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010019#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010020
Ronald Crond6d28882020-12-14 14:56:02 +010021#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010022#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010023#include "psa_crypto_invasive.h"
Xiaokang Qiane9c39c42023-08-09 08:50:19 +000024#include "psa_crypto_driver_wrappers.h"
Xiaokang Qianfe9666b2023-09-11 10:36:20 +000025#include "psa_crypto_driver_wrappers_no_static.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010026#include "psa_crypto_ecp.h"
Przemek Stekiel359f4622022-12-05 14:11:55 +010027#include "psa_crypto_ffdh.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010028#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010029#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010030#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010031#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020033#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020034#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010035#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010036/* Include internal declarations that are useful for implementing persistently
37 * stored keys. */
38#include "psa_crypto_storage.h"
39
Gilles Peskineb2b64d32020-12-14 16:43:58 +010040#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010041
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include <stdlib.h>
43#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010045
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010046#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020047#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000048#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020049#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010050#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020051#include "mbedtls/chacha20.h"
52#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010053#include "mbedtls/cipher.h"
54#include "mbedtls/ccm.h"
55#include "mbedtls/cmac.h"
Dave Rodgman78701152023-08-29 14:20:18 +010056#include "mbedtls/constant_time.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020058#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010059#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010060#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/error.h"
62#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/md5.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010064#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000065#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010066#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000067#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010069#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/sha1.h"
71#include "mbedtls/sha256.h"
72#include "mbedtls/sha512.h"
Valerio Setti384fbde2024-01-02 13:26:40 +010073#include "mbedtls/psa_util.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020075#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
76 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
77 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020078#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020079#endif
80
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010081/****************************************************************/
82/* Global data, support functions and library management */
83/****************************************************************/
84
Gilles Peskine449bd832023-01-11 14:50:10 +010085static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020088}
89
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010090/* Values for psa_global_data_t::rng_state */
91#define RNG_NOT_INITIALIZED 0
92#define RNG_INITIALIZED 1
93#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010094
Gilles Peskine449bd832023-01-11 14:50:10 +010095typedef struct {
Dave Rodgman864f5942023-08-16 18:04:44 +010096 uint8_t initialized;
97 uint8_t rng_state;
98 uint8_t drivers_initialized;
Gilles Peskine2d8a1822021-11-08 22:20:03 +010099 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100100} psa_global_data_t;
101
102static psa_global_data_t global_data;
103
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100104#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
105mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
106 &global_data.rng.drbg;
107#endif
108
itayzafrir0adf0fc2018-09-06 16:24:41 +0300109#define GUARD_MODULE_INITIALIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (global_data.initialized == 0) \
111 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300112
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100113int psa_can_do_hash(psa_algorithm_t hash_alg)
114{
115 (void) hash_alg;
116 return global_data.drivers_initialized;
117}
Valerio Settic6f004f2023-12-12 11:27:36 +0100118
Valerio Setti1fff4f22023-12-28 14:19:34 +0100119int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg)
Valerio Settic6f004f2023-12-12 11:27:36 +0100120{
Valerio Setti1fff4f22023-12-28 14:19:34 +0100121 (void) key_type;
Valerio Settic6f004f2023-12-12 11:27:36 +0100122 (void) cipher_alg;
123 return global_data.drivers_initialized;
124}
125
126
Valerio Settia55f0422023-07-10 15:34:41 +0200127#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200128 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200129 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200130static int psa_is_dh_key_size_valid(size_t bits)
131{
Valerio Setti504a1022024-01-17 15:19:30 +0100132 switch (bits) {
133#if defined(PSA_WANT_DH_RFC7919_2048)
134 case 2048:
135 return 1;
136#endif /* PSA_WANT_DH_RFC7919_2048 */
137#if defined(PSA_WANT_DH_RFC7919_3072)
138 case 3072:
139 return 1;
140#endif /* PSA_WANT_DH_RFC7919_3072 */
141#if defined(PSA_WANT_DH_RFC7919_4096)
142 case 4096:
143 return 1;
144#endif /* PSA_WANT_DH_RFC7919_4096 */
145#if defined(PSA_WANT_DH_RFC7919_6144)
146 case 6144:
147 return 1;
148#endif /* PSA_WANT_DH_RFC7919_6144 */
149#if defined(PSA_WANT_DH_RFC7919_8192)
150 case 8192:
151 return 1;
152#endif /* PSA_WANT_DH_RFC7919_8192 */
153 default:
154 return 0;
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200155 }
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200156}
Valerio Settia55f0422023-07-10 15:34:41 +0200157#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200158 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200159 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100160
Gilles Peskine449bd832023-01-11 14:50:10 +0100161psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100162{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100163 /* Mbed TLS error codes can combine a high-level error code and a
164 * low-level error code. The low-level error usually reflects the
165 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 int low_level_ret = -(-ret & 0x007f);
167 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100168 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100170
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100171#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100172 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
173 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100175 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
176 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100177#endif
178
179#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200180 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
181 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
182 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
183 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
184 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200186 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100187 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200188 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100190#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200191
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100192#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000193 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100194 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100195 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100196#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100197
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100198#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100199 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100201 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100203#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100204
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100205#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200206 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100208#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200209
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100210#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200211 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200213 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100214 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100215#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200216
Dave Rodgman509b5672023-08-16 19:26:23 +0100217#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100218 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100220 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100222 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100223 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100224 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100226 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100228 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100230 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100232#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100233
Gilles Peskine449bd832023-01-11 14:50:10 +0100234#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
235 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100236 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
237 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100238 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100239 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100240 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
241 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100243 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100245#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100246
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100247#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100248 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100250#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100251
Gilles Peskinee59236f2018-01-27 23:32:46 +0100252 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
253 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
254 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100256
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100257#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100258 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200260 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100262 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100264#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100265
Gilles Peskine82e57d12020-11-13 21:31:17 +0100266#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100268 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
269 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100270 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100272 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
273 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100275 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100276 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100277#endif
278
Dave Rodgmandea266f2023-08-31 11:52:43 +0100279#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100280 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100282 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100284 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100286#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100287 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100289#endif
290#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100291
Dave Rodgman509b5672023-08-16 19:26:23 +0100292#if defined(MBEDTLS_BIGNUM_C)
293#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100294 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100296#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100297 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100299 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100301 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100303 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100305 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100307 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100309 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100311#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100312
Dave Rodgman509b5672023-08-16 19:26:23 +0100313#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100314 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100316 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
317 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100319#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
320 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100321 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100323#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100324 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
325 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100327 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100329 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
330 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100332 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100334 case MBEDTLS_ERR_PK_INVALID_ALG:
335 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
336 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100338 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200340 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100342#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100343
Gilles Peskineff2d2002019-05-06 15:26:23 +0200344 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200346 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200348
Dave Rodgman509b5672023-08-16 19:26:23 +0100349#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100350 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100352 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100354 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100356 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100358 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
359 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100361 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100363 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100364 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100365 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100367#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200368
Dave Rodgman1dab4452023-09-01 09:59:51 +0100369#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300370 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300371 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300373 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300375 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300377 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
378 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300380 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100382 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100384
Dave Rodgman509b5672023-08-16 19:26:23 +0100385#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000386 case MBEDTLS_ERR_ECP_IN_PROGRESS:
387 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100388#endif
389#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000390
Janos Follatha13b9052019-11-22 12:48:59 +0000391 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300393
Gilles Peskinee59236f2018-01-27 23:32:46 +0100394 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100396 }
397}
398
Paul Elliottdc42ca82023-02-24 18:11:59 +0000399/**
400 * \brief For output buffers which contain "tags"
401 * (outputs that may be checked for validity like
402 * hashes, MACs and signatures), fill the unused
403 * part of the output buffer (the whole buffer on
404 * error, the trailing part on success) with
405 * something that isn't a valid tag (barring an
406 * attack on the tag and deliberately-crafted
407 * input), in case the caller doesn't check the
408 * return status properly.
409 *
410 * \param output_buffer Pointer to buffer to wipe. May not be NULL
411 * unless \p output_buffer_size is zero.
412 * \param status Status of function called to generate
413 * output_buffer originally
414 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
415 * could be NULL.
416 * \param output_buffer_length Length of data written to output_buffer, must be
417 * less than \p output_buffer_size
418 */
419static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000420 size_t output_buffer_size, size_t output_buffer_length)
421{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000422 size_t offset = 0;
423
424 if (output_buffer_size == 0) {
425 /* If output_buffer_size is 0 then we have nothing to do. We must not
426 call memset because output_buffer may be NULL in this case */
427 return;
428 }
429
430 if (status == PSA_SUCCESS) {
431 offset = output_buffer_length;
432 }
433
434 memset(output_buffer + offset, '!', output_buffer_size - offset);
435}
436
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200437
Gilles Peskine449bd832023-01-11 14:50:10 +0100438psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
439 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200440{
441 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200443 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200444 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200445 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200446 case PSA_KEY_TYPE_PASSWORD:
447 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200448 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100449#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200450 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100451 if (bits != 128 && bits != 192 && bits != 256) {
452 return PSA_ERROR_INVALID_ARGUMENT;
453 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200454 break;
455#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200456#if defined(PSA_WANT_KEY_TYPE_ARIA)
457 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 if (bits != 128 && bits != 192 && bits != 256) {
459 return PSA_ERROR_INVALID_ARGUMENT;
460 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200461 break;
462#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100463#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200464 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100465 if (bits != 128 && bits != 192 && bits != 256) {
466 return PSA_ERROR_INVALID_ARGUMENT;
467 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200468 break;
469#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100470#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200471 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 if (bits != 64 && bits != 128 && bits != 192) {
473 return PSA_ERROR_INVALID_ARGUMENT;
474 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200475 break;
476#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100477#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200478 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 if (bits != 256) {
480 return PSA_ERROR_INVALID_ARGUMENT;
481 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200482 break;
483#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200484 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200486 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 if (bits % 8 != 0) {
488 return PSA_ERROR_INVALID_ARGUMENT;
489 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200492}
493
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100494/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100495 *
Steven Cooremancd640932021-03-08 12:00:27 +0100496 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
497 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100498 *
499 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100500 * \param[in] key_type The key type of the key to be used with the
501 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100502 *
503 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100504 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100505 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100506 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100507 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100508MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100509 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100511{
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 if (PSA_ALG_IS_HMAC(algorithm)) {
513 if (key_type == PSA_KEY_TYPE_HMAC) {
514 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100515 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100516 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100517
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
519 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
520 * key. */
521 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
522 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
523 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
524 * the block length (larger than 1) for block ciphers. */
525 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
526 return PSA_SUCCESS;
527 }
528 }
529 }
530
531 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100532}
533
Gilles Peskine449bd832023-01-11 14:50:10 +0100534psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
535 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200536{
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 if (slot->key.data != NULL) {
538 return PSA_ERROR_ALREADY_EXISTS;
539 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200540
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 slot->key.data = mbedtls_calloc(1, buffer_length);
542 if (slot->key.data == NULL) {
543 return PSA_ERROR_INSUFFICIENT_MEMORY;
544 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200545
Ronald Cronea0f8a62020-11-25 17:52:23 +0100546 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200548}
549
Gilles Peskine449bd832023-01-11 14:50:10 +0100550psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
551 const uint8_t *data,
552 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200553{
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 psa_status_t status = psa_allocate_buffer_to_slot(slot,
555 data_length);
556 if (status != PSA_SUCCESS) {
557 return status;
558 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200559
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 memcpy(slot->key.data, data, data_length);
561 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200562}
563
Ronald Crona0fe59f2020-11-29 11:14:53 +0100564psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100565 const psa_key_attributes_t *attributes,
566 const uint8_t *data, size_t data_length,
567 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100569{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100570 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
571 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100572
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200573 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 if (data_length == 0) {
575 return PSA_ERROR_NOT_SUPPORTED;
576 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200577
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 if (key_type_is_raw_bytes(type)) {
579 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200580
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
582 *bits);
583 if (status != PSA_SUCCESS) {
584 return status;
585 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200586
Ronald Crondd04d422020-11-28 15:14:42 +0100587 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100589 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return PSA_SUCCESS;
593 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200594#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200595 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100596 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200597 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Valerio Setti504a1022024-01-17 15:19:30 +0100598 return PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100599 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200600 return mbedtls_psa_ffdh_import_key(attributes,
601 data, data_length,
602 key_buffer, key_buffer_size,
603 key_buffer_length,
604 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100605 }
Valerio Settia55f0422023-07-10 15:34:41 +0200606#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200607 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200608#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
610 if (PSA_KEY_TYPE_IS_ECC(type)) {
611 return mbedtls_psa_ecp_import_key(attributes,
612 data, data_length,
613 key_buffer, key_buffer_size,
614 key_buffer_length,
615 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100616 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200617#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800618 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200619#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
620 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
622 if (PSA_KEY_TYPE_IS_RSA(type)) {
623 return mbedtls_psa_rsa_import_key(attributes,
624 data, data_length,
625 key_buffer, key_buffer_size,
626 key_buffer_length,
627 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200628 }
Valerio Settife478902023-07-25 12:27:19 +0200629#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
630 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800631 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100632 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100633
Gilles Peskine449bd832023-01-11 14:50:10 +0100634 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100635}
636
Gilles Peskinef603c712019-01-19 13:40:11 +0100637/** Calculate the intersection of two algorithm usage policies.
638 *
639 * Return 0 (which allows no operation) on incompatibility.
640 */
641static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100642 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100643 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100644 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100645{
Gilles Peskine549ea862019-05-22 11:45:59 +0200646 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 if (alg1 == alg2) {
648 return alg1;
649 }
Steven Cooreman03488022021-02-18 12:07:20 +0100650 /* If the policies are from the same hash-and-sign family, check
651 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
653 PSA_ALG_IS_SIGN_HASH(alg2) &&
654 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
655 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
656 return alg2;
657 }
658 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
659 return alg1;
660 }
Steven Cooreman03488022021-02-18 12:07:20 +0100661 }
662 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100663 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100664 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
666 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
667 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
668 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
669 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100670 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100671
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100672 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
674 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
675 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
676 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100677 }
678 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
680 (alg1_len <= alg2_len)) {
681 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100682 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
684 (alg2_len <= alg1_len)) {
685 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100686 }
687 }
688 /* If the policies are from the same MAC family, check whether one
689 * of them is a minimum-MAC-length policy. Calculate the most
690 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
692 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
693 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100694 /* Validate the combination of key type and algorithm. Since the base
695 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
697 return 0;
698 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100699
Steven Cooreman31a876d2021-03-03 20:47:40 +0100700 /* Get the (exact or at-least) output lengths for both sides of the
701 * requested intersection. None of the currently supported algorithms
702 * have an output length dependent on the actual key size, so setting it
703 * to a bogus value of 0 is currently OK.
704 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100705 * Note that for at-least-this-length wildcard algorithms, the output
706 * length is set to the shortest allowed length, which allows us to
707 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
709 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100710 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100711
Steven Cooremana1d83222021-02-25 10:20:29 +0100712 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
714 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
715 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100716 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100717
718 /* If only one is an at-least-this-length policy, the intersection would
719 * be the other (fixed-length) policy as long as said fixed length is
720 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
722 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100723 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
725 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100726 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100727
Steven Cooremancd640932021-03-08 12:00:27 +0100728 /* If none of them are wildcards, check whether they define the same tag
729 * length. This is still possible here when one is default-length and
730 * the other specific-length. Ensure to always return the
731 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 if (alg1_len == alg2_len) {
733 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
734 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100735 }
736 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100738}
739
Gilles Peskine449bd832023-01-11 14:50:10 +0100740static int psa_key_algorithm_permits(psa_key_type_t key_type,
741 psa_algorithm_t policy_alg,
742 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200743{
Gilles Peskine549ea862019-05-22 11:45:59 +0200744 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 if (requested_alg == policy_alg) {
746 return 1;
747 }
Steven Cooreman03488022021-02-18 12:07:20 +0100748 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
749 * and requested_alg is the same hash-and-sign family with any hash,
750 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
752 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
753 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
754 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100755 }
756 /* If policy_alg is a wildcard AEAD algorithm of the same base as
757 * the requested algorithm, check the requested tag length to be
758 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 if (PSA_ALG_IS_AEAD(policy_alg) &&
760 PSA_ALG_IS_AEAD(requested_alg) &&
761 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
762 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
763 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
764 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
765 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100766 }
Steven Cooremancd640932021-03-08 12:00:27 +0100767 /* If policy_alg is a MAC algorithm of the same base as the requested
768 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100769 if (PSA_ALG_IS_MAC(policy_alg) &&
770 PSA_ALG_IS_MAC(requested_alg) &&
771 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
772 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100773 /* Validate the combination of key type and algorithm. Since the policy
774 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
776 return 0;
777 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100778
Steven Cooreman31a876d2021-03-03 20:47:40 +0100779 /* Get both the requested output length for the algorithm which is to be
780 * verified, and the default output length for the base algorithm.
781 * Note that none of the currently supported algorithms have an output
782 * length dependent on actual key size, so setting it to a bogus value
783 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100784 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100786 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 key_type, 0,
788 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100789
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100790 /* If the policy is default-length, only allow an algorithm with
791 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
793 return requested_output_length == default_output_length;
794 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100795
796 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100797 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
799 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
800 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100801 }
802
Steven Cooremancd640932021-03-08 12:00:27 +0100803 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
804 * check for the requested MAC length to be equal to or longer than the
805 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100806 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
807 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
808 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100809 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200810 }
Steven Cooremance48e852020-10-05 16:02:45 +0200811 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200812 * a key derivation with that key agreement should also be allowed. This
813 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
815 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
816 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
817 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200818 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100819 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100820 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200821}
822
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100823/** Test whether a policy permits an algorithm.
824 *
825 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100826 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100827 * \note This function requires providing the key type for which the policy is
828 * being validated, since some algorithm policy definitions (e.g. MAC)
829 * have different properties depending on what kind of cipher it is
830 * combined with.
831 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100832 * \retval PSA_SUCCESS When \p alg is a specific algorithm
833 * allowed by the \p policy.
834 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
835 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
836 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100837 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100838static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
839 psa_key_type_t key_type,
840 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100841{
Steven Cooremand788fab2021-02-25 11:29:17 +0100842 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100843 if (alg == 0) {
844 return PSA_ERROR_INVALID_ARGUMENT;
845 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100846
Steven Cooreman7e39f052021-02-23 14:18:32 +0100847 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100848 if (PSA_ALG_IS_WILDCARD(alg)) {
849 return PSA_ERROR_INVALID_ARGUMENT;
850 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100851
Gilles Peskine449bd832023-01-11 14:50:10 +0100852 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
853 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
854 return PSA_SUCCESS;
855 } else {
856 return PSA_ERROR_NOT_PERMITTED;
857 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100858}
859
Gilles Peskinef603c712019-01-19 13:40:11 +0100860/** Restrict a key policy based on a constraint.
861 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100862 * \note This function requires providing the key type for which the policy is
863 * being restricted, since some algorithm policy definitions (e.g. MAC)
864 * have different properties depending on what kind of cipher it is
865 * combined with.
866 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100867 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100868 * \param[in,out] policy The policy to restrict.
869 * \param[in] constraint The policy constraint to apply.
870 *
871 * \retval #PSA_SUCCESS
872 * \c *policy contains the intersection of the original value of
873 * \c *policy and \c *constraint.
874 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100875 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100876 * \c *policy is unchanged.
877 */
878static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100879 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100880 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100881 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100882{
883 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100884 psa_key_policy_algorithm_intersection(key_type, policy->alg,
885 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200886 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100887 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
888 constraint->alg2);
889 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
890 return PSA_ERROR_INVALID_ARGUMENT;
891 }
892 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
893 return PSA_ERROR_INVALID_ARGUMENT;
894 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100895 policy->usage &= constraint->usage;
896 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200897 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100899}
900
Przemek Stekiel061f6942022-11-30 10:51:35 +0100901/** Get the description of a key given its identifier and policy constraints
902 * and lock it.
903 *
904 * The key must have allow all the usage flags set in \p usage. If \p alg is
905 * nonzero, the key must allow operations with this algorithm. If \p alg is
906 * zero, the algorithm is not checked.
907 *
908 * In case of a persistent key, the function loads the description of the key
909 * into a key slot if not already done.
910 *
Ryan Everett098c6652024-01-03 13:03:36 +0000911 * On success, the returned key slot has been registered for reading.
Ryan Everett93cea572024-02-20 18:01:29 +0000912 * It is the responsibility of the caller to then unregister
913 * once they have finished reading the contents of the slot.
914 * The caller unregisters by calling psa_unregister_read() or
915 * psa_unregister_read_under_mutex(). psa_unregister_read() must be called
916 * if and only if the caller already holds the global key slot mutex
917 * (when mutexes are enabled). psa_unregister_read_under_mutex() encapsulates
918 * the unregister with mutex lock and unlock operations.
Przemek Stekiel061f6942022-11-30 10:51:35 +0100919 */
920static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100921 mbedtls_svc_key_id_t key,
922 psa_key_slot_t **p_slot,
923 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100925{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200926 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +0100927 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100928
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 status = psa_get_and_lock_key_slot(key, p_slot);
930 if (status != PSA_SUCCESS) {
931 return status;
932 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200933 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100934
935 /* Enforce that usage policy for the key slot contains all the flags
936 * required by the usage parameter. There is one exception: public
937 * keys can always be exported, so we treat public key objects as
938 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100940 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100941 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200942
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100944 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200945 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100946 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100947
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800948 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 if (alg != 0) {
950 status = psa_key_policy_permits(&slot->attr.policy,
951 slot->attr.type,
952 alg);
953 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100954 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100956 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100957
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200959
960error:
961 *p_slot = NULL;
Ryan Everettfb792ca2024-01-31 13:40:05 +0000962 psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200963
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100965}
Darryl Green940d72c2018-07-13 13:18:51 +0100966
Ronald Cron5c522922020-11-14 16:35:34 +0100967/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200968 *
969 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200970 * available, as opposed to a key in a secure element and/or to be used
971 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200972 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200973 * This is a temporary function that may be used instead of
974 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
975 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200976 *
Ryan Everett098c6652024-01-03 13:03:36 +0000977 * On success, the returned key slot has been registered for reading.
Ryan Everett93cea572024-02-20 18:01:29 +0000978 * It is the responsibility of the caller to then unregister
979 * once they have finished reading the contents of the slot.
980 * The caller unregisters by calling psa_unregister_read() or
981 * psa_unregister_read_under_mutex(). psa_unregister_read() must be called
982 * if and only if the caller already holds the global key slot mutex
983 * (when mutexes are enabled). psa_unregister_read_under_mutex() encapsulates
984 * psa_unregister_read() with mutex lock and unlock operations.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200985 */
Ronald Cron5c522922020-11-14 16:35:34 +0100986static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
987 mbedtls_svc_key_id_t key,
988 psa_key_slot_t **p_slot,
989 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200991{
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
993 usage, alg);
994 if (status != PSA_SUCCESS) {
995 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200996 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200997
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everettfb792ca2024-01-31 13:40:05 +0000999 psa_unregister_read_under_mutex(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 *p_slot = NULL;
1001 return PSA_ERROR_NOT_SUPPORTED;
1002 }
1003
1004 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001005}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001006
Gilles Peskine449bd832023-01-11 14:50:10 +01001007psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001008{
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001010 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001012
Ronald Cronea0f8a62020-11-25 17:52:23 +01001013 slot->key.data = NULL;
1014 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001015
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001017}
1018
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001019/** Completely wipe a slot in memory, including its policy.
1020 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001021psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001022{
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001024
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 /*
1026 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001027 * do our best to report an unexpected amount of registered readers or
1028 * an unexpected state.
1029 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1030 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001031 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1032 * function is called as part of the execution of a test suite, the
1033 * execution of the test suite is stopped in error if the assertion fails.
1034 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001035 switch (slot->state) {
1036 case PSA_SLOT_FULL:
1037 /* In this state psa_wipe_key_slot() must only be called if the
1038 * caller is the last reader. */
1039 case PSA_SLOT_PENDING_DELETION:
1040 /* In this state psa_wipe_key_slot() must only be called if the
1041 * caller is the last reader. */
1042 if (slot->registered_readers != 1) {
1043 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1044 status = PSA_ERROR_CORRUPTION_DETECTED;
1045 }
1046 break;
1047 case PSA_SLOT_FILLING:
1048 /* In this state registered_readers must be 0. */
1049 if (slot->registered_readers != 0) {
1050 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1051 status = PSA_ERROR_CORRUPTION_DETECTED;
1052 }
1053 break;
1054 case PSA_SLOT_EMPTY:
1055 /* The slot is already empty, it cannot be wiped. */
1056 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1057 status = PSA_ERROR_CORRUPTION_DETECTED;
1058 break;
1059 default:
1060 /* The slot's state is invalid. */
1061 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001062 }
1063
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001064 /* Multipart operations may still be using the key. This is safe
1065 * because all multipart operation objects are independent from
1066 * the key slot: if they need to access the key after the setup
1067 * phase, they have a copy of the key. Note that this means that
1068 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001069 /* At this point, key material and other type-specific content has
1070 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001071 * zeroize because the metadata is not particularly sensitive.
1072 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 memset(slot, 0, sizeof(*slot));
1074 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001075}
1076
Gilles Peskine449bd832023-01-11 14:50:10 +01001077psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001078{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001079 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001080 psa_status_t status; /* status of the last operation */
1081 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001082#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1083 psa_se_drv_table_entry_t *driver;
1084#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 if (mbedtls_svc_key_id_is_null(key)) {
1087 return PSA_SUCCESS;
1088 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001089
Ronald Cronf2911112020-10-29 17:51:10 +01001090 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001091 * Get the description of the key in a key slot, and register to read it.
1092 * In the case of a persistent key, this will load the key description
1093 * from persistent memory if not done yet.
1094 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001095 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001096 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 status = psa_get_and_lock_key_slot(key, &slot);
1098 if (status != PSA_SUCCESS) {
1099 return status;
1100 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001101
Ryan Everettc053d962024-01-25 17:56:32 +00001102#if defined(MBEDTLS_THREADING_C)
Ryan Everett763971f2024-01-29 17:13:36 +00001103 /* We cannot unlock between setting the state to PENDING_DELETION
1104 * and destroying the key in storage, as otherwise another thread
1105 * could load the key into a new slot and the key will not be
1106 * fully destroyed. */
Ryan Everettc053d962024-01-25 17:56:32 +00001107 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(
1108 &mbedtls_threading_key_slot_mutex));
1109#endif
Ryan Everett7ed542e2024-01-17 11:39:09 +00001110 /* Set the key slot containing the key description's state to
1111 * PENDING_DELETION. This stops new operations from registering
1112 * to read the slot. Current readers can safely continue to access
1113 * the key within the slot; the last registered reader will
1114 * automatically wipe the slot when they call psa_unregister_read().
1115 * If the key is persistent, we can now delete the copy of the key
1116 * from memory. If the key is opaque, we require the driver to
1117 * deal with the deletion. */
Ryan Everettc053d962024-01-25 17:56:32 +00001118 status = psa_key_slot_state_transition(slot, PSA_SLOT_FULL,
1119 PSA_SLOT_PENDING_DELETION);
1120
1121 if (status != PSA_SUCCESS) {
1122 goto exit;
1123 }
Ronald Cronf2911112020-10-29 17:51:10 +01001124
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001126 /* Refuse the destruction of a read-only key (which may or may not work
1127 * if we attempt it, depending on whether the key is merely read-only
1128 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001129 * Just do the best we can, which is to wipe the copy in memory
1130 * (done in this function's cleanup code). */
1131 overall_status = PSA_ERROR_NOT_PERMITTED;
1132 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001133 }
1134
Gilles Peskine354f7672019-07-12 23:46:38 +02001135#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1137 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001138 /* For a key in a secure element, we need to do three things:
1139 * remove the key file in internal storage, destroy the
1140 * key inside the secure element, and update the driver's
1141 * persistent data. Start a transaction that will encompass these
1142 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001144 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001146 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 status = psa_crypto_save_transaction();
1148 if (status != PSA_SUCCESS) {
1149 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001150 /* We should still try to destroy the key in the secure
1151 * element and the key metadata in storage. This is especially
1152 * important if the error is that the storage is full.
1153 * But how to do it exactly without risking an inconsistent
1154 * state after a reset?
1155 * https://github.com/ARMmbed/mbed-crypto/issues/215
1156 */
1157 overall_status = status;
1158 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001159 }
1160
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 status = psa_destroy_se_key(driver,
1162 psa_key_slot_get_slot_number(slot));
1163 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001164 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001166 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001167#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1168
Darryl Greend49a4992018-06-18 17:27:26 +01001169#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001171 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001172 * The slot will still hold a copy of the key until the last reader
1173 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 status = psa_destroy_persistent_key(slot->attr.id);
1175 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001176 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 }
Darryl Greend49a4992018-06-18 17:27:26 +01001178 }
1179#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001180
Gilles Peskinefc762652019-07-22 19:30:34 +02001181#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 if (driver != NULL) {
1183 status = psa_save_se_persistent_data(driver);
1184 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001185 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001186 }
1187 status = psa_crypto_stop_transaction();
1188 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001189 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001191 }
1192#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1193
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001194exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001195 /* Unregister from reading the slot. If we are the last active reader
1196 * then this will wipe the slot. */
1197 status = psa_unregister_read(slot);
1198 /* Prioritize CORRUPTION_DETECTED from unregistering over
1199 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001201 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001202 }
Ryan Everettc053d962024-01-25 17:56:32 +00001203
1204#if defined(MBEDTLS_THREADING_C)
Ryan Everett7fee4f72024-02-09 14:11:27 +00001205 /* Don't overwrite existing errors if the unlock fails. */
1206 status = overall_status;
Ryan Everettc053d962024-01-25 17:56:32 +00001207 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1208 &mbedtls_threading_key_slot_mutex));
1209#endif
1210
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001212}
1213
Valerio Settib2bcedb2023-07-10 11:24:00 +02001214#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001215 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001216static psa_status_t psa_get_rsa_public_exponent(
1217 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001218 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001219{
1220 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001221 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001222 uint8_t *buffer = NULL;
1223 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1227 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001228 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 }
1230 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001231 /* It's the default value, which is reported as an empty string,
1232 * so there's nothing to do. */
1233 goto exit;
1234 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 buflen = mbedtls_mpi_size(&mpi);
1237 buffer = mbedtls_calloc(1, buflen);
1238 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001239 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1240 goto exit;
1241 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1243 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001244 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001246 attributes->domain_parameters = buffer;
1247 attributes->domain_parameters_size = buflen;
1248
1249exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001250 mbedtls_mpi_free(&mpi);
1251 if (ret != 0) {
1252 mbedtls_free(buffer);
1253 }
1254 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001255}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001256#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001257 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001258
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001259/** Retrieve all the publicly-accessible attributes of a key.
1260 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001261psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1262 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001263{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001264 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001265 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001266 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001267
Gilles Peskine449bd832023-01-11 14:50:10 +01001268 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001269
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1271 if (status != PSA_SUCCESS) {
1272 return status;
1273 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001274
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001275 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1277 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001278
1279#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1281 psa_set_key_slot_number(attributes,
1282 psa_key_slot_get_slot_number(slot));
1283 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001284#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001285
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001287#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1288 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001289 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001290 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001291 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001292 /* TODO: This is a temporary situation where domain parameters are deprecated,
1293 * but we need it for namely generating an RSA key with a non-default exponent.
1294 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001295 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001297 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001298
Ronald Cron90857082020-11-25 14:58:33 +01001299 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001300 slot->attr.type,
1301 slot->key.data,
1302 slot->key.bytes,
1303 &rsa);
1304 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001305 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001306 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001307
Gilles Peskine449bd832023-01-11 14:50:10 +01001308 status = psa_get_rsa_public_exponent(rsa,
1309 attributes);
1310 mbedtls_rsa_free(rsa);
1311 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001312 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001313 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001314#else
1315 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1316 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1317 attributes->domain_parameters = NULL;
1318 attributes->domain_parameters_size = SIZE_MAX;
1319 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001320#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1321 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001322 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001323 default:
1324 /* Nothing else to do. */
1325 break;
1326 }
1327
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 if (status != PSA_SUCCESS) {
1329 psa_reset_key_attributes(attributes);
1330 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001331
Ryan Everetta103ec92024-01-31 13:59:57 +00001332 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001333
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001335}
1336
Gilles Peskinec8000c02019-08-02 20:15:51 +02001337#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1338psa_status_t psa_get_key_slot_number(
1339 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001340 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001341{
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001343 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 return PSA_SUCCESS;
1345 } else {
1346 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001347 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001348}
1349#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1350
Gilles Peskine449bd832023-01-11 14:50:10 +01001351static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1352 size_t key_buffer_size,
1353 uint8_t *data,
1354 size_t data_size,
1355 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001356{
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 if (key_buffer_size > data_size) {
1358 return PSA_ERROR_BUFFER_TOO_SMALL;
1359 }
1360 memcpy(data, key_buffer, key_buffer_size);
1361 memset(data + key_buffer_size, 0,
1362 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001363 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001365}
1366
Ronald Cron7285cda2020-11-26 14:46:37 +01001367psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001368 const psa_key_attributes_t *attributes,
1369 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001371{
Ronald Crond18b5f82020-11-25 16:46:05 +01001372 psa_key_type_t type = attributes->core.type;
1373
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 if (key_type_is_raw_bytes(type) ||
1375 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001376 PSA_KEY_TYPE_IS_ECC(type) ||
1377 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 return psa_export_key_buffer_internal(
1379 key_buffer, key_buffer_size,
1380 data, data_size, data_length);
1381 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001382 /* This shouldn't happen in the reference implementation, but
1383 it is valid for a special-purpose implementation to omit
1384 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001385 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001386 }
1387}
1388
Gilles Peskine449bd832023-01-11 14:50:10 +01001389psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1390 uint8_t *data,
1391 size_t data_size,
1392 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001393{
1394 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1395 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1396 psa_key_slot_t *slot;
1397
Ronald Crone907e552021-01-18 13:22:38 +01001398 /* Reject a zero-length output buffer now, since this can never be a
1399 * valid key representation. This way we know that data must be a valid
1400 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 if (data_size == 0) {
1402 return PSA_ERROR_BUFFER_TOO_SMALL;
1403 }
Ronald Crone907e552021-01-18 13:22:38 +01001404
Ronald Cron9486f9d2020-11-26 13:36:23 +01001405 /* Set the key to empty now, so that even when there are errors, we always
1406 * set data_length to a value between 0 and data_size. On error, setting
1407 * the key to empty is a good choice because an empty key representation is
1408 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001409 *data_length = 0;
1410
Ronald Cron9486f9d2020-11-26 13:36:23 +01001411 /* Export requires the EXPORT flag. There is an exception for public keys,
1412 * which don't require any flag, but
1413 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1414 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1416 PSA_KEY_USAGE_EXPORT, 0);
1417 if (status != PSA_SUCCESS) {
1418 return status;
1419 }
mohammad160306e79202018-03-28 13:17:44 +03001420
Ronald Crond18b5f82020-11-25 16:46:05 +01001421 psa_key_attributes_t attributes = {
1422 .core = slot->attr
1423 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 status = psa_driver_wrapper_export_key(&attributes,
1425 slot->key.data, slot->key.bytes,
1426 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001427
Ryan Everetta103ec92024-01-31 13:59:57 +00001428 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001431}
1432
Ronald Cron7285cda2020-11-26 14:46:37 +01001433psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001434 const psa_key_attributes_t *attributes,
1435 const uint8_t *key_buffer,
1436 size_t key_buffer_size,
1437 uint8_t *data,
1438 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001439 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001440{
Ronald Crond18b5f82020-11-25 16:46:05 +01001441 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001442
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001443 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001444 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1445 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001446 /* Exporting public -> public */
1447 return psa_export_key_buffer_internal(
1448 key_buffer, key_buffer_size,
1449 data, data_size, data_length);
1450 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001451#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001452 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1453 return mbedtls_psa_rsa_export_public_key(attributes,
1454 key_buffer,
1455 key_buffer_size,
1456 data,
1457 data_size,
1458 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001459#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001460 /* We don't know how to convert a private RSA key to public. */
1461 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001462#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001463 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001464 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001465#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001466 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1467 return mbedtls_psa_ecp_export_public_key(attributes,
1468 key_buffer,
1469 key_buffer_size,
1470 data,
1471 data_size,
1472 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001473#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001474 /* We don't know how to convert a private ECC key to public */
1475 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001476#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001477 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001478 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001479#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001480 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001481 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001482 key_buffer,
1483 key_buffer_size,
1484 data, data_size,
1485 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001486#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001487 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001488#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001489 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001491 (void) key_buffer;
1492 (void) key_buffer_size;
1493 (void) data;
1494 (void) data_size;
1495 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001497 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001498}
Ronald Crond18b5f82020-11-25 16:46:05 +01001499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1501 uint8_t *data,
1502 size_t data_size,
1503 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001504{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001505 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001506 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001507 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001508 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001509
Ronald Crone907e552021-01-18 13:22:38 +01001510 /* Reject a zero-length output buffer now, since this can never be a
1511 * valid key representation. This way we know that data must be a valid
1512 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 if (data_size == 0) {
1514 return PSA_ERROR_BUFFER_TOO_SMALL;
1515 }
Ronald Crone907e552021-01-18 13:22:38 +01001516
Darryl Greendd8fb772018-11-07 16:00:44 +00001517 /* Set the key to empty now, so that even when there are errors, we always
1518 * set data_length to a value between 0 and data_size. On error, setting
1519 * the key to empty is a good choice because an empty key representation is
1520 * unlikely to be accepted anywhere. */
1521 *data_length = 0;
1522
1523 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1525 if (status != PSA_SUCCESS) {
1526 return status;
1527 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1530 status = PSA_ERROR_INVALID_ARGUMENT;
1531 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001532 }
1533
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001534 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001535 .core = slot->attr
1536 };
Ronald Cron67227982020-11-26 15:16:05 +01001537 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001538 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001540
1541exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00001542 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001543
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001545}
1546
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001547MBEDTLS_STATIC_ASSERT(
1548 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1549 "One or more key attribute flag is listed as both external-only and dual-use")
1550MBEDTLS_STATIC_ASSERT(
1551 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1552 "One or more key attribute flag is listed as both internal-only and dual-use")
1553MBEDTLS_STATIC_ASSERT(
1554 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1555 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001556
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001557/** Validate that a key policy is internally well-formed.
1558 *
1559 * This function only rejects invalid policies. It does not validate the
1560 * consistency of the policy with respect to other attributes of the key
1561 * such as the key type.
1562 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001563static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001564{
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1566 PSA_KEY_USAGE_COPY |
1567 PSA_KEY_USAGE_ENCRYPT |
1568 PSA_KEY_USAGE_DECRYPT |
1569 PSA_KEY_USAGE_SIGN_MESSAGE |
1570 PSA_KEY_USAGE_VERIFY_MESSAGE |
1571 PSA_KEY_USAGE_SIGN_HASH |
1572 PSA_KEY_USAGE_VERIFY_HASH |
1573 PSA_KEY_USAGE_VERIFY_DERIVATION |
1574 PSA_KEY_USAGE_DERIVE)) != 0) {
1575 return PSA_ERROR_INVALID_ARGUMENT;
1576 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001577
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001579}
1580
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001581/** Validate the internal consistency of key attributes.
1582 *
1583 * This function only rejects invalid attribute values. If does not
1584 * validate the consistency of the attributes with any key data that may
1585 * be involved in the creation of the key.
1586 *
1587 * Call this function early in the key creation process.
1588 *
1589 * \param[in] attributes Key attributes for the new key.
1590 * \param[out] p_drv On any return, the driver for the key, if any.
1591 * NULL for a transparent key.
1592 *
1593 */
1594static psa_status_t psa_validate_key_attributes(
1595 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001597{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001598 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1600 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001601
Gilles Peskine449bd832023-01-11 14:50:10 +01001602 status = psa_validate_key_location(lifetime, p_drv);
1603 if (status != PSA_SUCCESS) {
1604 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001605 }
1606
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 status = psa_validate_key_persistence(lifetime);
1608 if (status != PSA_SUCCESS) {
1609 return status;
1610 }
1611
1612 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1613 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1614 return PSA_ERROR_INVALID_ARGUMENT;
1615 }
1616 } else {
1617 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1618 return PSA_ERROR_INVALID_ARGUMENT;
1619 }
1620 }
1621
1622 status = psa_validate_key_policy(&attributes->core.policy);
1623 if (status != PSA_SUCCESS) {
1624 return status;
1625 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001626
1627 /* Refuse to create overly large keys.
1628 * Note that this doesn't trigger on import if the attributes don't
1629 * explicitly specify a size (so psa_get_key_bits returns 0), so
1630 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1632 return PSA_ERROR_NOT_SUPPORTED;
1633 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001634
Gilles Peskine91e8c332019-08-02 19:19:39 +02001635 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001636 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1637 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1638 return PSA_ERROR_INVALID_ARGUMENT;
1639 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001642}
1643
Gilles Peskine4747d192019-04-17 15:05:45 +02001644/** Prepare a key slot to receive key material.
1645 *
1646 * This function allocates a key slot and sets its metadata.
1647 *
1648 * If this function fails, call psa_fail_key_creation().
1649 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001650 * This function is intended to be used as follows:
1651 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001652 * it with the specified attributes, and in case of a volatile key assign it
1653 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001654 * -# Populate the slot with the key material.
1655 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1656 * In case of failure at any step, stop the sequence and call
1657 * psa_fail_key_creation().
1658 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001659 * On success, the key slot's state is PSA_SLOT_FILLING.
1660 * It is the responsibility of the caller to change the slot's state to
1661 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001662 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001663 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001664 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001665 * \param[out] p_slot On success, a pointer to the prepared slot.
1666 * \param[out] p_drv On any return, the driver for the key, if any.
1667 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001668 *
1669 * \retval #PSA_SUCCESS
1670 * The key slot is ready to receive key material.
1671 * \return If this function fails, the key slot is an invalid state.
1672 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001673 */
1674static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001675 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001676 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001677 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001679{
1680 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001681 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001682 psa_key_slot_t *slot;
1683
Gilles Peskinedf179142019-07-15 22:02:14 +02001684 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001685 *p_drv = NULL;
1686
Gilles Peskine449bd832023-01-11 14:50:10 +01001687 status = psa_validate_key_attributes(attributes, p_drv);
1688 if (status != PSA_SUCCESS) {
1689 return status;
1690 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001691
Ryan Everett3d8118d2024-01-30 16:58:47 +00001692#if defined(MBEDTLS_THREADING_C)
1693 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1694 &mbedtls_threading_key_slot_mutex));
1695#endif
Ryan Everettb69118e2024-01-02 15:54:32 +00001696 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Ryan Everett3d8118d2024-01-30 16:58:47 +00001697#if defined(MBEDTLS_THREADING_C)
1698 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1699 &mbedtls_threading_key_slot_mutex));
1700#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001701 if (status != PSA_SUCCESS) {
1702 return status;
1703 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001704 slot = *p_slot;
1705
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001706 /* We're storing the declared bit-size of the key. It's up to each
1707 * creation mechanism to verify that this information is correct.
1708 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001709 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001710 * is optional (import, copy). In case of a volatile key, assign it the
1711 * volatile key identifier associated to the slot returned to contain its
1712 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001713
1714 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001716#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1717 slot->attr.id = volatile_key_id;
1718#else
1719 slot->attr.id.key_id = volatile_key_id;
1720#endif
1721 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001722
Gilles Peskine91e8c332019-08-02 19:19:39 +02001723 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001724 * external-only flags, query `attributes`. Thanks to the check
1725 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001726 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001727 * may have set. */
1728 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001729
Gilles Peskinecbaff462019-07-12 23:46:04 +02001730#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001731 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001732 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001733 * create the key file in internal storage, create the
1734 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001735 * persistent data. This is done by starting a transaction that will
1736 * encompass these three actions.
1737 * For registering a volatile key, we just need to find an appropriate
1738 * slot number inside the SE. Since the key is designated volatile, creating
1739 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001740 /* The first thing to do is to find a slot number for the new key.
1741 * We save the slot number in persistent storage as part of the
1742 * transaction data. It will be needed to recover if the power
1743 * fails during the key creation process, to clean up on the secure
1744 * element side after restarting. Obtaining a slot number from the
1745 * secure element driver updates its persistent state, but we do not yet
1746 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001747 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001749 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1751 &slot_number);
1752 if (status != PSA_SUCCESS) {
1753 return status;
1754 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001755
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1757 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001758 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001759 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001760 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 status = psa_crypto_save_transaction();
1762 if (status != PSA_SUCCESS) {
1763 (void) psa_crypto_stop_transaction();
1764 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001765 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001766 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001767
1768 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001770 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001771
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001773 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001775 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001776#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1777
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001779}
Gilles Peskine4747d192019-04-17 15:05:45 +02001780
1781/** Finalize the creation of a key once its key material has been set.
1782 *
1783 * This entails writing the key to persistent storage.
1784 *
1785 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001786 * See the documentation of psa_start_key_creation() for the intended use
1787 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001788 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001789 * If the finalization succeeds, the function sets the key slot's state to
1790 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1791 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001792 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001793 * \param[in,out] slot Pointer to the slot with key material.
1794 * \param[in] driver The secure element driver for the key,
1795 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001796 * \param[out] key On success, identifier of the key. Note that the
1797 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001798 *
1799 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001800 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001801 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1802 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1803 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1804 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1805 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1806 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001807 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001808 * \return If this function fails, the key slot is an invalid state.
1809 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001810 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001811static psa_status_t psa_finish_key_creation(
1812 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001813 psa_se_drv_table_entry_t *driver,
1814 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001815{
1816 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001817 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001818 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001819
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001820#if defined(MBEDTLS_THREADING_C)
1821 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1822 &mbedtls_threading_key_slot_mutex));
1823#endif
1824
Gilles Peskine4747d192019-04-17 15:05:45 +02001825#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001827#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001829 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001830 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001832
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001833 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1834 sizeof(data.slot_number),
1835 "Slot number size does not match psa_se_key_data_storage_t");
1836
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1838 status = psa_save_persistent_key(&slot->attr,
1839 (uint8_t *) &data,
1840 sizeof(data));
1841 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001842#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1843 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001844 /* Key material is saved in export representation in the slot, so
1845 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 status = psa_save_persistent_key(&slot->attr,
1847 slot->key.data,
1848 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001849 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001850 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001851#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1852
Gilles Peskinecbaff462019-07-12 23:46:04 +02001853#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001854 /* Finish the transaction for a key creation. This does not
1855 * happen when registering an existing key. Detect this case
1856 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001857 * creation of a persistent key in a secure element requires a transaction,
1858 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 if (driver != NULL &&
1860 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1861 status = psa_save_se_persistent_data(driver);
1862 if (status != PSA_SUCCESS) {
1863 psa_destroy_persistent_key(slot->attr.id);
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001864
1865#if defined(MBEDTLS_THREADING_C)
1866 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1867 &mbedtls_threading_key_slot_mutex));
1868#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001870 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001872 }
1873#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1874
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001876 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001877 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1878 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001880 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001882 }
Ronald Cron50972942020-11-14 11:28:25 +01001883
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001884#if defined(MBEDTLS_THREADING_C)
1885 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1886 &mbedtls_threading_key_slot_mutex));
1887#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001889}
1890
1891/** Abort the creation of a key.
1892 *
1893 * You may call this function after calling psa_start_key_creation(),
1894 * or after psa_finish_key_creation() fails. In other circumstances, this
1895 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001896 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001897 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001898 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001899 * \param[in,out] slot Pointer to the slot with key material.
1900 * \param[in] driver The secure element driver for the key,
1901 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001902 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001903static void psa_fail_key_creation(psa_key_slot_t *slot,
1904 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001905{
Gilles Peskine011e4282019-06-26 18:34:38 +02001906 (void) driver;
1907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001909 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001910 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001911
Ryan Everettb7101442024-01-23 20:09:49 +00001912#if defined(MBEDTLS_THREADING_C)
Ryan Everett73feaf22024-02-14 11:36:41 +00001913 /* If the lock operation fails we still wipe the slot.
1914 * Operations will no longer work after a failed lock,
1915 * but we still need to wipe the slot of confidential data. */
Ryan Everettb7101442024-01-23 20:09:49 +00001916 mbedtls_mutex_lock(&mbedtls_threading_key_slot_mutex);
1917#endif
1918
Gilles Peskine011e4282019-06-26 18:34:38 +02001919#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001920 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001921 * element, and the failure happened later (when saving metadata
1922 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001923 * element.
1924 * https://github.com/ARMmbed/mbed-crypto/issues/217
1925 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001926
Gilles Peskined7729582019-08-05 15:55:54 +02001927 /* Abort the ongoing transaction if any (there may not be one if
1928 * the creation process failed before starting one, or if the
1929 * key creation is a registration of a key in a secure element).
1930 * Earlier functions must already have done what it takes to undo any
1931 * partial creation. All that's left is to update the transaction data
1932 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001934#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1935
Gilles Peskine449bd832023-01-11 14:50:10 +01001936 psa_wipe_key_slot(slot);
Ryan Everettb7101442024-01-23 20:09:49 +00001937
1938#if defined(MBEDTLS_THREADING_C)
1939 mbedtls_mutex_unlock(&mbedtls_threading_key_slot_mutex);
1940#endif
Gilles Peskine4747d192019-04-17 15:05:45 +02001941}
1942
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001943/** Validate optional attributes during key creation.
1944 *
1945 * Some key attributes are optional during key creation. If they are
1946 * specified in the attributes structure, check that they are consistent
1947 * with the data in the slot.
1948 *
1949 * This function should be called near the end of key creation, after
1950 * the slot in memory is fully populated but before saving persistent data.
1951 */
1952static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001953 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001955{
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 if (attributes->core.type != 0) {
1957 if (attributes->core.type != slot->attr.type) {
1958 return PSA_ERROR_INVALID_ARGUMENT;
1959 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001960 }
1961
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001963#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1964 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1966 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001967 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001968 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001969 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001970
Ronald Cron90857082020-11-25 14:58:33 +01001971 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 slot->attr.type,
1973 slot->key.data,
1974 slot->key.bytes,
1975 &rsa);
1976 if (status != PSA_SUCCESS) {
1977 return status;
1978 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 mbedtls_mpi_init(&actual);
1981 mbedtls_mpi_init(&required);
1982 ret = mbedtls_rsa_export(rsa,
1983 NULL, NULL, NULL, NULL, &actual);
1984 mbedtls_rsa_free(rsa);
1985 mbedtls_free(rsa);
1986 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001987 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 }
1989 ret = mbedtls_mpi_read_binary(&required,
1990 attributes->domain_parameters,
1991 attributes->domain_parameters_size);
1992 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001993 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 }
1995 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001996 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 }
1998rsa_exit:
1999 mbedtls_mpi_free(&actual);
2000 mbedtls_mpi_free(&required);
2001 if (ret != 0) {
2002 return mbedtls_to_psa_error(ret);
2003 }
2004 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002005#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2006 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002007 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002008 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002010 }
2011 }
2012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 if (attributes->core.bits != 0) {
2014 if (attributes->core.bits != slot->attr.bits) {
2015 return PSA_ERROR_INVALID_ARGUMENT;
2016 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002017 }
2018
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002020}
2021
Gilles Peskine449bd832023-01-11 14:50:10 +01002022psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
2023 const uint8_t *data,
2024 size_t data_length,
2025 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002026{
2027 psa_status_t status;
2028 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002029 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002030 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302031 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002032
Ronald Cron81709fc2020-11-14 12:10:32 +01002033 *key = MBEDTLS_SVC_KEY_ID_INIT;
2034
Gilles Peskine0f84d622019-09-12 19:03:13 +02002035 /* Reject zero-length symmetric keys (including raw data key objects).
2036 * This also rejects any key which might be encoded as an empty string,
2037 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 if (data_length == 0) {
2039 return PSA_ERROR_INVALID_ARGUMENT;
2040 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002041
Archana449608b2021-09-08 15:36:05 +05302042 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 if (data_length > SIZE_MAX / 8) {
2044 return PSA_ERROR_NOT_SUPPORTED;
2045 }
Archana6ed4bda2021-08-04 10:47:15 +05302046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2048 &slot, &driver);
2049 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002050 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002052
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002053 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302054 * storage ( thus not in the case of importing a key in a secure element
2055 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2056 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 if (slot->key.data == NULL) {
2058 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302059 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 attributes, data, data_length, &storage_size);
2061 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302062 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 }
Archanad8a83dc2021-06-14 10:04:16 +05302064 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 status = psa_allocate_buffer_to_slot(slot, storage_size);
2066 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002067 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002069 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002070
2071 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 status = psa_driver_wrapper_import_key(attributes,
2073 data, data_length,
2074 slot->key.data,
2075 slot->key.bytes,
2076 &slot->key.bytes, &bits);
2077 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002078 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002080
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002082 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002084 status = PSA_ERROR_INVALID_ARGUMENT;
2085 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002086 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002087
Archana6ed4bda2021-08-04 10:47:15 +05302088 /* Enforce a size limit, and in particular ensure that the bit
2089 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302091 status = PSA_ERROR_NOT_SUPPORTED;
2092 goto exit;
2093 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 status = psa_validate_optional_attributes(slot, attributes);
2095 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002096 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002098
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002100exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 if (status != PSA_SUCCESS) {
2102 psa_fail_key_creation(slot, driver);
2103 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002104
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002106}
2107
Gilles Peskined7729582019-08-05 15:55:54 +02002108#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2109psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002111{
2112 psa_status_t status;
2113 psa_key_slot_t *slot = NULL;
2114 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002115 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002116
2117 /* Leaving attributes unspecified is not currently supported.
2118 * It could make sense to query the key type and size from the
2119 * secure element, but not all secure elements support this
2120 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2122 return PSA_ERROR_NOT_SUPPORTED;
2123 }
2124 if (psa_get_key_bits(attributes) == 0) {
2125 return PSA_ERROR_NOT_SUPPORTED;
2126 }
Gilles Peskined7729582019-08-05 15:55:54 +02002127
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2129 &slot, &driver);
2130 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002131 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 }
Gilles Peskined7729582019-08-05 15:55:54 +02002133
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002135
2136exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 if (status != PSA_SUCCESS) {
2138 psa_fail_key_creation(slot, driver);
2139 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002140
Gilles Peskined7729582019-08-05 15:55:54 +02002141 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 psa_close_key(key);
2143 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002144}
2145#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2146
Gilles Peskine449bd832023-01-11 14:50:10 +01002147psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2148 const psa_key_attributes_t *specified_attributes,
2149 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002150{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002151 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002152 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002153 psa_key_slot_t *source_slot = NULL;
2154 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002155 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002156 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302157 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002158
Ronald Cron81709fc2020-11-14 12:10:32 +01002159 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2160
Archana8a180362021-07-05 02:18:48 +05302161 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2163 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002164 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 status = psa_validate_optional_attributes(source_slot,
2168 specified_attributes);
2169 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002170 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002171 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002172
Archana9d17bf42021-09-10 06:22:44 +05302173 /* The target key type and number of bits have been validated by
2174 * psa_validate_optional_attributes() to be either equal to zero or
2175 * equal to the ones of the source key. So it is safe to inherit
2176 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302177 * */
Archana9d17bf42021-09-10 06:22:44 +05302178 actual_attributes.core.bits = source_slot->attr.bits;
2179 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302180
2181
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 status = psa_restrict_key_policy(source_slot->attr.type,
2183 &actual_attributes.core.policy,
2184 &source_slot->attr.policy);
2185 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002186 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2190 &target_slot, &driver);
2191 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002192 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 }
2194 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2195 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302196 /*
Archana9d17bf42021-09-10 06:22:44 +05302197 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302198 * the source key would need to be exported as plaintext and re-imported
2199 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302200 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302201 * appropriate API invocations from the application, if needed.
2202 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002203 status = PSA_ERROR_NOT_SUPPORTED;
2204 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002205 }
Archana8a180362021-07-05 02:18:48 +05302206 /*
2207 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302208 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302209 * - For opaque keys this translates to an invocation of the drivers'
2210 * copy_key entry point through the dispatch layer.
2211 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2213 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2214 &storage_size);
2215 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302216 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 }
Archana374fe5b2021-09-08 15:50:28 +05302218
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2220 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302221 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 }
Archana374fe5b2021-09-08 15:50:28 +05302223
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 status = psa_driver_wrapper_copy_key(&actual_attributes,
2225 source_slot->key.data,
2226 source_slot->key.bytes,
2227 target_slot->key.data,
2228 target_slot->key.bytes,
2229 &target_slot->key.bytes);
2230 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302231 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 }
2233 } else {
2234 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302235 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 source_slot->key.bytes);
2237 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302238 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 }
Archana8a180362021-07-05 02:18:48 +05302240 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002242exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 if (status != PSA_SUCCESS) {
2244 psa_fail_key_creation(target_slot, driver);
2245 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002246
Ryan Everetta103ec92024-01-31 13:59:57 +00002247 unlock_status = psa_unregister_read_under_mutex(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002250}
2251
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002252
2253
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002254/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002255/* Message digests */
2256/****************************************************************/
2257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002259{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002260 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 if (operation->id == 0) {
2262 return PSA_SUCCESS;
2263 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002266 operation->id = 0;
2267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002269}
2270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2272 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002273{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002274 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002275
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002276 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002278 status = PSA_ERROR_BAD_STATE;
2279 goto exit;
2280 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002283 status = PSA_ERROR_INVALID_ARGUMENT;
2284 goto exit;
2285 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002286
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002287 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2288 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002292
2293exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 if (status != PSA_SUCCESS) {
2295 psa_hash_abort(operation);
2296 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002297
2298 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002299}
2300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2302 const uint8_t *input,
2303 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002304{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002305 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2306
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002308 status = PSA_ERROR_BAD_STATE;
2309 goto exit;
2310 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002311
Steven Cooremanc8288352021-03-04 14:02:19 +01002312 /* Don't require hash implementations to behave correctly on a
2313 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 if (input_length == 0) {
2315 return PSA_SUCCESS;
2316 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002319
2320exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 if (status != PSA_SUCCESS) {
2322 psa_hash_abort(operation);
2323 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002326}
2327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2329 uint8_t *hash,
2330 size_t hash_size,
2331 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002332{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002333 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 if (operation->id == 0) {
2335 return PSA_ERROR_BAD_STATE;
2336 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002337
Steven Cooreman1e582352021-02-18 17:24:37 +01002338 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 operation, hash, hash_size, hash_length);
2340 psa_hash_abort(operation);
2341 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002342}
2343
Gilles Peskine449bd832023-01-11 14:50:10 +01002344psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2345 const uint8_t *hash,
2346 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002347{
Ronald Cron69a63422021-10-18 09:47:58 +02002348 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002349 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002350 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 operation,
2352 actual_hash, sizeof(actual_hash),
2353 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002354
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002356 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002358
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002360 status = PSA_ERROR_INVALID_SIGNATURE;
2361 goto exit;
2362 }
2363
Dave Rodgman78701152023-08-29 14:20:18 +01002364 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002365 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002367
2368exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2370 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002371 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002375}
2376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377psa_status_t psa_hash_compute(psa_algorithm_t alg,
2378 const uint8_t *input, size_t input_length,
2379 uint8_t *hash, size_t hash_size,
2380 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002381{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002382 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 if (!PSA_ALG_IS_HASH(alg)) {
2384 return PSA_ERROR_INVALID_ARGUMENT;
2385 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002386
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2388 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002389}
2390
Gilles Peskine449bd832023-01-11 14:50:10 +01002391psa_status_t psa_hash_compare(psa_algorithm_t alg,
2392 const uint8_t *input, size_t input_length,
2393 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002394{
Ronald Cron69a63422021-10-18 09:47:58 +02002395 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002396 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002397
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 if (!PSA_ALG_IS_HASH(alg)) {
2399 return PSA_ERROR_INVALID_ARGUMENT;
2400 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002401
Steven Cooreman1e582352021-02-18 17:24:37 +01002402 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 alg, input, input_length,
2404 actual_hash, sizeof(actual_hash),
2405 &actual_hash_length);
2406 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002407 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 }
2409 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002410 status = PSA_ERROR_INVALID_SIGNATURE;
2411 goto exit;
2412 }
Dave Rodgman78701152023-08-29 14:20:18 +01002413 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002414 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002416
2417exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2419 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002420}
2421
Gilles Peskine449bd832023-01-11 14:50:10 +01002422psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2423 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002424{
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 if (source_operation->id == 0 ||
2426 target_operation->id != 0) {
2427 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002428 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002429
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2431 target_operation);
2432 if (status != PSA_SUCCESS) {
2433 psa_hash_abort(target_operation);
2434 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002435
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002437}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002438
2439
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002440/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002441/* MAC */
2442/****************************************************************/
2443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002445{
Steven Cooremane6804192021-03-19 18:28:56 +01002446 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 if (operation->id == 0) {
2448 return PSA_SUCCESS;
2449 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002452 operation->mac_size = 0;
2453 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002454 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002455
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002457}
2458
Ronald Cron2dff3b22021-06-17 16:33:22 +02002459static psa_status_t psa_mac_finalize_alg_and_key_validation(
2460 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002461 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002463{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002464 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 psa_key_type_t key_type = psa_get_key_type(attributes);
2466 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002467
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 if (!PSA_ALG_IS_MAC(alg)) {
2469 return PSA_ERROR_INVALID_ARGUMENT;
2470 }
Steven Cooremane6804192021-03-19 18:28:56 +01002471
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002472 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 status = psa_mac_key_can_do(alg, key_type);
2474 if (status != PSA_SUCCESS) {
2475 return status;
2476 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002477
Steven Cooremand1a68f12021-05-10 11:13:41 +02002478 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002480
Gilles Peskine449bd832023-01-11 14:50:10 +01002481 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002482 /* A very short MAC is too short for security since it can be
2483 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2484 * so we make this our minimum, even though 32 bits is still
2485 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002487 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002488
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2490 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002491 /* It's impossible to "truncate" to a larger length than the full length
2492 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002494 }
2495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002497 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2498 * that is disabled in the compile-time configuration. The result can
2499 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2500 * configuration into account. In this case, force a return of
2501 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2502 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2503 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2504 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2505 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002507 }
2508
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002510}
2511
Gilles Peskine449bd832023-01-11 14:50:10 +01002512static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2513 mbedtls_svc_key_id_t key,
2514 psa_algorithm_t alg,
2515 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002516{
2517 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2518 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002519 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002520 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002521
2522 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002524 status = PSA_ERROR_BAD_STATE;
2525 goto exit;
2526 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002527
2528 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 key,
2530 &slot,
2531 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2532 alg);
2533 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002534 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002536
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002537 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002538 .core = slot->attr
2539 };
2540
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2542 &operation->mac_size);
2543 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002544 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002546
2547 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002548 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 if (is_sign) {
2550 status = psa_driver_wrapper_mac_sign_setup(operation,
2551 &attributes,
2552 slot->key.data,
2553 slot->key.bytes,
2554 alg);
2555 } else {
2556 status = psa_driver_wrapper_mac_verify_setup(operation,
2557 &attributes,
2558 slot->key.data,
2559 slot->key.bytes,
2560 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002561 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002562
Gilles Peskinefbfac682018-07-08 20:51:54 +02002563exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 if (status != PSA_SUCCESS) {
2565 psa_mac_abort(operation);
2566 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002567
Ryan Everettfb9857f2024-02-14 12:16:41 +00002568 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002571}
2572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2574 mbedtls_svc_key_id_t key,
2575 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002576{
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002578}
2579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2581 mbedtls_svc_key_id_t key,
2582 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002583{
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002585}
2586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2588 const uint8_t *input,
2589 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002590{
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 if (operation->id == 0) {
2592 return PSA_ERROR_BAD_STATE;
2593 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002594
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002595 /* Don't require hash implementations to behave correctly on a
2596 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 if (input_length == 0) {
2598 return PSA_SUCCESS;
2599 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2602 input, input_length);
2603 if (status != PSA_SUCCESS) {
2604 psa_mac_abort(operation);
2605 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002606
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002608}
2609
Gilles Peskine449bd832023-01-11 14:50:10 +01002610psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2611 uint8_t *mac,
2612 size_t mac_size,
2613 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002614{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002615 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2616 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002619 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002620 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002621 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002622
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002624 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002625 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002626 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002627
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002628 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2629 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002631 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002632 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002633 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002636 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002637 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002638 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002639
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 status = psa_driver_wrapper_mac_sign_finish(operation,
2641 mac, operation->mac_size,
2642 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002643
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002644exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002645 /* In case of success, set the potential excess room in the output buffer
2646 * to an invalid value, to avoid potentially leaking a longer MAC.
2647 * In case of error, set the output length and content to a safe default,
2648 * such that in case the caller misses an error check, the output would be
2649 * an unachievable MAC.
2650 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002652 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002653 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002654 }
mohammad16036df908f2018-04-02 08:34:15 -07002655
Paul Elliottdc42ca82023-02-24 18:11:59 +00002656 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002659
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002661}
2662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2664 const uint8_t *mac,
2665 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002666{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002667 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2668 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002671 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002672 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002673 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002676 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002677 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002678 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002681 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002682 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002683 }
2684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 status = psa_driver_wrapper_mac_verify_finish(operation,
2686 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002687
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002688exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002690
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002692}
2693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2695 psa_algorithm_t alg,
2696 const uint8_t *input,
2697 size_t input_length,
2698 uint8_t *mac,
2699 size_t mac_size,
2700 size_t *mac_length,
2701 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002702{
2703 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002704 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2705 psa_key_slot_t *slot;
2706 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002707 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002708
Ronald Cron51131b52021-06-17 17:17:20 +02002709 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 key,
2711 &slot,
2712 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2713 alg);
2714 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002715 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002717
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002718 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002719 .core = slot->attr
2720 };
2721
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2723 &operation_mac_size);
2724 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002725 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002727
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002729 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002730 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002731 }
2732
2733 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 &attributes,
2735 slot->key.data, slot->key.bytes,
2736 alg,
2737 input, input_length,
2738 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002739
2740exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002741 /* In case of success, set the potential excess room in the output buffer
2742 * to an invalid value, to avoid potentially leaking a longer MAC.
2743 * In case of error, set the output length and content to a safe default,
2744 * such that in case the caller misses an error check, the output would be
2745 * an unachievable MAC.
2746 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002748 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002749 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002750 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002751
2752 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002753
Ryan Everetta103ec92024-01-31 13:59:57 +00002754 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002755
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002757}
2758
Gilles Peskine449bd832023-01-11 14:50:10 +01002759psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002760 psa_algorithm_t alg,
2761 const uint8_t *input,
2762 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002763 uint8_t *mac,
2764 size_t mac_size,
2765 size_t *mac_length)
2766{
2767 return psa_mac_compute_internal(key, alg,
2768 input, input_length,
2769 mac, mac_size, mac_length, 1);
2770}
2771
2772psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2773 psa_algorithm_t alg,
2774 const uint8_t *input,
2775 size_t input_length,
2776 const uint8_t *mac,
2777 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002778{
2779 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002780 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2781 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 status = psa_mac_compute_internal(key, alg,
2784 input, input_length,
2785 actual_mac, sizeof(actual_mac),
2786 &actual_mac_length, 0);
2787 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002788 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002792 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002793 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002794 }
Dave Rodgman78701152023-08-29 14:20:18 +01002795 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002796 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002797 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002798 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002799
2800exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002802
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002804}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002805
Gilles Peskinee59236f2018-01-27 23:32:46 +01002806/****************************************************************/
2807/* Asymmetric cryptography */
2808/****************************************************************/
2809
Gilles Peskine449bd832023-01-11 14:50:10 +01002810static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2811 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002812{
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 if (input_is_message) {
2814 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2815 return PSA_ERROR_INVALID_ARGUMENT;
2816 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002817
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2819 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2820 return PSA_ERROR_INVALID_ARGUMENT;
2821 }
2822 }
2823 } else {
2824 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2825 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002826 }
2827 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002828
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002830}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002831
Gilles Peskine449bd832023-01-11 14:50:10 +01002832static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2833 int input_is_message,
2834 psa_algorithm_t alg,
2835 const uint8_t *input,
2836 size_t input_length,
2837 uint8_t *signature,
2838 size_t signature_size,
2839 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002840{
2841 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2842 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2843 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002844 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002845
2846 *signature_length = 0;
2847
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 status = psa_sign_verify_check_alg(input_is_message, alg);
2849 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002850 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002852
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002853 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002854 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002855 * buffer can in principle be empty since it doesn't actually have
2856 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 if (signature_size == 0) {
2858 return PSA_ERROR_BUFFER_TOO_SMALL;
2859 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002860
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002861 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 key, &slot,
2863 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2864 PSA_KEY_USAGE_SIGN_HASH,
2865 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002868 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002872 status = PSA_ERROR_INVALID_ARGUMENT;
2873 goto exit;
2874 }
2875
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002876 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002878 };
2879
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002881 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002882 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002883 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 signature, signature_size, signature_length);
2885 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002886
2887 status = psa_driver_wrapper_sign_hash(
2888 &attributes, slot->key.data, slot->key.bytes,
2889 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002891 }
2892
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002893
2894exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002895 psa_wipe_tag_output_buffer(signature, status, signature_size,
2896 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002897
Ryan Everetta103ec92024-01-31 13:59:57 +00002898 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002899
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002901}
2902
Gilles Peskine449bd832023-01-11 14:50:10 +01002903static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2904 int input_is_message,
2905 psa_algorithm_t alg,
2906 const uint8_t *input,
2907 size_t input_length,
2908 const uint8_t *signature,
2909 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002910{
2911 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2912 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2913 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 status = psa_sign_verify_check_alg(input_is_message, alg);
2916 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002917 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002919
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002920 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 key, &slot,
2922 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2923 PSA_KEY_USAGE_VERIFY_HASH,
2924 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 if (status != PSA_SUCCESS) {
2927 return status;
2928 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002929
2930 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002932 };
2933
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002935 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002936 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002937 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 signature, signature_length);
2939 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002940 status = psa_driver_wrapper_verify_hash(
2941 &attributes, slot->key.data, slot->key.bytes,
2942 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002944 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002945
Ryan Everetta103ec92024-01-31 13:59:57 +00002946 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002947
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002949
2950}
2951
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002952psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002953 const psa_key_attributes_t *attributes,
2954 const uint8_t *key_buffer,
2955 size_t key_buffer_size,
2956 psa_algorithm_t alg,
2957 const uint8_t *input,
2958 size_t input_length,
2959 uint8_t *signature,
2960 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002962{
2963 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002964
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002966 size_t hash_length;
2967 uint8_t hash[PSA_HASH_MAX_SIZE];
2968
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002969 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 PSA_ALG_SIGN_GET_HASH(alg),
2971 input, input_length,
2972 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002973
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002975 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002977
2978 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 attributes, key_buffer, key_buffer_size,
2980 alg, hash, hash_length,
2981 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002982 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002983
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002985}
2986
Gilles Peskine449bd832023-01-11 14:50:10 +01002987psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2988 psa_algorithm_t alg,
2989 const uint8_t *input,
2990 size_t input_length,
2991 uint8_t *signature,
2992 size_t signature_size,
2993 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002994{
2995 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002996 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002998}
2999
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003000psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003001 const psa_key_attributes_t *attributes,
3002 const uint8_t *key_buffer,
3003 size_t key_buffer_size,
3004 psa_algorithm_t alg,
3005 const uint8_t *input,
3006 size_t input_length,
3007 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003009{
3010 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003011
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003013 size_t hash_length;
3014 uint8_t hash[PSA_HASH_MAX_SIZE];
3015
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003016 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 PSA_ALG_SIGN_GET_HASH(alg),
3018 input, input_length,
3019 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003020
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003022 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003024
3025 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 attributes, key_buffer, key_buffer_size,
3027 alg, hash, hash_length,
3028 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003029 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003032}
3033
Gilles Peskine449bd832023-01-11 14:50:10 +01003034psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3035 psa_algorithm_t alg,
3036 const uint8_t *input,
3037 size_t input_length,
3038 const uint8_t *signature,
3039 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003040{
3041 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003042 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003044}
3045
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003046psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003047 const psa_key_attributes_t *attributes,
3048 const uint8_t *key_buffer, size_t key_buffer_size,
3049 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003051{
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3053 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3054 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003055#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3057 return mbedtls_psa_rsa_sign_hash(
3058 attributes,
3059 key_buffer, key_buffer_size,
3060 alg, hash, hash_length,
3061 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003062#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3063 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 } else {
3065 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003066 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3068 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003069#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3071 return mbedtls_psa_ecdsa_sign_hash(
3072 attributes,
3073 key_buffer, key_buffer_size,
3074 alg, hash, hash_length,
3075 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003076#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3077 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 } else {
3079 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003080 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003081 }
Ronald Cron4501c982021-03-19 20:09:32 +01003082
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 (void) key_buffer;
3084 (void) key_buffer_size;
3085 (void) hash;
3086 (void) hash_length;
3087 (void) signature;
3088 (void) signature_size;
3089 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003092}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003093
Gilles Peskine449bd832023-01-11 14:50:10 +01003094psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3095 psa_algorithm_t alg,
3096 const uint8_t *hash,
3097 size_t hash_length,
3098 uint8_t *signature,
3099 size_t signature_size,
3100 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003101{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003102 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003103 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003105}
3106
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003107psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003108 const psa_key_attributes_t *attributes,
3109 const uint8_t *key_buffer, size_t key_buffer_size,
3110 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003112{
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3114 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3115 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003116#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003117 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3118 return mbedtls_psa_rsa_verify_hash(
3119 attributes,
3120 key_buffer, key_buffer_size,
3121 alg, hash, hash_length,
3122 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003123#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3124 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 } else {
3126 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003127 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3129 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003130#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3132 return mbedtls_psa_ecdsa_verify_hash(
3133 attributes,
3134 key_buffer, key_buffer_size,
3135 alg, hash, hash_length,
3136 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003137#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3138 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 } else {
3140 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003141 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003142 }
Ronald Cron4501c982021-03-19 20:09:32 +01003143
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 (void) key_buffer;
3145 (void) key_buffer_size;
3146 (void) hash;
3147 (void) hash_length;
3148 (void) signature;
3149 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003150
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003152}
3153
Gilles Peskine449bd832023-01-11 14:50:10 +01003154psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3155 psa_algorithm_t alg,
3156 const uint8_t *hash,
3157 size_t hash_length,
3158 const uint8_t *signature,
3159 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003160{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003161 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003162 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003163 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003164}
3165
Gilles Peskine449bd832023-01-11 14:50:10 +01003166psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3167 psa_algorithm_t alg,
3168 const uint8_t *input,
3169 size_t input_length,
3170 const uint8_t *salt,
3171 size_t salt_length,
3172 uint8_t *output,
3173 size_t output_size,
3174 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003175{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003176 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003177 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003178 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003179 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003180
Darryl Green5cc689a2018-07-24 15:34:10 +01003181 (void) input;
3182 (void) input_length;
3183 (void) salt;
3184 (void) output;
3185 (void) output_size;
3186
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003187 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003188
Gilles Peskine449bd832023-01-11 14:50:10 +01003189 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3190 return PSA_ERROR_INVALID_ARGUMENT;
3191 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003192
Valerio Setti5bb454a2024-01-15 10:43:16 +01003193 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003194 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3195 if (status != PSA_SUCCESS) {
3196 return status;
3197 }
3198 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3199 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003200 status = PSA_ERROR_INVALID_ARGUMENT;
3201 goto exit;
3202 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003203
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003204 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003206 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003207
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003208 status = psa_driver_wrapper_asymmetric_encrypt(
3209 &attributes, slot->key.data, slot->key.bytes,
3210 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003211 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003212exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003213 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003214
Gilles Peskine449bd832023-01-11 14:50:10 +01003215 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003216}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003217
Gilles Peskine449bd832023-01-11 14:50:10 +01003218psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3219 psa_algorithm_t alg,
3220 const uint8_t *input,
3221 size_t input_length,
3222 const uint8_t *salt,
3223 size_t salt_length,
3224 uint8_t *output,
3225 size_t output_size,
3226 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003227{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003228 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003229 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003230 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003231 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003232
Darryl Green5cc689a2018-07-24 15:34:10 +01003233 (void) input;
3234 (void) input_length;
3235 (void) salt;
3236 (void) output;
3237 (void) output_size;
3238
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003239 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003240
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3242 return PSA_ERROR_INVALID_ARGUMENT;
3243 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003244
Valerio Setti5bb454a2024-01-15 10:43:16 +01003245 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3247 if (status != PSA_SUCCESS) {
3248 return status;
3249 }
3250 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003251 status = PSA_ERROR_INVALID_ARGUMENT;
3252 goto exit;
3253 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003254
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003255 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003257 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003258
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003259 status = psa_driver_wrapper_asymmetric_decrypt(
3260 &attributes, slot->key.data, slot->key.bytes,
3261 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003262 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003263
3264exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003265 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003266
Gilles Peskine449bd832023-01-11 14:50:10 +01003267 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003268}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003269
Paul Elliott9fe12f62022-11-30 19:16:02 +00003270/****************************************************************/
3271/* Asymmetric interruptible cryptography */
3272/****************************************************************/
3273
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003274static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3275
Paul Elliott9fe12f62022-11-30 19:16:02 +00003276void psa_interruptible_set_max_ops(uint32_t max_ops)
3277{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003278 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003279}
3280
3281uint32_t psa_interruptible_get_max_ops(void)
3282{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003283 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003284}
3285
Paul Elliott9fe12f62022-11-30 19:16:02 +00003286uint32_t psa_sign_hash_get_num_ops(
3287 const psa_sign_hash_interruptible_operation_t *operation)
3288{
Paul Elliott296ede92022-12-15 17:00:30 +00003289 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003290}
3291
3292uint32_t psa_verify_hash_get_num_ops(
3293 const psa_verify_hash_interruptible_operation_t *operation)
3294{
Paul Elliott296ede92022-12-15 17:00:30 +00003295 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003296}
3297
Paul Elliott59ad9452022-12-18 15:09:02 +00003298static psa_status_t psa_sign_hash_abort_internal(
3299 psa_sign_hash_interruptible_operation_t *operation)
3300{
3301 if (operation->id == 0) {
3302 /* The object has (apparently) been initialized but it is not (yet)
3303 * in use. It's ok to call abort on such an object, and there's
3304 * nothing to do. */
3305 return PSA_SUCCESS;
3306 }
3307
3308 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3309
3310 status = psa_driver_wrapper_sign_hash_abort(operation);
3311
3312 operation->id = 0;
3313
Paul Elliotte6145dc2023-02-07 12:51:21 +00003314 /* Do not clear either the error_occurred or num_ops elements here as they
3315 * only want to be cleared by the application calling abort, not by abort
3316 * being called at completion of an operation. */
3317
Paul Elliott59ad9452022-12-18 15:09:02 +00003318 return status;
3319}
3320
Paul Elliott9fe12f62022-11-30 19:16:02 +00003321psa_status_t psa_sign_hash_start(
3322 psa_sign_hash_interruptible_operation_t *operation,
3323 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3324 const uint8_t *hash, size_t hash_length)
3325{
3326 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3327 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3328 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003329 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003330
Paul Elliottc9774412023-02-06 15:14:07 +00003331 /* Check that start has not been previously called, or operation has not
3332 * previously errored. */
3333 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003334 return PSA_ERROR_BAD_STATE;
3335 }
3336
Paul Elliott9fe12f62022-11-30 19:16:02 +00003337 status = psa_sign_verify_check_alg(0, alg);
3338 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003339 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003340 return status;
3341 }
3342
3343 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3344 PSA_KEY_USAGE_SIGN_HASH,
3345 alg);
3346
3347 if (status != PSA_SUCCESS) {
3348 goto exit;
3349 }
3350
3351 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3352 status = PSA_ERROR_INVALID_ARGUMENT;
3353 goto exit;
3354 }
3355
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003356 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003357 .core = slot->attr
3358 };
3359
Paul Elliott296ede92022-12-15 17:00:30 +00003360 /* Ensure ops count gets reset, in case of operation re-use. */
3361 operation->num_ops = 0;
3362
Paul Elliott9fe12f62022-11-30 19:16:02 +00003363 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3364 slot->key.data,
3365 slot->key.bytes, alg,
3366 hash, hash_length);
3367exit:
3368
3369 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003370 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003371 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003372 }
3373
Ryan Everettdcc03d52024-02-14 15:44:13 +00003374 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003375
Paul Elliottc9774412023-02-06 15:14:07 +00003376 if (unlock_status != PSA_SUCCESS) {
3377 operation->error_occurred = 1;
3378 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003379
Paul Elliottc9774412023-02-06 15:14:07 +00003380 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003381}
3382
3383
3384psa_status_t psa_sign_hash_complete(
3385 psa_sign_hash_interruptible_operation_t *operation,
3386 uint8_t *signature, size_t signature_size,
3387 size_t *signature_length)
3388{
3389 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3390
3391 *signature_length = 0;
3392
Paul Elliottc9774412023-02-06 15:14:07 +00003393 /* Check that start has been called first, and that operation has not
3394 * previously errored. */
3395 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003396 status = PSA_ERROR_BAD_STATE;
3397 goto exit;
3398 }
3399
Paul Elliott096abc42023-02-03 18:33:23 +00003400 /* Immediately reject a zero-length signature buffer. This guarantees that
3401 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003402 if (signature_size == 0) {
3403 status = PSA_ERROR_BUFFER_TOO_SMALL;
3404 goto exit;
3405 }
3406
3407 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3408 signature_size,
3409 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003410
Paul Elliott296ede92022-12-15 17:00:30 +00003411 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003412 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003413
Paul Elliottebe225c2023-02-10 14:32:53 +00003414exit:
3415
Paul Elliott59200a22023-02-21 15:07:40 +00003416 psa_wipe_tag_output_buffer(signature, status, signature_size,
3417 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003418
Paul Elliott53bb3122023-02-10 14:22:22 +00003419 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003420 if (status != PSA_SUCCESS) {
3421 operation->error_occurred = 1;
3422 }
3423
Paul Elliott59ad9452022-12-18 15:09:02 +00003424 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003425 }
3426
3427 return status;
3428}
3429
3430psa_status_t psa_sign_hash_abort(
3431 psa_sign_hash_interruptible_operation_t *operation)
3432{
Paul Elliott59ad9452022-12-18 15:09:02 +00003433 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3434
3435 status = psa_sign_hash_abort_internal(operation);
3436
3437 /* We clear the number of ops done here, so that it is not cleared when
3438 * the operation fails or succeeds, only on manual abort. */
3439 operation->num_ops = 0;
3440
Paul Elliottc9774412023-02-06 15:14:07 +00003441 /* Likewise, failure state. */
3442 operation->error_occurred = 0;
3443
Paul Elliott59ad9452022-12-18 15:09:02 +00003444 return status;
3445}
3446
3447static psa_status_t psa_verify_hash_abort_internal(
3448 psa_verify_hash_interruptible_operation_t *operation)
3449{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003450 if (operation->id == 0) {
3451 /* The object has (apparently) been initialized but it is not (yet)
3452 * in use. It's ok to call abort on such an object, and there's
3453 * nothing to do. */
3454 return PSA_SUCCESS;
3455 }
3456
Paul Elliott59ad9452022-12-18 15:09:02 +00003457 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3458
3459 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003460
3461 operation->id = 0;
3462
Paul Elliotte6145dc2023-02-07 12:51:21 +00003463 /* Do not clear either the error_occurred or num_ops elements here as they
3464 * only want to be cleared by the application calling abort, not by abort
3465 * being called at completion of an operation. */
3466
Paul Elliott59ad9452022-12-18 15:09:02 +00003467 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003468}
3469
3470psa_status_t psa_verify_hash_start(
3471 psa_verify_hash_interruptible_operation_t *operation,
3472 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3473 const uint8_t *hash, size_t hash_length,
3474 const uint8_t *signature, size_t signature_length)
3475{
3476 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3477 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3478 psa_key_slot_t *slot;
3479
Paul Elliottc9774412023-02-06 15:14:07 +00003480 /* Check that start has not been previously called, or operation has not
3481 * previously errored. */
3482 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003483 return PSA_ERROR_BAD_STATE;
3484 }
3485
3486 status = psa_sign_verify_check_alg(0, alg);
3487 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003488 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003489 return status;
3490 }
3491
3492 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3493 PSA_KEY_USAGE_VERIFY_HASH,
3494 alg);
3495
3496 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003497 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003498 return status;
3499 }
3500
3501 psa_key_attributes_t attributes = {
3502 .core = slot->attr
3503 };
3504
Paul Elliott296ede92022-12-15 17:00:30 +00003505 /* Ensure ops count gets reset, in case of operation re-use. */
3506 operation->num_ops = 0;
3507
Paul Elliott9fe12f62022-11-30 19:16:02 +00003508 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3509 slot->key.data,
3510 slot->key.bytes,
3511 alg, hash, hash_length,
3512 signature, signature_length);
3513
3514 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003515 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003516 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003517 }
3518
Ryan Everett291267f2024-02-14 15:59:15 +00003519 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003520
Paul Elliottc9774412023-02-06 15:14:07 +00003521 if (unlock_status != PSA_SUCCESS) {
3522 operation->error_occurred = 1;
3523 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003524
Paul Elliottc9774412023-02-06 15:14:07 +00003525 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003526}
3527
3528psa_status_t psa_verify_hash_complete(
3529 psa_verify_hash_interruptible_operation_t *operation)
3530{
3531 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3532
Paul Elliottc9774412023-02-06 15:14:07 +00003533 /* Check that start has been called first, and that operation has not
3534 * previously errored. */
3535 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003536 status = PSA_ERROR_BAD_STATE;
3537 goto exit;
3538 }
3539
3540 status = psa_driver_wrapper_verify_hash_complete(operation);
3541
Paul Elliott296ede92022-12-15 17:00:30 +00003542 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003543 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003544 operation);
3545
Paul Elliottebe225c2023-02-10 14:32:53 +00003546exit:
3547
Paul Elliott9fe12f62022-11-30 19:16:02 +00003548 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003549 if (status != PSA_SUCCESS) {
3550 operation->error_occurred = 1;
3551 }
3552
Paul Elliott59ad9452022-12-18 15:09:02 +00003553 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003554 }
3555
3556 return status;
3557}
3558
3559psa_status_t psa_verify_hash_abort(
3560 psa_verify_hash_interruptible_operation_t *operation)
3561{
Paul Elliott59ad9452022-12-18 15:09:02 +00003562 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003563
Paul Elliott59ad9452022-12-18 15:09:02 +00003564 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003565
Paul Elliott59ad9452022-12-18 15:09:02 +00003566 /* We clear the number of ops done here, so that it is not cleared when
3567 * the operation fails or succeeds, only on manual abort. */
3568 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003569
Paul Elliottc9774412023-02-06 15:14:07 +00003570 /* Likewise, failure state. */
3571 operation->error_occurred = 0;
3572
Paul Elliott59ad9452022-12-18 15:09:02 +00003573 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003574}
3575
Paul Elliott588f8ed2022-12-02 18:10:26 +00003576/****************************************************************/
3577/* Asymmetric interruptible cryptography internal */
3578/* implementations */
3579/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003580
Paul Elliott588f8ed2022-12-02 18:10:26 +00003581void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3582{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003583
Paul Elliott588f8ed2022-12-02 18:10:26 +00003584#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3585 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3586 defined(MBEDTLS_ECP_RESTARTABLE)
3587
3588 /* Internal implementation uses zero to indicate infinite number max ops,
3589 * therefore avoid this value, and set to minimum possible. */
3590 if (max_ops == 0) {
3591 max_ops = 1;
3592 }
3593
Paul Elliott588f8ed2022-12-02 18:10:26 +00003594 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003595#else
3596 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003597#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3598 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3599 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3600}
3601
Paul Elliott588f8ed2022-12-02 18:10:26 +00003602uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003603 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003604{
3605#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3606 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3607 defined(MBEDTLS_ECP_RESTARTABLE)
3608
Paul Elliott93d9ca82023-02-15 18:14:21 +00003609 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003610#else
3611 (void) operation;
3612 return 0;
3613#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3614 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3615 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3616}
3617
3618uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003619 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003620{
3621 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3622 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3623 defined(MBEDTLS_ECP_RESTARTABLE)
3624
Paul Elliott93d9ca82023-02-15 18:14:21 +00003625 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003626#else
3627 (void) operation;
3628 return 0;
3629#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3630 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3631 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3632}
3633
3634psa_status_t mbedtls_psa_sign_hash_start(
3635 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3636 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3637 size_t key_buffer_size, psa_algorithm_t alg,
3638 const uint8_t *hash, size_t hash_length)
3639{
3640 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003641 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003642
Paul Elliott068fe072023-01-16 13:59:15 +00003643 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3644 return PSA_ERROR_NOT_SUPPORTED;
3645 }
3646
3647 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003648 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003649 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003650
3651#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003652 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3653 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003654
Paul Elliotta1c94092023-02-15 16:38:04 +00003655 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3656
Paul Elliott93d9ca82023-02-15 18:14:21 +00003657 /* Ensure num_ops is zero'ed in case of context re-use. */
3658 operation->num_ops = 0;
3659
Paul Elliott068fe072023-01-16 13:59:15 +00003660 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3661 attributes->core.bits,
3662 key_buffer,
3663 key_buffer_size,
3664 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003665
Paul Elliott068fe072023-01-16 13:59:15 +00003666 if (status != PSA_SUCCESS) {
3667 return status;
3668 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003669
Paul Elliott1bc59df2023-02-05 13:41:57 +00003670 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003671 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003672
Paul Elliott068fe072023-01-16 13:59:15 +00003673 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003674 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003675 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003676
Paul Elliott0290a762023-02-09 14:30:24 +00003677 /* We only need to store the same length of hash as the private key size
3678 * here, it would be truncated by the internal implementation anyway. */
3679 required_hash_length = (hash_length < operation->coordinate_bytes ?
3680 hash_length : operation->coordinate_bytes);
3681
Paul Elliottba70ad42023-02-15 18:23:53 +00003682 if (required_hash_length > sizeof(operation->hash)) {
3683 /* Shouldn't happen, but better safe than sorry. */
3684 return PSA_ERROR_CORRUPTION_DETECTED;
3685 }
3686
Paul Elliott0290a762023-02-09 14:30:24 +00003687 memcpy(operation->hash, hash, required_hash_length);
3688 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003689
3690 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003691
3692#else
Paul Elliott068fe072023-01-16 13:59:15 +00003693 (void) operation;
3694 (void) key_buffer;
3695 (void) key_buffer_size;
3696 (void) alg;
3697 (void) hash;
3698 (void) hash_length;
3699 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003700 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003701
Paul Elliott068fe072023-01-16 13:59:15 +00003702 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003703#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3704 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3705 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003706}
3707
3708psa_status_t mbedtls_psa_sign_hash_complete(
3709 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3710 uint8_t *signature, size_t signature_size,
3711 size_t *signature_length)
3712{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003713#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3714 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3715 defined(MBEDTLS_ECP_RESTARTABLE)
3716
Paul Elliotta1c94092023-02-15 16:38:04 +00003717 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003718 mbedtls_mpi r;
3719 mbedtls_mpi s;
3720
Paul Elliott46845252023-02-03 14:59:11 +00003721 mbedtls_mpi_init(&r);
3722 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003723
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003724 /* Ensure max_ops is set to the current value (or default). */
3725 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3726
Paul Elliotta1c94092023-02-15 16:38:04 +00003727 if (signature_size < 2 * operation->coordinate_bytes) {
3728 status = PSA_ERROR_BUFFER_TOO_SMALL;
3729 goto exit;
3730 }
3731
Paul Elliott588f8ed2022-12-02 18:10:26 +00003732 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003733
Paul Elliott588f8ed2022-12-02 18:10:26 +00003734#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3735 status = mbedtls_to_psa_error(
3736 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003737 &r,
3738 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003739 &operation->ctx->d,
3740 operation->hash,
3741 operation->hash_length,
3742 operation->md_alg,
3743 mbedtls_psa_get_random,
3744 MBEDTLS_PSA_RANDOM_STATE,
3745 &operation->restart_ctx));
3746#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003747 status = PSA_ERROR_NOT_SUPPORTED;
3748 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003749#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3750 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003751 status = mbedtls_to_psa_error(
3752 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003753 &r,
3754 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003755 &operation->ctx->d,
3756 operation->hash,
3757 operation->hash_length,
3758 mbedtls_psa_get_random,
3759 MBEDTLS_PSA_RANDOM_STATE,
3760 mbedtls_psa_get_random,
3761 MBEDTLS_PSA_RANDOM_STATE,
3762 &operation->restart_ctx));
3763 }
3764
Paul Elliottf8e5b562023-02-19 18:43:45 +00003765 /* Hide the fact that the restart context only holds a delta of number of
3766 * ops done during the last operation, not an absolute value. */
3767 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3768
Paul Elliott724bd252023-02-08 12:35:08 +00003769 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003770 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003771 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003772 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003773 operation->coordinate_bytes)
3774 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003775
3776 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003777 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003778 }
3779
3780 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003781 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003782 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003783 operation->coordinate_bytes,
3784 operation->coordinate_bytes)
3785 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003786
3787 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003788 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003789 }
3790
Paul Elliott1bc59df2023-02-05 13:41:57 +00003791 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003792
Paul Elliott724bd252023-02-08 12:35:08 +00003793 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003794 }
Paul Elliott724bd252023-02-08 12:35:08 +00003795
3796exit:
3797
3798 mbedtls_mpi_free(&r);
3799 mbedtls_mpi_free(&s);
3800 return status;
3801
Paul Elliott588f8ed2022-12-02 18:10:26 +00003802 #else
3803
3804 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003805 (void) signature;
3806 (void) signature_size;
3807 (void) signature_length;
3808
3809 return PSA_ERROR_NOT_SUPPORTED;
3810
3811#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3812 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3813 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3814}
3815
3816psa_status_t mbedtls_psa_sign_hash_abort(
3817 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3818{
3819
3820#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3821 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3822 defined(MBEDTLS_ECP_RESTARTABLE)
3823
3824 if (operation->ctx) {
3825 mbedtls_ecdsa_free(operation->ctx);
3826 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003827 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003828 }
3829
3830 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3831
Paul Elliott93d9ca82023-02-15 18:14:21 +00003832 operation->num_ops = 0;
3833
Paul Elliott588f8ed2022-12-02 18:10:26 +00003834 return PSA_SUCCESS;
3835
3836#else
3837
3838 (void) operation;
3839
3840 return PSA_ERROR_NOT_SUPPORTED;
3841
3842#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3843 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3844 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3845}
3846
3847psa_status_t mbedtls_psa_verify_hash_start(
3848 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3849 const psa_key_attributes_t *attributes,
3850 const uint8_t *key_buffer, size_t key_buffer_size,
3851 psa_algorithm_t alg,
3852 const uint8_t *hash, size_t hash_length,
3853 const uint8_t *signature, size_t signature_length)
3854{
3855 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003856 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003857 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003858
Paul Elliott068fe072023-01-16 13:59:15 +00003859 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3860 return PSA_ERROR_NOT_SUPPORTED;
3861 }
3862
3863 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003864 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003865 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003866
3867#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003868 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3869 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003870
Paul Elliotta1c94092023-02-15 16:38:04 +00003871 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3872 mbedtls_mpi_init(&operation->r);
3873 mbedtls_mpi_init(&operation->s);
3874
Paul Elliott93d9ca82023-02-15 18:14:21 +00003875 /* Ensure num_ops is zero'ed in case of context re-use. */
3876 operation->num_ops = 0;
3877
Paul Elliott068fe072023-01-16 13:59:15 +00003878 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3879 attributes->core.bits,
3880 key_buffer,
3881 key_buffer_size,
3882 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003883
Paul Elliott068fe072023-01-16 13:59:15 +00003884 if (status != PSA_SUCCESS) {
3885 return status;
3886 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003887
Paul Elliottc569fc22023-02-10 13:02:54 +00003888 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003889
Paul Elliott1bc59df2023-02-05 13:41:57 +00003890 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003891 return PSA_ERROR_INVALID_SIGNATURE;
3892 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003893
Paul Elliott068fe072023-01-16 13:59:15 +00003894 status = mbedtls_to_psa_error(
3895 mbedtls_mpi_read_binary(&operation->r,
3896 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003897 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003898
Paul Elliott068fe072023-01-16 13:59:15 +00003899 if (status != PSA_SUCCESS) {
3900 return status;
3901 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003902
Paul Elliott068fe072023-01-16 13:59:15 +00003903 status = mbedtls_to_psa_error(
3904 mbedtls_mpi_read_binary(&operation->s,
3905 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003906 coordinate_bytes,
3907 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003908
Paul Elliott068fe072023-01-16 13:59:15 +00003909 if (status != PSA_SUCCESS) {
3910 return status;
3911 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003912
Paul Elliott2c9843f2023-02-15 17:32:42 +00003913 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003914
Paul Elliott2c9843f2023-02-15 17:32:42 +00003915 if (status != PSA_SUCCESS) {
3916 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003917 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003918
Paul Elliott0290a762023-02-09 14:30:24 +00003919 /* We only need to store the same length of hash as the private key size
3920 * here, it would be truncated by the internal implementation anyway. */
3921 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3922 coordinate_bytes);
3923
Paul Elliottba70ad42023-02-15 18:23:53 +00003924 if (required_hash_length > sizeof(operation->hash)) {
3925 /* Shouldn't happen, but better safe than sorry. */
3926 return PSA_ERROR_CORRUPTION_DETECTED;
3927 }
3928
Paul Elliott0290a762023-02-09 14:30:24 +00003929 memcpy(operation->hash, hash, required_hash_length);
3930 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003931
3932 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003933#else
Paul Elliott068fe072023-01-16 13:59:15 +00003934 (void) operation;
3935 (void) key_buffer;
3936 (void) key_buffer_size;
3937 (void) alg;
3938 (void) hash;
3939 (void) hash_length;
3940 (void) signature;
3941 (void) signature_length;
3942 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003943 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003944 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003945
Paul Elliott068fe072023-01-16 13:59:15 +00003946 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003947#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3948 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3949 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003950}
3951
3952psa_status_t mbedtls_psa_verify_hash_complete(
3953 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3954{
3955
3956#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3957 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3958 defined(MBEDTLS_ECP_RESTARTABLE)
3959
Paul Elliottf8e5b562023-02-19 18:43:45 +00003960 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3961
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003962 /* Ensure max_ops is set to the current value (or default). */
3963 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3964
Paul Elliottf8e5b562023-02-19 18:43:45 +00003965 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003966 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3967 operation->hash,
3968 operation->hash_length,
3969 &operation->ctx->Q,
3970 &operation->r,
3971 &operation->s,
3972 &operation->restart_ctx));
3973
Paul Elliottf8e5b562023-02-19 18:43:45 +00003974 /* Hide the fact that the restart context only holds a delta of number of
3975 * ops done during the last operation, not an absolute value. */
3976 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3977
3978 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003979#else
3980 (void) operation;
3981
3982 return PSA_ERROR_NOT_SUPPORTED;
3983
3984#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3985 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3986 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3987}
3988
3989psa_status_t mbedtls_psa_verify_hash_abort(
3990 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3991{
3992
3993#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3994 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3995 defined(MBEDTLS_ECP_RESTARTABLE)
3996
3997 if (operation->ctx) {
3998 mbedtls_ecdsa_free(operation->ctx);
3999 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004000 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004001 }
4002
4003 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4004
Paul Elliott93d9ca82023-02-15 18:14:21 +00004005 operation->num_ops = 0;
4006
Paul Elliott588f8ed2022-12-02 18:10:26 +00004007 mbedtls_mpi_free(&operation->r);
4008 mbedtls_mpi_free(&operation->s);
4009
4010 return PSA_SUCCESS;
4011
4012#else
4013 (void) operation;
4014
4015 return PSA_ERROR_NOT_SUPPORTED;
4016
4017#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4018 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4019 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4020}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004021
mohammad1603503973b2018-03-12 15:59:30 +02004022/****************************************************************/
4023/* Symmetric cryptography */
4024/****************************************************************/
4025
Gilles Peskine449bd832023-01-11 14:50:10 +01004026static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4027 mbedtls_svc_key_id_t key,
4028 psa_algorithm_t alg,
4029 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004030{
4031 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4032 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004033 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4035 PSA_KEY_USAGE_ENCRYPT :
4036 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004037 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004038
4039 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004041 status = PSA_ERROR_BAD_STATE;
4042 goto exit;
4043 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004044
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004046 status = PSA_ERROR_INVALID_ARGUMENT;
4047 goto exit;
4048 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004049
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4051 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004052 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004054
Ronald Cron49fafa92021-03-10 08:34:23 +01004055 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004056 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004057 * so we only set it (in the driver wrapper) after resources have been
4058 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004059 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004061 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004063 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 }
4065 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004066
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004067 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004068 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004069 };
4070
Ronald Cronab99ac22020-10-01 16:38:28 +02004071 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 if (cipher_operation == MBEDTLS_ENCRYPT) {
4073 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4074 &attributes,
4075 slot->key.data,
4076 slot->key.bytes,
4077 alg);
4078 } else {
4079 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4080 &attributes,
4081 slot->key.data,
4082 slot->key.bytes,
4083 alg);
4084 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004085
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004086exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 if (status != PSA_SUCCESS) {
4088 psa_cipher_abort(operation);
4089 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004090
Ryan Everettc0053cc2024-02-14 16:27:13 +00004091 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004092
Gilles Peskine449bd832023-01-11 14:50:10 +01004093 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004094}
4095
Gilles Peskine449bd832023-01-11 14:50:10 +01004096psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4097 mbedtls_svc_key_id_t key,
4098 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004099{
Gilles Peskine449bd832023-01-11 14:50:10 +01004100 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004101}
4102
Gilles Peskine449bd832023-01-11 14:50:10 +01004103psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4104 mbedtls_svc_key_id_t key,
4105 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004106{
Gilles Peskine449bd832023-01-11 14:50:10 +01004107 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004108}
4109
Gilles Peskine449bd832023-01-11 14:50:10 +01004110psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4111 uint8_t *iv,
4112 size_t iv_size,
4113 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004114{
Ronald Cron6d051732020-10-01 14:10:20 +02004115 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004116 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004117 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004118
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004120 status = PSA_ERROR_BAD_STATE;
4121 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004122 }
4123
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004125 status = PSA_ERROR_BAD_STATE;
4126 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004127 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004128
Ronald Cron2fb90522021-07-05 12:31:44 +02004129 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004130 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004131 status = PSA_ERROR_BUFFER_TOO_SMALL;
4132 goto exit;
4133 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004134
Gilles Peskine449bd832023-01-11 14:50:10 +01004135 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004136 status = PSA_ERROR_GENERIC_ERROR;
4137 goto exit;
4138 }
4139
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 status = psa_generate_random(local_iv, default_iv_length);
4141 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004142 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 }
Ronald Cron5618a392021-03-26 09:52:26 +01004144
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 status = psa_driver_wrapper_cipher_set_iv(operation,
4146 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004147
4148exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 if (status == PSA_SUCCESS) {
4150 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004151 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004152 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004154 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004156 }
Ronald Cron6d051732020-10-01 14:10:20 +02004157
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004159}
4160
Gilles Peskine449bd832023-01-11 14:50:10 +01004161psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4162 const uint8_t *iv,
4163 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004164{
Ronald Cron6d051732020-10-01 14:10:20 +02004165 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004166
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004168 status = PSA_ERROR_BAD_STATE;
4169 goto exit;
4170 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004171
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004173 status = PSA_ERROR_BAD_STATE;
4174 goto exit;
4175 }
Ronald Crona0d68172021-03-26 10:15:08 +01004176
Gilles Peskine449bd832023-01-11 14:50:10 +01004177 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004178 status = PSA_ERROR_INVALID_ARGUMENT;
4179 goto exit;
4180 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004181
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 status = psa_driver_wrapper_cipher_set_iv(operation,
4183 iv,
4184 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004185
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004186exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004188 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 } else {
4190 psa_cipher_abort(operation);
4191 }
4192 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004193}
4194
Gilles Peskine449bd832023-01-11 14:50:10 +01004195psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4196 const uint8_t *input,
4197 size_t input_length,
4198 uint8_t *output,
4199 size_t output_size,
4200 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004201{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004202 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004203
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004205 status = PSA_ERROR_BAD_STATE;
4206 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004207 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004208
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004210 status = PSA_ERROR_BAD_STATE;
4211 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004212 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004213
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 status = psa_driver_wrapper_cipher_update(operation,
4215 input,
4216 input_length,
4217 output,
4218 output_size,
4219 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004220
4221exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 if (status != PSA_SUCCESS) {
4223 psa_cipher_abort(operation);
4224 }
Ronald Cron6d051732020-10-01 14:10:20 +02004225
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004227}
4228
Gilles Peskine449bd832023-01-11 14:50:10 +01004229psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4230 uint8_t *output,
4231 size_t output_size,
4232 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004233{
David Saadab4ecc272019-02-14 13:48:10 +02004234 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004235
Gilles Peskine449bd832023-01-11 14:50:10 +01004236 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004237 status = PSA_ERROR_BAD_STATE;
4238 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004239 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004240
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004242 status = PSA_ERROR_BAD_STATE;
4243 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004244 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004245
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 status = psa_driver_wrapper_cipher_finish(operation,
4247 output,
4248 output_size,
4249 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004250
4251exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 if (status == PSA_SUCCESS) {
4253 return psa_cipher_abort(operation);
4254 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004255 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004257
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004259 }
mohammad1603503973b2018-03-12 15:59:30 +02004260}
4261
Gilles Peskine449bd832023-01-11 14:50:10 +01004262psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004263{
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004265 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004266 * in use. It's ok to call abort on such an object, and there's
4267 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004269 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004270
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004272
Ronald Cron49fafa92021-03-10 08:34:23 +01004273 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004274 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004275 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004276
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004278}
4279
Gilles Peskine449bd832023-01-11 14:50:10 +01004280psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4281 psa_algorithm_t alg,
4282 const uint8_t *input,
4283 size_t input_length,
4284 uint8_t *output,
4285 size_t output_size,
4286 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004287{
4288 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004289 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004290 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004291 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4292 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004293 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004294
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004296 status = PSA_ERROR_INVALID_ARGUMENT;
4297 goto exit;
4298 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004299
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4301 PSA_KEY_USAGE_ENCRYPT,
4302 alg);
4303 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004304 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004306
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004307 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004309 };
4310
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4312 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004313 status = PSA_ERROR_GENERIC_ERROR;
4314 goto exit;
4315 }
4316
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 if (default_iv_length > 0) {
4318 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004319 status = PSA_ERROR_BUFFER_TOO_SMALL;
4320 goto exit;
4321 }
4322
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 status = psa_generate_random(local_iv, default_iv_length);
4324 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004325 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004327 }
4328
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004329 status = psa_driver_wrapper_cipher_encrypt(
4330 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004331 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004332 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004334
4335exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004336 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004338 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004339 }
Ronald Cron23919522021-07-08 19:00:07 +02004340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 if (status == PSA_SUCCESS) {
4342 if (default_iv_length > 0) {
4343 memcpy(output, local_iv, default_iv_length);
4344 }
4345 *output_length += default_iv_length;
4346 } else {
4347 *output_length = 0;
4348 }
4349
4350 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004351}
4352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4354 psa_algorithm_t alg,
4355 const uint8_t *input,
4356 size_t input_length,
4357 uint8_t *output,
4358 size_t output_size,
4359 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004360{
4361 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004362 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004363 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004364 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004365
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004367 status = PSA_ERROR_INVALID_ARGUMENT;
4368 goto exit;
4369 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004370
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4372 PSA_KEY_USAGE_DECRYPT,
4373 alg);
4374 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004375 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004377
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004378 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004380 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4383 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004384 status = PSA_ERROR_INVALID_ARGUMENT;
4385 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004387 status = PSA_ERROR_INVALID_ARGUMENT;
4388 goto exit;
4389 }
4390
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004391 status = psa_driver_wrapper_cipher_decrypt(
4392 &attributes, slot->key.data, slot->key.bytes,
4393 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004395
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004396exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004397 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004399 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004403 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 }
Ronald Cron23919522021-07-08 19:00:07 +02004405
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004407}
4408
4409
mohammad16035955c982018-04-26 00:53:03 +03004410/****************************************************************/
4411/* AEAD */
4412/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004413
Paul Elliottbaff51c2021-09-28 17:44:45 +01004414/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004415static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004416{
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004418}
4419
4420/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004421static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4422 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004423{
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004425
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004427#if defined(PSA_WANT_ALG_GCM)
4428 case PSA_ALG_GCM:
4429 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 * arbitrarily large nonces. Please note that we do not generally
4431 * recommend the usage of nonces of greater length than
4432 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4433 * size, which can then lead to collisions if you encrypt a very
4434 * large number of messages.*/
4435 if (nonce_length != 0) {
4436 return PSA_SUCCESS;
4437 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004438 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004439#endif /* PSA_WANT_ALG_GCM */
4440#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004441 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (nonce_length >= 7 && nonce_length <= 13) {
4443 return PSA_SUCCESS;
4444 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004445 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004446#endif /* PSA_WANT_ALG_CCM */
4447#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004448 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 if (nonce_length == 12) {
4450 return PSA_SUCCESS;
4451 } else if (nonce_length == 8) {
4452 return PSA_ERROR_NOT_SUPPORTED;
4453 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004454 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004455#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004456 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004457 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004459 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004460
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004462}
4463
Gilles Peskine449bd832023-01-11 14:50:10 +01004464static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004465{
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4467 return PSA_ERROR_INVALID_ARGUMENT;
4468 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004469
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004471}
4472
Gilles Peskine449bd832023-01-11 14:50:10 +01004473psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4474 psa_algorithm_t alg,
4475 const uint8_t *nonce,
4476 size_t nonce_length,
4477 const uint8_t *additional_data,
4478 size_t additional_data_length,
4479 const uint8_t *plaintext,
4480 size_t plaintext_length,
4481 uint8_t *ciphertext,
4482 size_t ciphertext_size,
4483 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004484{
Ronald Cron215633c2021-03-16 17:15:37 +01004485 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4486 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004487
mohammad1603f08a5502018-06-03 15:05:47 +03004488 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004489
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 status = psa_aead_check_algorithm(alg);
4491 if (status != PSA_SUCCESS) {
4492 return status;
4493 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004494
Ronald Cron9a986162021-03-26 12:40:07 +01004495 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4497 if (status != PSA_SUCCESS) {
4498 return status;
4499 }
mohammad16035955c982018-04-26 00:53:03 +03004500
Ronald Cron215633c2021-03-16 17:15:37 +01004501 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004503 };
mohammad16035955c982018-04-26 00:53:03 +03004504
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 status = psa_aead_check_nonce_length(alg, nonce_length);
4506 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004507 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004509
Ronald Cronde822812021-03-17 16:08:20 +01004510 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004511 &attributes, slot->key.data, slot->key.bytes,
4512 alg,
4513 nonce, nonce_length,
4514 additional_data, additional_data_length,
4515 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004517
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4519 memset(ciphertext, 0, ciphertext_size);
4520 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004521
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004522exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004523 psa_unregister_read_under_mutex(slot);
mohammad16035955c982018-04-26 00:53:03 +03004524
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004526}
4527
Gilles Peskine449bd832023-01-11 14:50:10 +01004528psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4529 psa_algorithm_t alg,
4530 const uint8_t *nonce,
4531 size_t nonce_length,
4532 const uint8_t *additional_data,
4533 size_t additional_data_length,
4534 const uint8_t *ciphertext,
4535 size_t ciphertext_length,
4536 uint8_t *plaintext,
4537 size_t plaintext_size,
4538 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004539{
Ronald Cron215633c2021-03-16 17:15:37 +01004540 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4541 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004542
Gilles Peskineee652a32018-06-01 19:23:52 +02004543 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004544
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 status = psa_aead_check_algorithm(alg);
4546 if (status != PSA_SUCCESS) {
4547 return status;
4548 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004549
Ronald Cron9a986162021-03-26 12:40:07 +01004550 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4552 if (status != PSA_SUCCESS) {
4553 return status;
4554 }
mohammad16035955c982018-04-26 00:53:03 +03004555
Ronald Cron215633c2021-03-16 17:15:37 +01004556 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004558 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004559
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 status = psa_aead_check_nonce_length(alg, nonce_length);
4561 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004562 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004564
Ronald Cronde822812021-03-17 16:08:20 +01004565 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004566 &attributes, slot->key.data, slot->key.bytes,
4567 alg,
4568 nonce, nonce_length,
4569 additional_data, additional_data_length,
4570 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004572
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 if (status != PSA_SUCCESS && plaintext_size != 0) {
4574 memset(plaintext, 0, plaintext_size);
4575 }
mohammad160360a64d02018-06-03 17:20:42 +03004576
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004577exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004578 psa_unregister_read_under_mutex(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 return status;
mohammad16035955c982018-04-26 00:53:03 +03004581}
4582
Gilles Peskine449bd832023-01-11 14:50:10 +01004583static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4584{
4585 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004586
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004588#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004590 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4592 return PSA_ERROR_INVALID_ARGUMENT;
4593 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004594 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004595#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004596
Przemek Stekiel86679c72022-10-06 17:06:56 +02004597#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004599 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4601 return PSA_ERROR_INVALID_ARGUMENT;
4602 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004603 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004604#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004605
Przemek Stekiel86679c72022-10-06 17:06:56 +02004606#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004608 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 if (tag_len != 16) {
4610 return PSA_ERROR_INVALID_ARGUMENT;
4611 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004612 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004613#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004614
4615 default:
4616 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004618 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004620}
4621
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004622/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004623static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4624 int is_encrypt,
4625 mbedtls_svc_key_id_t key,
4626 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004627{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004628 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4629 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4630 psa_key_slot_t *slot = NULL;
4631 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004632 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004633
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 status = psa_aead_check_algorithm(alg);
4635 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004636 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004638
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004640 status = PSA_ERROR_BAD_STATE;
4641 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004642 }
4643
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 if (operation->nonce_set || operation->lengths_set ||
4645 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004646 status = PSA_ERROR_BAD_STATE;
4647 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004648 }
4649
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004651 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004653 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004655
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4657 alg);
4658 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004659 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004661
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004662 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004663 .core = slot->attr
4664 };
4665
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004667 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 if (is_encrypt) {
4671 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4672 &attributes,
4673 slot->key.data,
4674 slot->key.bytes,
4675 alg);
4676 } else {
4677 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4678 &attributes,
4679 slot->key.data,
4680 slot->key.bytes,
4681 alg);
4682 }
4683 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004684 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004688
4689exit:
Ryan Everett9af70e52024-02-14 18:38:56 +00004690 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004691
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004693 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004695 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 } else {
4697 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004698 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004699
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004701}
4702
Paul Elliott302ff6b2021-04-20 18:10:30 +01004703/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004704psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4705 mbedtls_svc_key_id_t key,
4706 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004707{
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004709}
4710
4711/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004712psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4713 mbedtls_svc_key_id_t key,
4714 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004715{
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004717}
4718
4719/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004720psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4721 uint8_t *nonce,
4722 size_t nonce_size,
4723 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004724{
4725 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004726 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004727 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004728
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004729 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004730
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004732 status = PSA_ERROR_BAD_STATE;
4733 goto exit;
4734 }
4735
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004737 status = PSA_ERROR_BAD_STATE;
4738 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004739 }
4740
Paul Elliotte193ea82021-10-01 13:00:16 +01004741 /* For CCM, this size may not be correct according to the PSA
4742 * specification. The PSA Crypto 1.0.1 specification states:
4743 *
4744 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4745 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4746 *
4747 * However this restriction that L has to be the smallest integer is not
4748 * applied in practice, and it is not implementable here since the
4749 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4751 operation->alg);
4752 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004753 status = PSA_ERROR_BUFFER_TOO_SMALL;
4754 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004755 }
4756
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 status = psa_generate_random(local_nonce, required_nonce_size);
4758 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004759 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004761
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004763
Paul Elliott39dc6b82021-05-11 19:16:09 +01004764exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 if (status == PSA_SUCCESS) {
4766 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004767 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 } else {
4769 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004770 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004771
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004773}
4774
4775/* Set the nonce for a multipart authenticated encryption or decryption
4776 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004777psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4778 const uint8_t *nonce,
4779 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004780{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004781 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4782
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004784 status = PSA_ERROR_BAD_STATE;
4785 goto exit;
4786 }
4787
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004789 status = PSA_ERROR_BAD_STATE;
4790 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004791 }
4792
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4794 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004795 status = PSA_ERROR_INVALID_ARGUMENT;
4796 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004797 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004798
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4800 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004801
Paul Elliott39dc6b82021-05-11 19:16:09 +01004802exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004804 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 } else {
4806 psa_aead_abort(operation);
4807 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004808
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004810}
4811
4812/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004813psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4814 size_t ad_length,
4815 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004816{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004817 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4818
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004820 status = PSA_ERROR_BAD_STATE;
4821 goto exit;
4822 }
4823
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 if (operation->lengths_set || operation->ad_started ||
4825 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004826 status = PSA_ERROR_BAD_STATE;
4827 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004828 }
4829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004831#if defined(PSA_WANT_ALG_GCM)
4832 case PSA_ALG_GCM:
4833 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 * bits. Without the guard this code will generate warnings on 32bit
4835 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004836#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 if (((uint64_t) ad_length) >> 61 != 0 ||
4838 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004839 status = PSA_ERROR_INVALID_ARGUMENT;
4840 goto exit;
4841 }
Paul Elliott325d3742021-09-27 17:56:28 +01004842#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004843 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004844#endif /* PSA_WANT_ALG_GCM */
4845#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004846 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004848 status = PSA_ERROR_INVALID_ARGUMENT;
4849 goto exit;
4850 }
4851 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004852#endif /* PSA_WANT_ALG_CCM */
4853#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004854 case PSA_ALG_CHACHA20_POLY1305:
4855 /* No length restrictions for ChaChaPoly. */
4856 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004857#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004858 default:
4859 break;
4860 }
Paul Elliott325d3742021-09-27 17:56:28 +01004861
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4863 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004864
Paul Elliott39dc6b82021-05-11 19:16:09 +01004865exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004867 operation->ad_remaining = ad_length;
4868 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004869 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 } else {
4871 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004872 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004873
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004875}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004876
4877/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004878psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4879 const uint8_t *input,
4880 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004881{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004882 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4883
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004885 status = PSA_ERROR_BAD_STATE;
4886 goto exit;
4887 }
4888
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004890 status = PSA_ERROR_BAD_STATE;
4891 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004892 }
4893
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 if (operation->lengths_set) {
4895 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004896 status = PSA_ERROR_INVALID_ARGUMENT;
4897 goto exit;
4898 }
4899
4900 operation->ad_remaining -= input_length;
4901 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004902#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004904 status = PSA_ERROR_BAD_STATE;
4905 goto exit;
4906 }
4907#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004908
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 status = psa_driver_wrapper_aead_update_ad(operation, input,
4910 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004911
Paul Elliott39dc6b82021-05-11 19:16:09 +01004912exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004914 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 } else {
4916 psa_aead_abort(operation);
4917 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004918
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004920}
4921
4922/* Encrypt or decrypt a message fragment in an active multipart AEAD
4923 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004924psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4925 const uint8_t *input,
4926 size_t input_length,
4927 uint8_t *output,
4928 size_t output_size,
4929 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004930{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004931 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004932
4933 *output_length = 0;
4934
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004936 status = PSA_ERROR_BAD_STATE;
4937 goto exit;
4938 }
4939
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004941 status = PSA_ERROR_BAD_STATE;
4942 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004943 }
4944
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004946 /* Additional data length was supplied, but not all the additional
4947 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004949 status = PSA_ERROR_INVALID_ARGUMENT;
4950 goto exit;
4951 }
4952
4953 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004955 status = PSA_ERROR_INVALID_ARGUMENT;
4956 goto exit;
4957 }
4958
4959 operation->body_remaining -= input_length;
4960 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004961#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004963 status = PSA_ERROR_BAD_STATE;
4964 goto exit;
4965 }
4966#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004967
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4969 output, output_size,
4970 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004971
Paul Elliott39dc6b82021-05-11 19:16:09 +01004972exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004974 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 } else {
4976 psa_aead_abort(operation);
4977 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004978
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004980}
4981
Gilles Peskine449bd832023-01-11 14:50:10 +01004982static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004983{
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 if (operation->id == 0 || !operation->nonce_set) {
4985 return PSA_ERROR_BAD_STATE;
4986 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004987
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4989 operation->body_remaining != 0)) {
4990 return PSA_ERROR_INVALID_ARGUMENT;
4991 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004992
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004994}
4995
Paul Elliott302ff6b2021-04-20 18:10:30 +01004996/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004997psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4998 uint8_t *ciphertext,
4999 size_t ciphertext_size,
5000 size_t *ciphertext_length,
5001 uint8_t *tag,
5002 size_t tag_size,
5003 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005004{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005005 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5006
Paul Elliott302ff6b2021-04-20 18:10:30 +01005007 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005008 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 status = psa_aead_final_checks(operation);
5011 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005012 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005014
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005016 status = PSA_ERROR_BAD_STATE;
5017 goto exit;
5018 }
5019
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5021 ciphertext_size,
5022 ciphertext_length,
5023 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005024
Paul Elliott39dc6b82021-05-11 19:16:09 +01005025exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005026
5027
Paul Elliottf47b0952021-05-21 18:02:33 +01005028 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005029 * the zero tag size, make sure the tag is set to something implausible.
5030 * Even if the operation succeeds, make sure we clear the rest of the
5031 * buffer to prevent potential leakage of anything previously placed in
5032 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005033 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005034
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005036
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005038}
5039
5040/* Finish authenticating and decrypting a message in a multipart AEAD
5041 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005042psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5043 uint8_t *plaintext,
5044 size_t plaintext_size,
5045 size_t *plaintext_length,
5046 const uint8_t *tag,
5047 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005048{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005049 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5050
Paul Elliott302ff6b2021-04-20 18:10:30 +01005051 *plaintext_length = 0;
5052
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 status = psa_aead_final_checks(operation);
5054 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005055 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005057
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005059 status = PSA_ERROR_BAD_STATE;
5060 goto exit;
5061 }
5062
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5064 plaintext_size,
5065 plaintext_length,
5066 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005067
5068exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005070
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005072}
5073
5074/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005075psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005076{
5077 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5078
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005080 /* The object has (apparently) been initialized but it is not (yet)
5081 * in use. It's ok to call abort on such an object, and there's
5082 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005084 }
5085
Gilles Peskine449bd832023-01-11 14:50:10 +01005086 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005087
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005089
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005091}
5092
Gilles Peskinee59236f2018-01-27 23:32:46 +01005093/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005094/* Generators */
5095/****************************************************************/
5096
Przemek Stekiel69c46792022-06-10 12:59:51 +02005097#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005098 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005099 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305100 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305101 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005102#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005103#endif /* At least one builtin KDF */
5104
Przemek Stekiel69c46792022-06-10 12:59:51 +02005105#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005106 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5107 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5108static psa_status_t psa_key_derivation_start_hmac(
5109 psa_mac_operation_t *operation,
5110 psa_algorithm_t hash_alg,
5111 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005113{
5114 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5115 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5117 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5118 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005119
Steven Cooreman72f736a2021-05-07 14:14:37 +02005120 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005122
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 status = psa_driver_wrapper_mac_sign_setup(operation,
5124 &attributes,
5125 hmac_key, hmac_key_length,
5126 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005127
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 psa_reset_key_attributes(&attributes);
5129 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005130}
5131#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005132
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005133#define HKDF_STATE_INIT 0 /* no input yet */
5134#define HKDF_STATE_STARTED 1 /* got salt */
5135#define HKDF_STATE_KEYED 2 /* got key */
5136#define HKDF_STATE_OUTPUT 3 /* output started */
5137
Gilles Peskinecbe66502019-05-16 16:59:18 +02005138static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005140{
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5142 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5143 } else {
5144 return operation->alg;
5145 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005146}
5147
Gilles Peskine449bd832023-01-11 14:50:10 +01005148psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005149{
5150 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5152 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005153 /* The object has (apparently) been initialized but it is not
5154 * in use. It's ok to call abort on such an object, and there's
5155 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005157#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5159 mbedtls_free(operation->ctx.hkdf.info);
5160 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5161 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005162#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005163#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5164 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5166 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5167 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5168 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005169 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005171 }
5172
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005174 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005176 }
5177
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005179 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005181 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005182#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005184 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005186 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005187#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005188 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005189
5190 /* We leave the fields Ai and output_block to be erased safely by the
5191 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005193#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5194 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005195#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5197 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5198 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5199 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005200#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305201#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305202 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305203 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005204 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305205 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305206 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305207
5208 status = PSA_SUCCESS;
5209 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305210#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005211 {
5212 status = PSA_ERROR_BAD_STATE;
5213 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 mbedtls_platform_zeroize(operation, sizeof(*operation));
5215 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005216}
5217
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005218psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005220{
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005222 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005224 }
5225
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005226 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005228}
5229
Gilles Peskine449bd832023-01-11 14:50:10 +01005230psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5231 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005232{
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 if (operation->alg == 0) {
5234 return PSA_ERROR_BAD_STATE;
5235 }
5236 if (capacity > operation->capacity) {
5237 return PSA_ERROR_INVALID_ARGUMENT;
5238 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005239 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005241}
5242
Przemek Stekiel69c46792022-06-10 12:59:51 +02005243#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005244/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005245static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5246 psa_algorithm_t kdf_alg,
5247 uint8_t *output,
5248 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005249{
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5251 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005252 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005253 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005254#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005256#else
5257 const uint8_t last_block = 0xff;
5258#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005259
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 if (hkdf->state < HKDF_STATE_KEYED ||
5261 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005262#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005264#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 )) {
5266 return PSA_ERROR_BAD_STATE;
5267 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005268 hkdf->state = HKDF_STATE_OUTPUT;
5269
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005271 /* Copy what remains of the current block */
5272 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005274 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 }
5276 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005277 output += n;
5278 output_length -= n;
5279 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005281 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005282 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005283 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005284 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005285 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005286 * object was corrupted or if this function is called directly
5287 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 if (hkdf->block_number == last_block) {
5289 return PSA_ERROR_BAD_STATE;
5290 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005291
5292 /* We need a new block */
5293 ++hkdf->block_number;
5294 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005295
Gilles Peskine449bd832023-01-11 14:50:10 +01005296 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5297 hash_alg,
5298 hkdf->prk,
5299 hash_length);
5300 if (status != PSA_SUCCESS) {
5301 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005302 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005303
5304 if (hkdf->block_number != 1) {
5305 status = psa_mac_update(&hkdf->hmac,
5306 hkdf->output_block,
5307 hash_length);
5308 if (status != PSA_SUCCESS) {
5309 return status;
5310 }
5311 }
5312 status = psa_mac_update(&hkdf->hmac,
5313 hkdf->info,
5314 hkdf->info_length);
5315 if (status != PSA_SUCCESS) {
5316 return status;
5317 }
5318 status = psa_mac_update(&hkdf->hmac,
5319 &hkdf->block_number, 1);
5320 if (status != PSA_SUCCESS) {
5321 return status;
5322 }
5323 status = psa_mac_sign_finish(&hkdf->hmac,
5324 hkdf->output_block,
5325 sizeof(hkdf->output_block),
5326 &hmac_output_length);
5327 if (status != PSA_SUCCESS) {
5328 return status;
5329 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005330 }
5331
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005333}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005334#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005335
John Durkop07cc04a2020-11-16 22:08:34 -08005336#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5337 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005338static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5339 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005341{
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5343 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005344 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5345 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005346 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005347
Janos Follath7742fee2019-06-17 12:58:10 +01005348 /* We can't be wanting more output after block 0xff, otherwise
5349 * the capacity check in psa_key_derivation_output_bytes() would have
5350 * prevented this call. It could happen only if the operation
5351 * object was corrupted or if this function is called directly
5352 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 if (tls12_prf->block_number == 0xff) {
5354 return PSA_ERROR_CORRUPTION_DETECTED;
5355 }
Janos Follath7742fee2019-06-17 12:58:10 +01005356
5357 /* We need a new block */
5358 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005359 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005360
5361 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5362 *
5363 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5364 *
5365 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5366 * HMAC_hash(secret, A(2) + seed) +
5367 * HMAC_hash(secret, A(3) + seed) + ...
5368 *
5369 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005370 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005371 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005372 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005373 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005374 * is currently extracted as `output_block` and where i is
5375 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005376 */
5377
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 status = psa_key_derivation_start_hmac(&hmac,
5379 hash_alg,
5380 tls12_prf->secret,
5381 tls12_prf->secret_length);
5382 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005383 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005385
5386 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005388 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5389 * the variable seed and in this instance means it in the context of the
5390 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 status = psa_mac_update(&hmac,
5392 tls12_prf->label,
5393 tls12_prf->label_length);
5394 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005395 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 }
5397 status = psa_mac_update(&hmac,
5398 tls12_prf->seed,
5399 tls12_prf->seed_length);
5400 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005401 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 }
5403 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005404 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5406 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005407 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005409 }
5410
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 status = psa_mac_sign_finish(&hmac,
5412 tls12_prf->Ai, hash_length,
5413 &hmac_output_length);
5414 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005415 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 }
5417 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005418 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005420
5421 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 status = psa_key_derivation_start_hmac(&hmac,
5423 hash_alg,
5424 tls12_prf->secret,
5425 tls12_prf->secret_length);
5426 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005427 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 }
5429 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5430 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005431 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 }
5433 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5434 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005435 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 }
5437 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5438 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005439 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 }
5441 status = psa_mac_sign_finish(&hmac,
5442 tls12_prf->output_block, hash_length,
5443 &hmac_output_length);
5444 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005445 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005447
Janos Follath7742fee2019-06-17 12:58:10 +01005448
5449cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 cleanup_status = psa_mac_abort(&hmac);
5451 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005452 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005454
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005456}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005457
Janos Follath844eb0e2019-06-19 12:10:49 +01005458static psa_status_t psa_key_derivation_tls12_prf_read(
5459 psa_tls12_prf_key_derivation_t *tls12_prf,
5460 psa_algorithm_t alg,
5461 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005463{
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5465 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005466 psa_status_t status;
5467 uint8_t offset, length;
5468
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005470 case PSA_TLS12_PRF_STATE_LABEL_SET:
5471 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5472 break;
5473 case PSA_TLS12_PRF_STATE_OUTPUT:
5474 break;
5475 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005477 }
5478
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005480 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 if (tls12_prf->left_in_block == 0) {
5482 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5483 alg);
5484 if (status != PSA_SUCCESS) {
5485 return status;
5486 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005487
5488 continue;
5489 }
5490
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005492 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005494 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005496
5497 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005499 output += length;
5500 output_length -= length;
5501 tls12_prf->left_in_block -= length;
5502 }
5503
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005505}
John Durkop07cc04a2020-11-16 22:08:34 -08005506#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5507 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005508
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005509#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5510static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5511 psa_tls12_ecjpake_to_pms_t *ecjpake,
5512 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005514{
5515 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005516 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005517
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 if (output_length != 32) {
5519 return PSA_ERROR_INVALID_ARGUMENT;
5520 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005521
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5523 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5524 &output_size);
5525 if (status != PSA_SUCCESS) {
5526 return status;
5527 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005528
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 if (output_size != output_length) {
5530 return PSA_ERROR_GENERIC_ERROR;
5531 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005532
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005534}
5535#endif
5536
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305537#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305538static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5539 psa_pbkdf2_key_derivation_t *pbkdf2,
5540 psa_algorithm_t prf_alg,
5541 uint8_t prf_output_length,
5542 psa_key_attributes_t *attributes)
5543{
5544 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305545 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305546 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305547 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305548 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305549 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305550 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305551
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305552 mac_operation.is_sign = 1;
5553 mac_operation.mac_size = prf_output_length;
5554 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305555
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305556 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5557 attributes,
5558 pbkdf2->password,
5559 pbkdf2->password_length,
5560 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305561 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305562 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305563 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305564 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5565 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305566 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305567 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305568 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305569 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305570 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305571 }
5572 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5573 &mac_output_length);
5574 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305575 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305576 }
5577
5578 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305579 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305580 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305581 }
5582
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305583 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305584
5585 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305586 /* We are passing prf_output_length as mac_size because the driver
5587 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305588 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305589 status = psa_driver_wrapper_mac_compute(attributes,
5590 pbkdf2->password,
5591 pbkdf2->password_length,
5592 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305593 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305594 &mac_output_length);
5595 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305596 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305597 }
5598
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305599 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305600 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305601
5602cleanup:
5603 /* Zeroise buffers to clear sensitive data from memory. */
5604 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5605 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305606}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305607
5608static psa_status_t psa_key_derivation_pbkdf2_read(
5609 psa_pbkdf2_key_derivation_t *pbkdf2,
5610 psa_algorithm_t kdf_alg,
5611 uint8_t *output,
5612 size_t output_length)
5613{
5614 psa_status_t status;
5615 psa_algorithm_t prf_alg;
5616 uint8_t prf_output_length;
5617 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5618 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5619 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5620
5621 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5622 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5623 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5624 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305625 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5626 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305627 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305628 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305629 } else {
5630 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305631 }
5632
5633 switch (pbkdf2->state) {
5634 case PSA_PBKDF2_STATE_PASSWORD_SET:
5635 /* Initially we need a new block so bytes_used is equal to block size*/
5636 pbkdf2->bytes_used = prf_output_length;
5637 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5638 break;
5639 case PSA_PBKDF2_STATE_OUTPUT:
5640 break;
5641 default:
5642 return PSA_ERROR_BAD_STATE;
5643 }
5644
5645 while (output_length != 0) {
5646 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5647 if (n > output_length) {
5648 n = (uint8_t) output_length;
5649 }
5650 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5651 output += n;
5652 output_length -= n;
5653 pbkdf2->bytes_used += n;
5654
5655 if (output_length == 0) {
5656 break;
5657 }
5658
5659 /* We need a new block */
5660 pbkdf2->bytes_used = 0;
5661 pbkdf2->block_number++;
5662
5663 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5664 prf_output_length,
5665 &attributes);
5666 if (status != PSA_SUCCESS) {
5667 return status;
5668 }
5669 }
5670
5671 return PSA_SUCCESS;
5672}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305673#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305674
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005675psa_status_t psa_key_derivation_output_bytes(
5676 psa_key_derivation_operation_t *operation,
5677 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005679{
5680 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005682
Gilles Peskine449bd832023-01-11 14:50:10 +01005683 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005684 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005686 }
5687
Gilles Peskine449bd832023-01-11 14:50:10 +01005688 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005689 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005690 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005691 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005692 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005693 goto exit;
5694 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005696 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005697 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005698 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5699 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005700 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005701 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005703 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005704 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005705
Przemek Stekiel69c46792022-06-10 12:59:51 +02005706#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5708 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5709 output, output_length);
5710 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005711#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005712#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5713 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5715 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5716 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5717 kdf_alg, output,
5718 output_length);
5719 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005720#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5721 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005722#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005724 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5726 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005727#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305728#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305729 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305730 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5731 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305732 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305733#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005734
Gilles Peskineeab56e42018-07-12 17:12:33 +02005735 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005736 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005738 }
5739
5740exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005742 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005743 * This allows us to differentiate between exhausted operations and
5744 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5745 * operations. */
5746 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005748 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005750 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005752}
5753
David Brown7807bf72021-02-09 16:28:23 -07005754#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005755static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005756{
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 if (data_size >= 8) {
5758 mbedtls_des_key_set_parity(data);
5759 }
5760 if (data_size >= 16) {
5761 mbedtls_des_key_set_parity(data + 8);
5762 }
5763 if (data_size >= 24) {
5764 mbedtls_des_key_set_parity(data + 16);
5765 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005766}
David Brown7807bf72021-02-09 16:28:23 -07005767#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005768
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005769/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 * ECC keys on a Weierstrass elliptic curve require the generation
5771 * of a private key which is an integer
5772 * in the range [1, N - 1], where N is the boundary of the private key domain:
5773 * N is the prime p for Diffie-Hellman, or the order of the
5774 * curve’s base point for ECC.
5775 *
5776 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5777 * This function generates the private key using the following process:
5778 *
5779 * 1. Draw a byte string of length ceiling(m/8) bytes.
5780 * 2. If m is not a multiple of 8, set the most significant
5781 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5782 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5783 * 4. If k > N - 2, discard the result and return to step 1.
5784 * 5. Output k + 1 as the private key.
5785 *
5786 * This method allows compliance to NIST standards, specifically the methods titled
5787 * Key-Pair Generation by Testing Candidates in the following publications:
5788 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5789 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5790 * Diffie-Hellman keys.
5791 *
5792 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5793 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5794 *
5795 * Note: Function allocates memory for *data buffer, so given *data should be
5796 * always NULL.
5797 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005798#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5799#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005800static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005801 psa_key_slot_t *slot,
5802 size_t bits,
5803 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005804 uint8_t **data
5805 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005806{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005807 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005808 mbedtls_mpi k;
5809 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005810 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005811 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005812 size_t m;
5813 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005814
Gilles Peskine449bd832023-01-11 14:50:10 +01005815 mbedtls_mpi_init(&k);
5816 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005817
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005818 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005820 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005821 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005822
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005824 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005825 goto cleanup;
5826 }
5827
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005828 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005830
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005832
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005833 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005834 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005835 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005836
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005837 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005838
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005839 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005841
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005842 /* Note: This function is always called with *data == NULL and it
5843 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 *data = mbedtls_calloc(1, m_bytes);
5845 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005846 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005847 goto cleanup;
5848 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005849
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005851 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005853 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005855
5856 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005858 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005859 * (8 * ceiling(m/8) - m) bits of the first byte in
5860 * the string to zero.
5861 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005863 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005864 }
5865
5866 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 * big-endian byte string.
5868 */
5869 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005870
5871 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 * Result of comparison is returned. When it indicates error
5873 * then this function is called again.
5874 */
5875 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005876 }
5877
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005878 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5880 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005881cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 if (ret != 0) {
5883 status = mbedtls_to_psa_error(ret);
5884 }
5885 if (status != PSA_SUCCESS) {
5886 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005887 *data = NULL;
5888 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 mbedtls_mpi_free(&k);
5890 mbedtls_mpi_free(&diff_N_2);
5891 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005892}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005893
5894/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5895 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5896 *
5897 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5898 * draw a 32-byte string and process it as specified in
5899 * Elliptic Curves for Security [RFC7748] §5.
5900 *
5901 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5902 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5903 *
5904 * Note: Function allocates memory for *data buffer, so given *data should be
5905 * always NULL.
5906 */
5907
5908static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5909 size_t bits,
5910 psa_key_derivation_operation_t *operation,
5911 uint8_t **data
5912 )
5913{
5914 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005915 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005916
Gilles Peskine449bd832023-01-11 14:50:10 +01005917 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005918 case 255:
5919 output_length = 32;
5920 break;
5921 case 448:
5922 output_length = 56;
5923 break;
5924 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005926 break;
5927 }
5928
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005930
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 if (*data == NULL) {
5932 return PSA_ERROR_INSUFFICIENT_MEMORY;
5933 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005934
Gilles Peskine449bd832023-01-11 14:50:10 +01005935 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005936
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005938 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005940
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005942 case 255:
5943 (*data)[0] &= 248;
5944 (*data)[31] &= 127;
5945 (*data)[31] |= 64;
5946 break;
5947 case 448:
5948 (*data)[0] &= 252;
5949 (*data)[55] |= 128;
5950 break;
5951 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005953 break;
5954 }
5955
5956 return status;
5957}
Valerio Setti86587ab2023-06-27 13:09:30 +02005958#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5959static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5960 psa_key_slot_t *slot, size_t bits,
5961 psa_key_derivation_operation_t *operation, uint8_t **data)
5962{
5963 (void) slot;
5964 (void) bits;
5965 (void) operation;
5966 (void) data;
5967 return PSA_ERROR_NOT_SUPPORTED;
5968}
5969
5970static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5971 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5972{
5973 (void) bits;
5974 (void) operation;
5975 (void) data;
5976 return PSA_ERROR_NOT_SUPPORTED;
5977}
5978#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5979#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005980
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005981static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005982 psa_key_slot_t *slot,
5983 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005985{
5986 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305988 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005989 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005990 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005991
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5993 return PSA_ERROR_INVALID_ARGUMENT;
5994 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005995
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005996#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005997 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5999 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6000 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006001 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6003 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006004 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 }
6006 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006007 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6009 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006010 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006012 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006013 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006014#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006015 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 if (key_type_is_raw_bytes(slot->attr.type)) {
6017 if (bits % 8 != 0) {
6018 return PSA_ERROR_INVALID_ARGUMENT;
6019 }
6020 data = mbedtls_calloc(1, bytes);
6021 if (data == NULL) {
6022 return PSA_ERROR_INSUFFICIENT_MEMORY;
6023 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006024
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 status = psa_key_derivation_output_bytes(operation, data, bytes);
6026 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006027 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 }
David Brown12ca5032021-02-11 11:02:00 -07006029#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6031 psa_des_set_key_parity(data, bytes);
6032 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006033#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 } else {
6035 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006036 }
Ronald Crondd04d422020-11-28 15:14:42 +01006037
Ronald Cronbf33c932020-11-28 18:06:53 +01006038 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006039 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006041 };
6042
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6044 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6045 &storage_size);
6046 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306047 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006048 }
Archanad8a83dc2021-06-14 10:04:16 +05306049 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 status = psa_allocate_buffer_to_slot(slot, storage_size);
6051 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306052 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 }
Archanad8a83dc2021-06-14 10:04:16 +05306054
Gilles Peskine449bd832023-01-11 14:50:10 +01006055 status = psa_driver_wrapper_import_key(&attributes,
6056 data, bytes,
6057 slot->key.data,
6058 slot->key.bytes,
6059 &slot->key.bytes, &bits);
6060 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006061 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006063
6064exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006065 mbedtls_free(data);
6066 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006067}
6068
Gilles Peskine092ce512024-02-20 12:31:24 +01006069static const psa_key_production_parameters_t default_production_parameters =
6070 PSA_KEY_PRODUCTION_PARAMETERS_INIT;
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006071
Gilles Peskine092ce512024-02-20 12:31:24 +01006072int psa_key_production_parameters_are_default(
6073 const psa_key_production_parameters_t *params,
6074 size_t params_data_length)
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006075{
Gilles Peskine092ce512024-02-20 12:31:24 +01006076 if (params->flags != 0) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006077 return 0;
6078 }
Gilles Peskine092ce512024-02-20 12:31:24 +01006079 if (params_data_length != 0) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006080 return 0;
6081 }
6082 return 1;
6083}
6084
6085psa_status_t psa_key_derivation_output_key_ext(
6086 const psa_key_attributes_t *attributes,
6087 psa_key_derivation_operation_t *operation,
Gilles Peskine092ce512024-02-20 12:31:24 +01006088 const psa_key_production_parameters_t *params,
6089 size_t params_data_length,
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006090 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006091{
6092 psa_status_t status;
6093 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006094 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006095
Ronald Cron81709fc2020-11-14 12:10:32 +01006096 *key = MBEDTLS_SVC_KEY_ID_INIT;
6097
Gilles Peskine0f84d622019-09-12 19:03:13 +02006098 /* Reject any attempt to create a zero-length key so that we don't
6099 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 if (psa_get_key_bits(attributes) == 0) {
6101 return PSA_ERROR_INVALID_ARGUMENT;
6102 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006103
Gilles Peskine092ce512024-02-20 12:31:24 +01006104 if (!psa_key_production_parameters_are_default(params, params_data_length)) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006105 return PSA_ERROR_INVALID_ARGUMENT;
6106 }
6107
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 if (operation->alg == PSA_ALG_NONE) {
6109 return PSA_ERROR_BAD_STATE;
6110 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006111
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 if (!operation->can_output_key) {
6113 return PSA_ERROR_NOT_PERMITTED;
6114 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006115
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6117 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006118#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006120 /* Deriving a key in a secure element is not implemented yet. */
6121 status = PSA_ERROR_NOT_SUPPORTED;
6122 }
6123#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 if (status == PSA_SUCCESS) {
6125 status = psa_generate_derived_key_internal(slot,
6126 attributes->core.bits,
6127 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006128 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 if (status == PSA_SUCCESS) {
6130 status = psa_finish_key_creation(slot, driver, key);
6131 }
6132 if (status != PSA_SUCCESS) {
6133 psa_fail_key_creation(slot, driver);
6134 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006135
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006137}
6138
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006139psa_status_t psa_key_derivation_output_key(
6140 const psa_key_attributes_t *attributes,
6141 psa_key_derivation_operation_t *operation,
6142 mbedtls_svc_key_id_t *key)
6143{
Gilles Peskinec81393b2024-02-14 20:51:28 +01006144 return psa_key_derivation_output_key_ext(attributes, operation,
Gilles Peskine092ce512024-02-20 12:31:24 +01006145 &default_production_parameters, 0,
Gilles Peskinec81393b2024-02-14 20:51:28 +01006146 key);
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006147}
Gilles Peskineeab56e42018-07-12 17:12:33 +02006148
6149
6150/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006151/* Key derivation */
6152/****************************************************************/
6153
Steven Cooreman932ffb72021-02-15 12:14:32 +01006154#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006155static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006156{
6157#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6159 return 1;
6160 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006161#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006162#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6164 return 1;
6165 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006166#endif
6167#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6169 return 1;
6170 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006171#endif
6172#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6174 return 1;
6175 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006176#endif
6177#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6179 return 1;
6180 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006181#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006182#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6184 return 1;
6185 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006186#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306187#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6188 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6189 return 1;
6190 }
6191#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306192#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6193 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6194 return 1;
6195 }
6196#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006198}
6199
Gilles Peskine449bd832023-01-11 14:50:10 +01006200static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006201{
6202 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 psa_status_t status = psa_hash_setup(&operation, alg);
6204 psa_hash_abort(&operation);
6205 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006206}
6207
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306208static psa_status_t psa_key_derivation_set_maximum_capacity(
6209 psa_key_derivation_operation_t *operation,
6210 psa_algorithm_t kdf_alg)
6211{
6212#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6213 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6214 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6215 return PSA_SUCCESS;
6216 }
6217#endif
6218#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
6219 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6220#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05306221 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306222 PSA_KEY_TYPE_AES,
6223 128U,
6224 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306225#else
6226 operation->capacity = SIZE_MAX;
6227#endif
6228 return PSA_SUCCESS;
6229 }
6230#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
6231
6232 /* After this point, if kdf_alg is not valid then value of hash_alg may be
6233 * invalid or meaningless but it does not affect this function */
6234 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
6235 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306236 if (hash_size == 0) {
6237 return PSA_ERROR_NOT_SUPPORTED;
6238 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306239
6240 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6241 * we might fail later, which is somewhat unfriendly and potentially
6242 * risk-prone. */
6243 psa_status_t status = psa_hash_try_support(hash_alg);
6244 if (status != PSA_SUCCESS) {
6245 return status;
6246 }
6247
6248#if defined(PSA_WANT_ALG_HKDF)
6249 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6250 operation->capacity = 255 * hash_size;
6251 } else
6252#endif
6253#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6254 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6255 operation->capacity = hash_size;
6256 } else
6257#endif
6258#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6259 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6260 operation->capacity = 255 * hash_size;
6261 } else
6262#endif
6263#if defined(PSA_WANT_ALG_TLS12_PRF)
6264 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6265 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6266 operation->capacity = SIZE_MAX;
6267 } else
6268#endif
6269#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6270 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6271 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6272 /* Master Secret is always 48 bytes
6273 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6274 operation->capacity = 48U;
6275 } else
6276#endif
6277#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6278 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6279#if (SIZE_MAX > UINT32_MAX)
6280 operation->capacity = UINT32_MAX * hash_size;
6281#else
6282 operation->capacity = SIZE_MAX;
6283#endif
6284 } else
6285#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6286 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306287 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306288 status = PSA_ERROR_NOT_SUPPORTED;
6289 }
6290 return status;
6291}
6292
Gilles Peskine969c5d62019-01-16 15:53:06 +01006293static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006294 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006296{
Janos Follath5fe19732019-06-20 15:09:30 +01006297 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6298 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006300
Gilles Peskine969c5d62019-01-16 15:53:06 +01006301 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 if (!is_kdf_alg_supported(kdf_alg)) {
6303 return PSA_ERROR_NOT_SUPPORTED;
6304 }
John Durkop07cc04a2020-11-16 22:08:34 -08006305
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306306 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6307 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306308 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006309}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006310
Gilles Peskine449bd832023-01-11 14:50:10 +01006311static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006312{
6313#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006314 if (alg == PSA_ALG_ECDH) {
6315 return PSA_SUCCESS;
6316 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006317#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006318#if defined(PSA_WANT_ALG_FFDH)
6319 if (alg == PSA_ALG_FFDH) {
6320 return PSA_SUCCESS;
6321 }
6322#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006323 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006324 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006325}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006326
6327static int psa_key_derivation_allows_free_form_secret_input(
6328 psa_algorithm_t kdf_alg)
6329{
6330#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6331 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6332 return 0;
6333 }
6334#endif
6335 (void) kdf_alg;
6336 return 1;
6337}
John Durkop07cc04a2020-11-16 22:08:34 -08006338#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006339
Gilles Peskine449bd832023-01-11 14:50:10 +01006340psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6341 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006342{
6343 psa_status_t status;
6344
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 if (operation->alg != 0) {
6346 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006347 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006348
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6350 return PSA_ERROR_INVALID_ARGUMENT;
6351 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6352#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6353 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6354 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6355 status = psa_key_agreement_try_support(ka_alg);
6356 if (status != PSA_SUCCESS) {
6357 return status;
6358 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006359 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6360 return PSA_ERROR_INVALID_ARGUMENT;
6361 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6363#else
6364 return PSA_ERROR_NOT_SUPPORTED;
6365#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6366 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6367#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6368 status = psa_key_derivation_setup_kdf(operation, alg);
6369#else
6370 return PSA_ERROR_NOT_SUPPORTED;
6371#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6372 } else {
6373 return PSA_ERROR_INVALID_ARGUMENT;
6374 }
6375
6376 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006377 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 }
6379 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006380}
6381
Przemek Stekiel69c46792022-06-10 12:59:51 +02006382#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006383static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6384 psa_algorithm_t kdf_alg,
6385 psa_key_derivation_step_t step,
6386 const uint8_t *data,
6387 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006388{
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006390 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006392 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006393#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6395 return PSA_ERROR_INVALID_ARGUMENT;
6396 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006397#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006398 if (hkdf->state != HKDF_STATE_INIT) {
6399 return PSA_ERROR_BAD_STATE;
6400 } else {
6401 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6402 hash_alg,
6403 data, data_length);
6404 if (status != PSA_SUCCESS) {
6405 return status;
6406 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006407 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006409 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006410 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006411#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006413 /* We shouldn't be in different state as HKDF_EXPAND only allows
6414 * two inputs: SECRET (this case) and INFO which does not modify
6415 * the state. It could happen only if the hkdf
6416 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 if (hkdf->state != HKDF_STATE_INIT) {
6418 return PSA_ERROR_BAD_STATE;
6419 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006420
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006421 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6423 return PSA_ERROR_INVALID_ARGUMENT;
6424 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 memcpy(hkdf->prk, data, data_length);
6427 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006428#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006429 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006430 /* HKDF: If no salt was provided, use an empty salt.
6431 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006432 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006433#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6435 return PSA_ERROR_BAD_STATE;
6436 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006437#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6439 hash_alg,
6440 NULL, 0);
6441 if (status != PSA_SUCCESS) {
6442 return status;
6443 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006444 hkdf->state = HKDF_STATE_STARTED;
6445 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 if (hkdf->state != HKDF_STATE_STARTED) {
6447 return PSA_ERROR_BAD_STATE;
6448 }
6449 status = psa_mac_update(&hkdf->hmac,
6450 data, data_length);
6451 if (status != PSA_SUCCESS) {
6452 return status;
6453 }
6454 status = psa_mac_sign_finish(&hkdf->hmac,
6455 hkdf->prk,
6456 sizeof(hkdf->prk),
6457 &data_length);
6458 if (status != PSA_SUCCESS) {
6459 return status;
6460 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006461 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006462
Gilles Peskine2b522db2019-04-12 15:11:49 +02006463 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006464 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006465#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006467 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006469 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006471#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006472 {
6473 /* Block 0 is empty, and the next block will be
6474 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006476 }
6477
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006479 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006480#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6482 return PSA_ERROR_INVALID_ARGUMENT;
6483 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006484#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006485#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6487 hkdf->state == HKDF_STATE_INIT) {
6488 return PSA_ERROR_BAD_STATE;
6489 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006490#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 if (hkdf->state == HKDF_STATE_OUTPUT) {
6492 return PSA_ERROR_BAD_STATE;
6493 }
6494 if (hkdf->info_set) {
6495 return PSA_ERROR_BAD_STATE;
6496 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006497 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 if (data_length != 0) {
6499 hkdf->info = mbedtls_calloc(1, data_length);
6500 if (hkdf->info == NULL) {
6501 return PSA_ERROR_INSUFFICIENT_MEMORY;
6502 }
6503 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006504 }
6505 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006507 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006509 }
6510}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006511#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006512
John Durkop07cc04a2020-11-16 22:08:34 -08006513#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6514 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006515static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6516 const uint8_t *data,
6517 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006518{
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6520 return PSA_ERROR_BAD_STATE;
6521 }
Janos Follathf08e2652019-06-13 09:05:41 +01006522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 if (data_length != 0) {
6524 prf->seed = mbedtls_calloc(1, data_length);
6525 if (prf->seed == NULL) {
6526 return PSA_ERROR_INSUFFICIENT_MEMORY;
6527 }
Janos Follathf08e2652019-06-13 09:05:41 +01006528
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006530 prf->seed_length = data_length;
6531 }
Janos Follathf08e2652019-06-13 09:05:41 +01006532
Gilles Peskine43f958b2020-12-13 14:55:14 +01006533 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006534
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006536}
6537
Gilles Peskine449bd832023-01-11 14:50:10 +01006538static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6539 const uint8_t *data,
6540 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006541{
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6543 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6544 return PSA_ERROR_BAD_STATE;
6545 }
Janos Follath81550542019-06-13 14:26:34 +01006546
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 if (data_length != 0) {
6548 prf->secret = mbedtls_calloc(1, data_length);
6549 if (prf->secret == NULL) {
6550 return PSA_ERROR_INSUFFICIENT_MEMORY;
6551 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006552
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006554 prf->secret_length = data_length;
6555 }
Janos Follath81550542019-06-13 14:26:34 +01006556
Gilles Peskine43f958b2020-12-13 14:55:14 +01006557 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006558
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006560}
6561
Gilles Peskine449bd832023-01-11 14:50:10 +01006562static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6563 const uint8_t *data,
6564 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006565{
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6567 return PSA_ERROR_BAD_STATE;
6568 }
Janos Follath63028dd2019-06-13 09:15:47 +01006569
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 if (data_length != 0) {
6571 prf->label = mbedtls_calloc(1, data_length);
6572 if (prf->label == NULL) {
6573 return PSA_ERROR_INSUFFICIENT_MEMORY;
6574 }
Janos Follath63028dd2019-06-13 09:15:47 +01006575
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006577 prf->label_length = data_length;
6578 }
Janos Follath63028dd2019-06-13 09:15:47 +01006579
Gilles Peskine43f958b2020-12-13 14:55:14 +01006580 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006581
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006583}
6584
Gilles Peskine449bd832023-01-11 14:50:10 +01006585static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6586 psa_key_derivation_step_t step,
6587 const uint8_t *data,
6588 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006589{
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006591 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006592 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006593 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006595 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006597 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006599 }
6600}
John Durkop07cc04a2020-11-16 22:08:34 -08006601#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6602 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6603
6604#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6605static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6606 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006607 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006608 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006609{
6610 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6612 4 + data_length + prf->other_secret_length :
6613 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006614
Gilles Peskine449bd832023-01-11 14:50:10 +01006615 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6616 return PSA_ERROR_INVALID_ARGUMENT;
6617 }
John Durkop07cc04a2020-11-16 22:08:34 -08006618
Gilles Peskine449bd832023-01-11 14:50:10 +01006619 uint8_t *pms = mbedtls_calloc(1, pms_len);
6620 if (pms == NULL) {
6621 return PSA_ERROR_INSUFFICIENT_MEMORY;
6622 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006623 uint8_t *cur = pms;
6624
6625 /* pure-PSK:
6626 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006627 *
6628 * The premaster secret is formed as follows: if the PSK is N octets
6629 * long, concatenate a uint16 with the value N, N zero octets, a second
6630 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006631 *
6632 * mixed-PSK:
6633 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6634 * follows: concatenate a uint16 with the length of the other secret,
6635 * the other secret itself, uint16 with the length of PSK, and the
6636 * PSK itself.
6637 * For details please check:
6638 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6639 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6640 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006641 */
6642
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6644 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6645 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6646 if (prf->other_secret_length != 0) {
6647 memcpy(cur, prf->other_secret, prf->other_secret_length);
6648 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006649 cur += prf->other_secret_length;
6650 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 } else {
6652 *cur++ = MBEDTLS_BYTE_1(data_length);
6653 *cur++ = MBEDTLS_BYTE_0(data_length);
6654 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006655 cur += data_length;
6656 }
6657
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 *cur++ = MBEDTLS_BYTE_1(data_length);
6659 *cur++ = MBEDTLS_BYTE_0(data_length);
6660 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006661 cur += data_length;
6662
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006663 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006664
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006665 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006666 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006667}
Janos Follath6660f0e2019-06-17 08:44:03 +01006668
Przemek Stekiele47201b2022-04-19 13:53:28 +02006669static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6670 psa_tls12_prf_key_derivation_t *prf,
6671 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006672 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006673{
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6675 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006676 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006677
6678 if (data_length != 0) {
6679 prf->other_secret = mbedtls_calloc(1, data_length);
6680 if (prf->other_secret == NULL) {
6681 return PSA_ERROR_INSUFFICIENT_MEMORY;
6682 }
6683
6684 memcpy(prf->other_secret, data, data_length);
6685 prf->other_secret_length = data_length;
6686 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006687 prf->other_secret_length = 0;
6688 }
6689
6690 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6691
Gilles Peskine449bd832023-01-11 14:50:10 +01006692 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006693}
6694
Janos Follath6660f0e2019-06-17 08:44:03 +01006695static psa_status_t psa_tls12_prf_psk_to_ms_input(
6696 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006697 psa_key_derivation_step_t step,
6698 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006699 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006700{
Gilles Peskine449bd832023-01-11 14:50:10 +01006701 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006702 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 return psa_tls12_prf_psk_to_ms_set_key(prf,
6704 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006705 break;
6706 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6708 data,
6709 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006710 break;
6711 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006712 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006713 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006714
Przemek Stekiele47201b2022-04-19 13:53:28 +02006715 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006716}
John Durkop07cc04a2020-11-16 22:08:34 -08006717#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006718
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006719#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6720static psa_status_t psa_tls12_ecjpake_to_pms_input(
6721 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006722 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006723 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006724 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006725{
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6727 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6728 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006729 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006730
6731 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 if (data[0] != 0x04) {
6733 return PSA_ERROR_INVALID_ARGUMENT;
6734 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006735
6736 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006737 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006738
Gilles Peskine449bd832023-01-11 14:50:10 +01006739 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006740}
6741#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306742
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306743#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306744static psa_status_t psa_pbkdf2_set_input_cost(
6745 psa_pbkdf2_key_derivation_t *pbkdf2,
6746 psa_key_derivation_step_t step,
6747 uint64_t data)
6748{
6749 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6750 return PSA_ERROR_INVALID_ARGUMENT;
6751 }
6752
6753 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6754 return PSA_ERROR_BAD_STATE;
6755 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306756
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306757 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306758 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306759 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306760
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306761 if (data == 0) {
6762 return PSA_ERROR_INVALID_ARGUMENT;
6763 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306764
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306765 pbkdf2->input_cost = data;
6766 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6767
6768 return PSA_SUCCESS;
6769}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306770
6771static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6772 const uint8_t *data,
6773 size_t data_length)
6774{
Gilles Peskineead17662023-08-20 22:02:51 +02006775 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6776 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6777 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6778 /* Appending to existing salt. No state change. */
6779 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306780 return PSA_ERROR_BAD_STATE;
6781 }
6782
Gilles Peskineca57d782023-07-20 19:08:06 +02006783 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006784 /* Appending an empty string, nothing to do. */
6785 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306786 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306787
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306788 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6789 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306790 return PSA_ERROR_INSUFFICIENT_MEMORY;
6791 }
6792
Gilles Peskineead17662023-08-20 22:02:51 +02006793 if (pbkdf2->salt_length != 0) {
6794 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6795 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306796 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306797 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306798 mbedtls_free(pbkdf2->salt);
6799 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306800 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306801 return PSA_SUCCESS;
6802}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306803
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306804#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306805static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306806 const uint8_t *input,
6807 size_t input_len,
6808 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306809 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306810{
6811 psa_status_t status = PSA_SUCCESS;
6812 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6813 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306814 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306815 } else {
6816 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306817 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306818 }
6819 return status;
6820}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306821#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306822
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306823#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306824static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6825 size_t input_len,
6826 uint8_t *output,
6827 size_t *output_len)
6828{
6829 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306830 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306831 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306832 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306833 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6834 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6835 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306836 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306837 * mac_size as the driver function sets mac_output_length = mac_size
6838 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306839 status = psa_driver_wrapper_mac_compute(&attributes,
6840 zeros, sizeof(zeros),
6841 PSA_ALG_CMAC, input, input_len,
6842 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306843 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6844 128U,
6845 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306846 output_len);
6847 } else {
6848 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306849 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306850 }
6851 return status;
6852}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306853#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306854
6855static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306856 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306857 const uint8_t *data,
6858 size_t data_length)
6859{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306860 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306861 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6862 return PSA_ERROR_BAD_STATE;
6863 }
6864
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306865#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306866 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6867 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6868 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6869 pbkdf2->password,
6870 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306871 } else
6872#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6873#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6874 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306875 status = psa_pbkdf2_cmac_set_password(data, data_length,
6876 pbkdf2->password,
6877 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306878 } else
6879#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6880 {
6881 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306882 }
6883
6884 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6885
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306886 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306887}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306888
6889static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306890 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306891 psa_key_derivation_step_t step,
6892 const uint8_t *data,
6893 size_t data_length)
6894{
6895 switch (step) {
6896 case PSA_KEY_DERIVATION_INPUT_SALT:
6897 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6898 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306899 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306900 default:
6901 return PSA_ERROR_INVALID_ARGUMENT;
6902 }
6903}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306904#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306905
Gilles Peskineb8965192019-09-24 16:21:10 +02006906/** Check whether the given key type is acceptable for the given
6907 * input step of a key derivation.
6908 *
6909 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6910 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6911 * Both secret and non-secret inputs can alternatively have the type
6912 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6913 * that the input was passed as a buffer rather than via a key object.
6914 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006915static int psa_key_derivation_check_input_type(
6916 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006918{
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006920 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 if (key_type == PSA_KEY_TYPE_DERIVE) {
6922 return PSA_SUCCESS;
6923 }
6924 if (key_type == PSA_KEY_TYPE_NONE) {
6925 return PSA_SUCCESS;
6926 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006927 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006928 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 if (key_type == PSA_KEY_TYPE_DERIVE) {
6930 return PSA_SUCCESS;
6931 }
6932 if (key_type == PSA_KEY_TYPE_NONE) {
6933 return PSA_SUCCESS;
6934 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006935 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006936 case PSA_KEY_DERIVATION_INPUT_LABEL:
6937 case PSA_KEY_DERIVATION_INPUT_SALT:
6938 case PSA_KEY_DERIVATION_INPUT_INFO:
6939 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006940 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6941 return PSA_SUCCESS;
6942 }
6943 if (key_type == PSA_KEY_TYPE_NONE) {
6944 return PSA_SUCCESS;
6945 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006946 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306947 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6948 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6949 return PSA_SUCCESS;
6950 }
6951 if (key_type == PSA_KEY_TYPE_DERIVE) {
6952 return PSA_SUCCESS;
6953 }
6954 if (key_type == PSA_KEY_TYPE_NONE) {
6955 return PSA_SUCCESS;
6956 }
6957 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006958 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006960}
6961
Janos Follathb80a94e2019-06-12 15:54:46 +01006962static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006963 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006964 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006965 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006966 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006967 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006968{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006969 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006971
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 status = psa_key_derivation_check_input_type(step, key_type);
6973 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006974 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006975 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006976
Przemek Stekiel69c46792022-06-10 12:59:51 +02006977#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006978 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6979 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6980 step, data, data_length);
6981 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006982#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006983#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6985 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6986 step, data, data_length);
6987 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006988#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6989#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6991 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6992 step, data, data_length);
6993 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006994#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006995#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006997 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6999 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007000#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307001#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307002 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307003 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7004 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307005 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307006#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007007 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007008 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007009 (void) data;
7010 (void) data_length;
7011 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007012 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007013 }
7014
Gilles Peskine224b0d62019-09-23 18:13:17 +02007015exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 if (status != PSA_SUCCESS) {
7017 psa_key_derivation_abort(operation);
7018 }
7019 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007020}
7021
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307022static psa_status_t psa_key_derivation_input_integer_internal(
7023 psa_key_derivation_operation_t *operation,
7024 psa_key_derivation_step_t step,
7025 uint64_t value)
7026{
7027 psa_status_t status;
7028 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7029
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307030#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307031 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307032 status = psa_pbkdf2_set_input_cost(
7033 &operation->ctx.pbkdf2, step, value);
7034 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307035#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307036 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307037 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307038 (void) value;
7039 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307040 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307041 }
7042
7043 if (status != PSA_SUCCESS) {
7044 psa_key_derivation_abort(operation);
7045 }
7046 return status;
7047}
7048
Janos Follath51f4a0f2019-06-14 11:35:55 +01007049psa_status_t psa_key_derivation_input_bytes(
7050 psa_key_derivation_operation_t *operation,
7051 psa_key_derivation_step_t step,
7052 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007053 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007054{
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 return psa_key_derivation_input_internal(operation, step,
7056 PSA_KEY_TYPE_NONE,
7057 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007058}
7059
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307060psa_status_t psa_key_derivation_input_integer(
7061 psa_key_derivation_operation_t *operation,
7062 psa_key_derivation_step_t step,
7063 uint64_t value)
7064{
7065 return psa_key_derivation_input_integer_internal(operation, step, value);
7066}
7067
Janos Follath51f4a0f2019-06-14 11:35:55 +01007068psa_status_t psa_key_derivation_input_key(
7069 psa_key_derivation_operation_t *operation,
7070 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007072{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007073 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007074 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007075 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007076
Ronald Cron5c522922020-11-14 16:35:34 +01007077 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7079 if (status != PSA_SUCCESS) {
7080 psa_key_derivation_abort(operation);
7081 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007082 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007083
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307084 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7085 * permission to output to a key object. */
7086 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7087 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007088 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007090
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 status = psa_key_derivation_input_internal(operation,
7092 step, slot->attr.type,
7093 slot->key.data,
7094 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007095
Ryan Everett5ac6fa72024-02-14 17:11:36 +00007096 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007097
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007099}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007100
7101
7102
7103/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007104/* Key agreement */
7105/****************************************************************/
7106
Gilles Peskine449bd832023-01-11 14:50:10 +01007107psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7108 const uint8_t *key_buffer,
7109 size_t key_buffer_size,
7110 psa_algorithm_t alg,
7111 const uint8_t *peer_key,
7112 size_t peer_key_length,
7113 uint8_t *shared_secret,
7114 size_t shared_secret_size,
7115 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007116{
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007118#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007119 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7121 key_buffer_size, alg,
7122 peer_key, peer_key_length,
7123 shared_secret,
7124 shared_secret_size,
7125 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007126#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007127
7128#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7129 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007130 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007131 peer_key,
7132 peer_key_length,
7133 key_buffer,
7134 key_buffer_size,
7135 shared_secret,
7136 shared_secret_size,
7137 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007138#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7139
Gilles Peskine01d718c2018-09-18 12:01:02 +02007140 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007141 (void) attributes;
7142 (void) key_buffer;
7143 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007144 (void) peer_key;
7145 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007146 (void) shared_secret;
7147 (void) shared_secret_size;
7148 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007150 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007151}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007152
Aditya Deshpande17845b82022-10-13 17:21:01 +01007153/** Internal function for raw key agreement
7154 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007155 * to the driver's implementation if a driver is present.
7156 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007157 * (psa_key_agreement_raw_builtin).
7158 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007159static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7160 psa_key_slot_t *private_key,
7161 const uint8_t *peer_key,
7162 size_t peer_key_length,
7163 uint8_t *shared_secret,
7164 size_t shared_secret_size,
7165 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007166{
Gilles Peskine449bd832023-01-11 14:50:10 +01007167 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7168 return PSA_ERROR_NOT_SUPPORTED;
7169 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007170
7171 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007173 };
7174
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 return psa_driver_wrapper_key_agreement(&attributes,
7176 private_key->key.data,
7177 private_key->key.bytes, alg,
7178 peer_key, peer_key_length,
7179 shared_secret,
7180 shared_secret_size,
7181 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007182}
7183
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007184/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007185 * to potentially free embedded data structures and wipe confidential data.
7186 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007187static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7188 psa_key_derivation_step_t step,
7189 psa_key_slot_t *private_key,
7190 const uint8_t *peer_key,
7191 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007192{
7193 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007194 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007195 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007196 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007197
7198 /* Step 1: run the secret agreement algorithm to generate the shared
7199 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007200 status = psa_key_agreement_raw_internal(ka_alg,
7201 private_key,
7202 peer_key, peer_key_length,
7203 shared_secret,
7204 sizeof(shared_secret),
7205 &shared_secret_length);
7206 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007207 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007209
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007210 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007211 * the shared secret. A shared secret is permitted wherever a key
7212 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 status = psa_key_derivation_input_internal(operation, step,
7214 PSA_KEY_TYPE_DERIVE,
7215 shared_secret,
7216 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007217exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7219 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007220}
7221
Gilles Peskine449bd832023-01-11 14:50:10 +01007222psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7223 psa_key_derivation_step_t step,
7224 mbedtls_svc_key_id_t private_key,
7225 const uint8_t *peer_key,
7226 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007227{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007228 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007229 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007230 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007231
Gilles Peskine449bd832023-01-11 14:50:10 +01007232 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7233 return PSA_ERROR_INVALID_ARGUMENT;
7234 }
Ronald Cron5c522922020-11-14 16:35:34 +01007235 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7237 if (status != PSA_SUCCESS) {
7238 return status;
7239 }
7240 status = psa_key_agreement_internal(operation, step,
7241 slot,
7242 peer_key, peer_key_length);
7243 if (status != PSA_SUCCESS) {
7244 psa_key_derivation_abort(operation);
7245 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007246 /* If a private key has been added as SECRET, we allow the derived
7247 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007249 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007250 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007251 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007252
Ryan Everett5ac6fa72024-02-14 17:11:36 +00007253 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007254
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007256}
7257
Gilles Peskine449bd832023-01-11 14:50:10 +01007258psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7259 mbedtls_svc_key_id_t private_key,
7260 const uint8_t *peer_key,
7261 size_t peer_key_length,
7262 uint8_t *output,
7263 size_t output_size,
7264 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007265{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007266 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007267 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007268 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007269 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007270
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007272 status = PSA_ERROR_INVALID_ARGUMENT;
7273 goto exit;
7274 }
Ronald Cron5c522922020-11-14 16:35:34 +01007275 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7277 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007278 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007279 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007280
Gilles Peskine3e561302022-04-14 00:17:15 +02007281 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7282 * for the output size. The PSA specification only guarantees that this
7283 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7284 * but it might be nice to allow smaller buffers if the output fits.
7285 * At the time of writing this comment, with only ECDH implemented,
7286 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7287 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7288 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007289 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7291 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007292 status = PSA_ERROR_BUFFER_TOO_SMALL;
7293 goto exit;
7294 }
7295
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 status = psa_key_agreement_raw_internal(alg, slot,
7297 peer_key, peer_key_length,
7298 output, output_size,
7299 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007300
7301exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007303 /* If an error happens and is not handled properly, the output
7304 * may be used as a key to protect sensitive data. Arrange for such
7305 * a key to be random, which is likely to result in decryption or
7306 * verification errors. This is better than filling the buffer with
7307 * some constant data such as zeros, which would result in the data
7308 * being protected with a reproducible, easily knowable key.
7309 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007310 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007311 *output_length = output_size;
7312 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007313
Ryan Everetta103ec92024-01-31 13:59:57 +00007314 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007315
Gilles Peskine449bd832023-01-11 14:50:10 +01007316 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007317}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007318
7319
Gilles Peskine30524eb2020-11-13 17:02:26 +01007320
Gilles Peskine86a440b2018-11-12 18:39:40 +01007321/****************************************************************/
7322/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007323/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007324
Gilles Peskine672a7712023-04-28 21:00:28 +02007325#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7326#include "entropy_poll.h"
7327#endif
7328
Gilles Peskine30524eb2020-11-13 17:02:26 +01007329/** Initialize the PSA random generator.
7330 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007331static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007332{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007333#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007335#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7336
Gilles Peskine30524eb2020-11-13 17:02:26 +01007337 /* Set default configuration if
7338 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007339 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007340 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007341 }
7342 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007343 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007345
Gilles Peskine449bd832023-01-11 14:50:10 +01007346 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007347#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7348 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7349 /* The PSA entropy injection feature depends on using NV seed as an entropy
7350 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007351 mbedtls_entropy_add_source(&rng->entropy,
7352 mbedtls_nv_seed_poll, NULL,
7353 MBEDTLS_ENTROPY_BLOCK_SIZE,
7354 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007355#endif
7356
Gilles Peskine449bd832023-01-11 14:50:10 +01007357 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007358#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007359}
7360
7361/** Deinitialize the PSA random generator.
7362 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007363static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007364{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007365#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007366 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007367#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007368 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7369 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007370#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007371}
7372
7373/** Seed the PSA random generator.
7374 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007375static psa_status_t mbedtls_psa_random_seed(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)
7378 /* Do nothing: the external RNG seeds itself. */
7379 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007380 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007381#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007382 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007383 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7384 drbg_seed, sizeof(drbg_seed) - 1);
7385 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007386#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007387}
7388
Gilles Peskine449bd832023-01-11 14:50:10 +01007389psa_status_t psa_generate_random(uint8_t *output,
7390 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007391{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007392 GUARD_MODULE_INITIALIZED;
7393
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007394#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7395
7396 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7398 output, output_size,
7399 &output_length);
7400 if (status != PSA_SUCCESS) {
7401 return status;
7402 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007403 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007404 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 if (output_length != output_size) {
7406 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7407 }
7408 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007409
7410#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7411
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007413 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7415 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7416 output_size);
7417 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7418 output, request_size);
7419 if (ret != 0) {
7420 return mbedtls_to_psa_error(ret);
7421 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007422 output_size -= request_size;
7423 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007424 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007426#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007427}
7428
Gilles Peskine8814fc42020-12-14 15:33:44 +01007429/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007430 *
7431 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7432 * `psa_generate_random(...)`. The state parameter is ignored since the
7433 * PSA API doesn't support passing an explicit state.
7434 *
7435 * In the non-external case, psa_generate_random() calls an
7436 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7437 * and semantics as mbedtls_psa_get_random(). As an optimization,
7438 * instead of doing this back-and-forth between the PSA API and the
7439 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7440 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007441 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007442#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7443int mbedtls_psa_get_random(void *p_rng,
7444 unsigned char *output,
7445 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007446{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007447 /* This function takes a pointer to the RNG state because that's what
7448 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7449 * its own state internally and doesn't let the caller access that state.
7450 * So we just ignore the state parameter, and in practice we'll pass
7451 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007452 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 psa_status_t status = psa_generate_random(output, output_size);
7454 if (status == PSA_SUCCESS) {
7455 return 0;
7456 } else {
7457 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7458 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007459}
7460#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7461
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007462#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007463psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7464 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007465{
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 if (global_data.initialized) {
7467 return PSA_ERROR_NOT_PERMITTED;
7468 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007469
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7471 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7472 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7473 return PSA_ERROR_INVALID_ARGUMENT;
7474 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007475
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007477}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007478#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007479
Ronald Cron3772afe2021-02-08 16:10:05 +01007480/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007481 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007482 * \param type The key type
7483 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007484 *
7485 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007486 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007487 * \retval #PSA_ERROR_INVALID_ARGUMENT
7488 * The size in bits of the key is not valid.
7489 * \retval #PSA_ERROR_NOT_SUPPORTED
7490 * The type and/or the size in bits of the key or the combination of
7491 * the two is not supported.
7492 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007493static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007495{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007496 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007497
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 if (key_type_is_raw_bytes(type)) {
7499 status = psa_validate_unstructured_key_bit_size(type, bits);
7500 if (status != PSA_SUCCESS) {
7501 return status;
7502 }
7503 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007504#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7506 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7507 return PSA_ERROR_NOT_SUPPORTED;
7508 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007509 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007510 return PSA_ERROR_NOT_SUPPORTED;
7511 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007512
Ronald Cron01b2aba2020-10-05 09:42:02 +02007513 /* Accept only byte-aligned keys, for the same reasons as
7514 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 if (bits % 8 != 0) {
7516 return PSA_ERROR_NOT_SUPPORTED;
7517 }
7518 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007519#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007520
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007521#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007523 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007524 return PSA_SUCCESS;
7525 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007526#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007527
Valerio Settia55f0422023-07-10 15:34:41 +02007528#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007529 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007530 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007531 return PSA_ERROR_NOT_SUPPORTED;
7532 }
7533 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007534#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007535 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007537 }
7538
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007540}
7541
Ronald Cron55ed0592020-10-05 10:30:40 +02007542psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007543 const psa_key_attributes_t *attributes,
Gilles Peskine092ce512024-02-20 12:31:24 +01007544 const psa_key_production_parameters_t *params, size_t params_data_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007546{
7547 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007548 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007549
Gilles Peskine7a18f962024-02-12 16:48:11 +01007550 /* Only used for RSA */
Gilles Peskine092ce512024-02-20 12:31:24 +01007551 (void) params;
7552 (void) params_data_length;
Gilles Peskine7a18f962024-02-12 16:48:11 +01007553
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 if ((attributes->domain_parameters == NULL) &&
7555 (attributes->domain_parameters_size != 0)) {
7556 return PSA_ERROR_INVALID_ARGUMENT;
7557 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007558
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 if (key_type_is_raw_bytes(type)) {
7560 status = psa_generate_random(key_buffer, key_buffer_size);
7561 if (status != PSA_SUCCESS) {
7562 return status;
7563 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007564
David Brown12ca5032021-02-11 11:02:00 -07007565#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 if (type == PSA_KEY_TYPE_DES) {
7567 psa_des_set_key_parity(key_buffer, key_buffer_size);
7568 }
David Brown8107e312021-02-12 08:08:46 -07007569#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007570 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007571
Valerio Setti76df8c12023-07-11 14:11:28 +02007572#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskine7a18f962024-02-12 16:48:11 +01007574 /* Hack: if the method specifies a non-default e, pass it
7575 * via the domain parameters. TODO: refactor this code so
7576 * that mbedtls_psa_rsa_generate_key() gets e via a new
7577 * parameter instead. */
7578 psa_key_attributes_t override_attributes = *attributes;
Gilles Peskine7a18f962024-02-12 16:48:11 +01007579 return mbedtls_psa_rsa_generate_key(&override_attributes,
Gilles Peskine4c32b692024-02-16 00:11:09 +01007580 params, params_data_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 key_buffer,
7582 key_buffer_size,
7583 key_buffer_length);
7584 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007585#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007586
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007587#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7589 return mbedtls_psa_ecp_generate_key(attributes,
7590 key_buffer,
7591 key_buffer_size,
7592 key_buffer_length);
7593 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007594#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007595
Valerio Settia55f0422023-07-10 15:34:41 +02007596#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007597 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7598 return mbedtls_psa_ffdh_generate_key(attributes,
7599 key_buffer,
7600 key_buffer_size,
7601 key_buffer_length);
7602 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007603#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007604 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 (void) key_buffer_length;
7606 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007607 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007608
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007610}
Darryl Green0c6575a2018-11-07 16:05:30 +00007611
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007612psa_status_t psa_generate_key_ext(const psa_key_attributes_t *attributes,
Gilles Peskine092ce512024-02-20 12:31:24 +01007613 const psa_key_production_parameters_t *params,
7614 size_t params_data_length,
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007615 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007616{
7617 psa_status_t status;
7618 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007619 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007620 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007621
Ronald Cron81709fc2020-11-14 12:10:32 +01007622 *key = MBEDTLS_SVC_KEY_ID_INIT;
7623
Gilles Peskine0f84d622019-09-12 19:03:13 +02007624 /* Reject any attempt to create a zero-length key so that we don't
7625 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 if (psa_get_key_bits(attributes) == 0) {
7627 return PSA_ERROR_INVALID_ARGUMENT;
7628 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007629
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007630 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7632 return PSA_ERROR_INVALID_ARGUMENT;
7633 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007634
Gilles Peskine7a18f962024-02-12 16:48:11 +01007635#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
7636 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskine092ce512024-02-20 12:31:24 +01007637 if (params->flags != 0) {
Gilles Peskine7a18f962024-02-12 16:48:11 +01007638 return PSA_ERROR_INVALID_ARGUMENT;
7639 }
7640 } else
7641#endif
Gilles Peskine092ce512024-02-20 12:31:24 +01007642 if (!psa_key_production_parameters_are_default(params, params_data_length)) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007643 return PSA_ERROR_INVALID_ARGUMENT;
7644 }
7645
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7647 &slot, &driver);
7648 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007649 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 }
Gilles Peskine11792082019-08-06 18:36:36 +02007651
Ronald Cron977c2472020-10-13 08:32:21 +02007652 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307653 * storage ( thus not in the case of generating a key in a secure element
7654 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7655 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 if (slot->key.data == NULL) {
7657 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7658 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007659 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 attributes->core.type, attributes->core.bits);
7661 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007662 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007663 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007664
7665 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 attributes->core.type,
7667 attributes->core.bits);
7668 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007669 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007670 attributes, &key_buffer_size);
7671 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007672 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007673 }
Ronald Cron977c2472020-10-13 08:32:21 +02007674 }
Ronald Cron977c2472020-10-13 08:32:21 +02007675
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7677 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007678 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 }
Ronald Cron977c2472020-10-13 08:32:21 +02007680 }
7681
Gilles Peskine449bd832023-01-11 14:50:10 +01007682 status = psa_driver_wrapper_generate_key(attributes,
Gilles Peskine092ce512024-02-20 12:31:24 +01007683 params, params_data_length,
Gilles Peskine7a18f962024-02-12 16:48:11 +01007684 slot->key.data, slot->key.bytes,
7685 &slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 if (status != PSA_SUCCESS) {
7687 psa_remove_key_data_from_memory(slot);
7688 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007689
Gilles Peskine11792082019-08-06 18:36:36 +02007690exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 if (status == PSA_SUCCESS) {
7692 status = psa_finish_key_creation(slot, driver, key);
7693 }
7694 if (status != PSA_SUCCESS) {
7695 psa_fail_key_creation(slot, driver);
7696 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007697
Gilles Peskine449bd832023-01-11 14:50:10 +01007698 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007699}
7700
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007701psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7702 mbedtls_svc_key_id_t *key)
7703{
7704 return psa_generate_key_ext(attributes,
Gilles Peskine092ce512024-02-20 12:31:24 +01007705 &default_production_parameters, 0,
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007706 key);
7707}
7708
Gilles Peskinee59236f2018-01-27 23:32:46 +01007709/****************************************************************/
7710/* Module setup */
7711/****************************************************************/
7712
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007713#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007714psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007715 void (* entropy_init)(mbedtls_entropy_context *ctx),
7716 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007717{
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7719 return PSA_ERROR_BAD_STATE;
7720 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007721 global_data.rng.entropy_init = entropy_init;
7722 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007724}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007725#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007726
Gilles Peskine449bd832023-01-11 14:50:10 +01007727void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007728{
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007730 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7731 mbedtls_psa_random_free(&global_data.rng);
7732 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007733 /* Wipe all remaining data, including configuration.
7734 * In particular, this sets all state indicator to the value
7735 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007737
7738 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007739 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007740}
7741
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007742#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7743/** Recover a transaction that was interrupted by a power failure.
7744 *
7745 * This function is called during initialization, before psa_crypto_init()
7746 * returns. If this function returns a failure status, the initialization
7747 * fails.
7748 */
7749static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007751{
Gilles Peskine449bd832023-01-11 14:50:10 +01007752 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007753 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7754 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007755 /* TODO - fall through to the failure case until this
7756 * is implemented.
7757 * https://github.com/ARMmbed/mbed-crypto/issues/218
7758 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007759 default:
7760 /* We found an unsupported transaction in the storage.
7761 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007763 }
7764}
7765#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7766
Gilles Peskine449bd832023-01-11 14:50:10 +01007767psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007768{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007769 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007770
Gilles Peskinec6b69072018-11-20 21:42:52 +01007771 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007772 if (global_data.initialized != 0) {
7773 return PSA_SUCCESS;
7774 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007775
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007776 /* Init drivers */
7777 status = psa_driver_wrapper_init();
7778 if (status != PSA_SUCCESS) {
7779 goto exit;
7780 }
7781 global_data.drivers_initialized = 1;
7782
Valerio Setti402cfba2023-11-13 10:24:32 +01007783 status = psa_initialize_key_slots();
7784 if (status != PSA_SUCCESS) {
7785 goto exit;
7786 }
7787
Gilles Peskine30524eb2020-11-13 17:02:26 +01007788 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007790 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007791 status = mbedtls_psa_random_seed(&global_data.rng);
7792 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007793 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007795 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007796
Gilles Peskine4b734222019-07-24 15:56:31 +02007797#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 status = psa_crypto_load_transaction();
7799 if (status == PSA_SUCCESS) {
7800 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7801 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007802 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 }
7804 status = psa_crypto_stop_transaction();
7805 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007806 /* There's no transaction to complete. It's all good. */
7807 status = PSA_SUCCESS;
7808 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007809#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007810
Gilles Peskinec6b69072018-11-20 21:42:52 +01007811 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007812 global_data.initialized = 1;
7813
7814exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 if (status != PSA_SUCCESS) {
7816 mbedtls_psa_crypto_free();
7817 }
7818 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007819}
7820
Yanray Wangffc3c482023-07-11 12:01:04 +08007821#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007822psa_status_t psa_crypto_driver_pake_get_password_len(
7823 const psa_crypto_driver_pake_inputs_t *inputs,
7824 size_t *password_len)
7825{
7826 if (inputs->password_len == 0) {
7827 return PSA_ERROR_BAD_STATE;
7828 }
7829
7830 *password_len = inputs->password_len;
7831
7832 return PSA_SUCCESS;
7833}
7834
7835psa_status_t psa_crypto_driver_pake_get_password(
7836 const psa_crypto_driver_pake_inputs_t *inputs,
7837 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7838{
7839 if (inputs->password_len == 0) {
7840 return PSA_ERROR_BAD_STATE;
7841 }
7842
7843 if (buffer_size < inputs->password_len) {
7844 return PSA_ERROR_BUFFER_TOO_SMALL;
7845 }
7846
7847 memcpy(buffer, inputs->password, inputs->password_len);
7848 *buffer_length = inputs->password_len;
7849
7850 return PSA_SUCCESS;
7851}
7852
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007853psa_status_t psa_crypto_driver_pake_get_user_len(
7854 const psa_crypto_driver_pake_inputs_t *inputs,
7855 size_t *user_len)
7856{
7857 if (inputs->user_len == 0) {
7858 return PSA_ERROR_BAD_STATE;
7859 }
7860
7861 *user_len = inputs->user_len;
7862
7863 return PSA_SUCCESS;
7864}
7865
7866psa_status_t psa_crypto_driver_pake_get_user(
7867 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007868 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007869{
7870 if (inputs->user_len == 0) {
7871 return PSA_ERROR_BAD_STATE;
7872 }
7873
Przemek Stekielc0e62502023-03-14 11:49:36 +01007874 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007875 return PSA_ERROR_BUFFER_TOO_SMALL;
7876 }
7877
Przemek Stekielc0e62502023-03-14 11:49:36 +01007878 memcpy(user_id, inputs->user, inputs->user_len);
7879 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007880
7881 return PSA_SUCCESS;
7882}
7883
7884psa_status_t psa_crypto_driver_pake_get_peer_len(
7885 const psa_crypto_driver_pake_inputs_t *inputs,
7886 size_t *peer_len)
7887{
7888 if (inputs->peer_len == 0) {
7889 return PSA_ERROR_BAD_STATE;
7890 }
7891
7892 *peer_len = inputs->peer_len;
7893
7894 return PSA_SUCCESS;
7895}
7896
7897psa_status_t psa_crypto_driver_pake_get_peer(
7898 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007899 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007900{
7901 if (inputs->peer_len == 0) {
7902 return PSA_ERROR_BAD_STATE;
7903 }
7904
Przemek Stekielc0e62502023-03-14 11:49:36 +01007905 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007906 return PSA_ERROR_BUFFER_TOO_SMALL;
7907 }
7908
Przemek Stekielc0e62502023-03-14 11:49:36 +01007909 memcpy(peer_id, inputs->peer, inputs->peer_len);
7910 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007911
7912 return PSA_SUCCESS;
7913}
7914
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007915psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7916 const psa_crypto_driver_pake_inputs_t *inputs,
7917 psa_pake_cipher_suite_t *cipher_suite)
7918{
7919 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7920 return PSA_ERROR_BAD_STATE;
7921 }
7922
7923 *cipher_suite = inputs->cipher_suite;
7924
7925 return PSA_SUCCESS;
7926}
7927
Neil Armstronga7d08c32022-06-01 18:21:20 +02007928psa_status_t psa_pake_setup(
7929 psa_pake_operation_t *operation,
7930 const psa_pake_cipher_suite_t *cipher_suite)
7931{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007932 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007933
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007934 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007935 status = PSA_ERROR_BAD_STATE;
7936 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007937 }
7938
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007939 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007940 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007941 status = PSA_ERROR_INVALID_ARGUMENT;
7942 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007943 }
7944
Przemek Stekiel51eac532022-12-07 11:04:51 +01007945 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7946
Przemek Stekiele12ed362022-12-21 12:54:46 +01007947 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007948 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7949 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007950 operation->data.inputs.cipher_suite = *cipher_suite;
7951
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007952#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007953 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007954 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007955 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007956
David Horstmann16f01512023-06-14 17:21:07 +01007957 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007958 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007959 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007960#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007961 {
7962 status = PSA_ERROR_NOT_SUPPORTED;
7963 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007964 }
7965
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007966 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7967
Przemek Stekiel51eac532022-12-07 11:04:51 +01007968 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007969exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007970 psa_pake_abort(operation);
7971 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007972}
7973
7974psa_status_t psa_pake_set_password_key(
7975 psa_pake_operation_t *operation,
7976 mbedtls_svc_key_id_t password)
7977{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007978 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007979 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7980 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007981 psa_key_attributes_t attributes;
7982 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007983
Przemek Stekiel51eac532022-12-07 11:04:51 +01007984 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007985 status = PSA_ERROR_BAD_STATE;
7986 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007987 }
7988
Przemek Stekiel6c764412022-11-22 14:05:12 +01007989 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7990 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007991 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007992 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007993 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007994 }
7995
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007996 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007997 .core = slot->attr
7998 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007999
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008000 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008001
Przemek Stekiel51eac532022-12-07 11:04:51 +01008002 if (type != PSA_KEY_TYPE_PASSWORD &&
8003 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8004 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008005 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008006 }
8007
Przemek Stekiel51eac532022-12-07 11:04:51 +01008008 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8009 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008010 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008011 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008012 }
8013
8014 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8015 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008016 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008017exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008018 if (status != PSA_SUCCESS) {
8019 psa_pake_abort(operation);
8020 }
Ryan Everettbbedfce2024-02-14 18:22:09 +00008021 unlock_status = psa_unregister_read_under_mutex(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008022 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008023}
8024
8025psa_status_t psa_pake_set_user(
8026 psa_pake_operation_t *operation,
8027 const uint8_t *user_id,
8028 size_t user_id_len)
8029{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008030 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008031
8032 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008033 status = PSA_ERROR_BAD_STATE;
8034 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008035 }
8036
Przemek Stekiel51eac532022-12-07 11:04:51 +01008037 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008038 status = PSA_ERROR_INVALID_ARGUMENT;
8039 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008040 }
8041
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008042 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008043 status = PSA_ERROR_BAD_STATE;
8044 goto exit;
8045 }
8046
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008047 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8048 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008049 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8050 goto exit;
8051 }
8052
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008053 memcpy(operation->data.inputs.user, user_id, user_id_len);
8054 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008055
8056 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008057exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008058 psa_pake_abort(operation);
8059 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008060}
8061
8062psa_status_t psa_pake_set_peer(
8063 psa_pake_operation_t *operation,
8064 const uint8_t *peer_id,
8065 size_t peer_id_len)
8066{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008067 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008068
8069 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008070 status = PSA_ERROR_BAD_STATE;
8071 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008072 }
8073
Przemek Stekiel51eac532022-12-07 11:04:51 +01008074 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008075 status = PSA_ERROR_INVALID_ARGUMENT;
8076 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008077 }
8078
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008079 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008080 status = PSA_ERROR_BAD_STATE;
8081 goto exit;
8082 }
8083
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008084 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8085 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008086 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8087 goto exit;
8088 }
8089
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008090 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8091 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008092
8093 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008094exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008095 psa_pake_abort(operation);
8096 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008097}
8098
8099psa_status_t psa_pake_set_role(
8100 psa_pake_operation_t *operation,
8101 psa_pake_role_t role)
8102{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008103 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008104
Przemek Stekiel51eac532022-12-07 11:04:51 +01008105 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008106 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008107 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008108 }
8109
Przemek Stekiel09104b82023-03-06 14:11:51 +01008110 switch (operation->alg) {
8111#if defined(PSA_WANT_ALG_JPAKE)
8112 case PSA_ALG_JPAKE:
8113 if (role == PSA_PAKE_ROLE_NONE) {
8114 return PSA_SUCCESS;
8115 }
8116 status = PSA_ERROR_INVALID_ARGUMENT;
8117 break;
8118#endif
8119 default:
8120 (void) role;
8121 status = PSA_ERROR_NOT_SUPPORTED;
8122 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008123 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008124exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008125 psa_pake_abort(operation);
8126 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008127}
8128
David Horstmanne7f21e62023-05-12 18:17:21 +01008129/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008130#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008131static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008132 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008133{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008134 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008135 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008136 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008137
David Horstmann024e5c52023-06-14 15:48:21 +01008138 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008139 is_x1 = (stage->outputs < 1);
8140 } else {
8141 is_x1 = (stage->inputs < 1);
8142 }
8143
David Horstmann74a3d8c2023-06-14 18:28:19 +01008144 key_share_step = is_x1 ?
8145 PSA_JPAKE_X1_STEP_KEY_SHARE :
8146 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008147 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008148 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8149 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8150 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8151 } else {
8152 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008153 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008154 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008155}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008156#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008157
Przemek Stekiel2797d372022-12-22 11:19:22 +01008158static psa_status_t psa_pake_complete_inputs(
8159 psa_pake_operation_t *operation)
8160{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008161 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008162 /* Create copy of the inputs on stack as inputs share memory
8163 with the driver context which will be setup by the driver. */
8164 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008165
Przemek Stekielfde11282023-03-13 16:06:09 +01008166 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008167 return PSA_ERROR_BAD_STATE;
8168 }
8169
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008170 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008171 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8172 return PSA_ERROR_BAD_STATE;
8173 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008174 }
8175
Przemek Stekiel18620a32023-01-17 16:34:52 +01008176 /* Clear driver context */
8177 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8178
8179 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008180
8181 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008182 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008183
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008184 /* User and peer are translated to role. */
8185 mbedtls_free(inputs.user);
8186 mbedtls_free(inputs.peer);
8187
Przemek Stekiel2797d372022-12-22 11:19:22 +01008188 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008189#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008190 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008191 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008192 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008193#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008194 {
8195 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008196 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008197 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008198 return status;
8199}
8200
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008201#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008202static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008203 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008204 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008205 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008206{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008207 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8208 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8209 step != PSA_PAKE_STEP_ZK_PROOF) {
8210 return PSA_ERROR_INVALID_ARGUMENT;
8211 }
8212
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008213 psa_jpake_computation_stage_t *computation_stage =
8214 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008215
David Horstmann5da95602023-06-08 15:37:12 +01008216 if (computation_stage->round != PSA_JPAKE_FIRST &&
8217 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008218 return PSA_ERROR_BAD_STATE;
8219 }
8220
David Horstmanne7f21e62023-05-12 18:17:21 +01008221 /* Check that the step we are given is the one we were expecting */
8222 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008223 return PSA_ERROR_BAD_STATE;
8224 }
8225
David Horstmanne7f21e62023-05-12 18:17:21 +01008226 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8227 computation_stage->inputs == 0 &&
8228 computation_stage->outputs == 0) {
8229 /* Start of the round, so function decides whether we are inputting
8230 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008231 computation_stage->io_mode = io_mode;
8232 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008233 /* Middle of the round so the mode we are in must match the function
8234 * called by the user */
8235 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008236 }
8237
8238 return PSA_SUCCESS;
8239}
8240
David Horstmanne7f21e62023-05-12 18:17:21 +01008241static psa_status_t psa_jpake_epilogue(
8242 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008243 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008244{
David Horstmanne7f21e62023-05-12 18:17:21 +01008245 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008246 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008247
David Horstmanne7f21e62023-05-12 18:17:21 +01008248 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8249 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008250 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008251 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008252 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008253 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008254 }
8255 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008256 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008257 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008258 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008259 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008260 }
8261 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008262 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8263 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008264 /* End of a round, move to the next round */
8265 stage->inputs = 0;
8266 stage->outputs = 0;
8267 stage->round++;
8268 }
8269 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008270 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008271 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008272 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008273 return PSA_SUCCESS;
8274}
David Horstmanne7f21e62023-05-12 18:17:21 +01008275
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008276#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008277
Neil Armstronga7d08c32022-06-01 18:21:20 +02008278psa_status_t psa_pake_output(
8279 psa_pake_operation_t *operation,
8280 psa_pake_step_t step,
8281 uint8_t *output,
8282 size_t output_size,
8283 size_t *output_length)
8284{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008285 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008286 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008287 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008288
8289 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008290 status = psa_pake_complete_inputs(operation);
8291 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008292 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008293 }
8294 }
8295
8296 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008297 status = PSA_ERROR_BAD_STATE;
8298 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008299 }
8300
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008301 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008302 status = PSA_ERROR_INVALID_ARGUMENT;
8303 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008304 }
8305
Przemek Stekiele12ed362022-12-21 12:54:46 +01008306 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008307#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008308 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008309 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008310 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008311 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008312 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008313 driver_step = convert_jpake_computation_stage_to_driver_step(
8314 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008315 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008316#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008317 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008318 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008319 status = PSA_ERROR_NOT_SUPPORTED;
8320 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008321 }
8322
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008323 status = psa_driver_wrapper_pake_output(operation, driver_step,
8324 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008325
8326 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008327 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008328 }
8329
8330 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008331#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008332 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008333 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008334 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008335 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008336 }
8337 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008338#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008339 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008340 status = PSA_ERROR_NOT_SUPPORTED;
8341 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008342 }
8343
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008344 return PSA_SUCCESS;
8345exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008346 psa_pake_abort(operation);
8347 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008348}
8349
8350psa_status_t psa_pake_input(
8351 psa_pake_operation_t *operation,
8352 psa_pake_step_t step,
8353 const uint8_t *input,
8354 size_t input_length)
8355{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008356 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008357 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008358 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8359 operation->primitive,
8360 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008361
8362 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008363 status = psa_pake_complete_inputs(operation);
8364 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008365 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008366 }
8367 }
8368
8369 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008370 status = PSA_ERROR_BAD_STATE;
8371 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008372 }
8373
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008374 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008375 status = PSA_ERROR_INVALID_ARGUMENT;
8376 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008377 }
8378
Przemek Stekiele12ed362022-12-21 12:54:46 +01008379 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008380#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008381 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008382 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008383 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008384 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008385 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008386 driver_step = convert_jpake_computation_stage_to_driver_step(
8387 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008388 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008389#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008390 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008391 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008392 status = PSA_ERROR_NOT_SUPPORTED;
8393 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008394 }
8395
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008396 status = psa_driver_wrapper_pake_input(operation, driver_step,
8397 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008398
8399 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008400 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008401 }
8402
8403 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008404#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008405 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008406 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008407 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008408 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008409 }
8410 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008411#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008412 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008413 status = PSA_ERROR_NOT_SUPPORTED;
8414 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008415 }
8416
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008417 return PSA_SUCCESS;
8418exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008419 psa_pake_abort(operation);
8420 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008421}
8422
8423psa_status_t psa_pake_get_implicit_key(
8424 psa_pake_operation_t *operation,
8425 psa_key_derivation_operation_t *output)
8426{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008427 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008428 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008429 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008430 size_t shared_key_len = 0;
8431
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008432 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008433 status = PSA_ERROR_BAD_STATE;
8434 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008435 }
8436
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008437#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008438 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008439 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008440 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008441 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008442 status = PSA_ERROR_BAD_STATE;
8443 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008444 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008445 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008446#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008447 {
8448 status = PSA_ERROR_NOT_SUPPORTED;
8449 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008450 }
8451
Przemek Stekiel0c781802022-11-29 14:53:13 +01008452 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8453 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008454 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008455 &shared_key_len);
8456
8457 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008458 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008459 }
8460
8461 status = psa_key_derivation_input_bytes(output,
8462 PSA_KEY_DERIVATION_INPUT_SECRET,
8463 shared_key,
8464 shared_key_len);
8465
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008466 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008467exit:
8468 abort_status = psa_pake_abort(operation);
8469 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008470}
8471
8472psa_status_t psa_pake_abort(
8473 psa_pake_operation_t *operation)
8474{
Przemek Stekield69dca92023-01-31 19:59:20 +01008475 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008476
Przemek Stekield69dca92023-01-31 19:59:20 +01008477 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008478 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008479 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008480
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008481 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8482 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008483 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008484 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008485 }
8486 if (operation->data.inputs.user != NULL) {
8487 mbedtls_free(operation->data.inputs.user);
8488 }
8489 if (operation->data.inputs.peer != NULL) {
8490 mbedtls_free(operation->data.inputs.peer);
8491 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008492 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008493 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008494
Przemek Stekield69dca92023-01-31 19:59:20 +01008495 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008496}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008497#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008498
Gilles Peskinee59236f2018-01-27 23:32:46 +01008499#endif /* MBEDTLS_PSA_CRYPTO_C */