blob: 43b597c3897d86dad0a4eebbb892271f9cbded1f [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.
912 * It is the responsibility of the caller to call psa_unregister_read(slot)
913 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +0100914 */
915static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +0100916 mbedtls_svc_key_id_t key,
917 psa_key_slot_t **p_slot,
918 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +0100920{
Ronald Cronf95a2b12020-10-22 15:24:49 +0200921 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +0100922 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +0100923
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 status = psa_get_and_lock_key_slot(key, p_slot);
925 if (status != PSA_SUCCESS) {
926 return status;
927 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200928 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +0100929
930 /* Enforce that usage policy for the key slot contains all the flags
931 * required by the usage parameter. There is one exception: public
932 * keys can always be exported, so we treat public key objects as
933 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100934 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +0100935 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200937
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +0100939 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200940 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +0100941 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100942
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800943 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 if (alg != 0) {
945 status = psa_key_policy_permits(&slot->attr.policy,
946 slot->attr.type,
947 alg);
948 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +0100949 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +0100950 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100951 }
Darryl Green06fd18d2018-07-16 11:21:11 +0100952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +0200954
955error:
956 *p_slot = NULL;
Ryan Everettfb792ca2024-01-31 13:40:05 +0000957 psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +0200958
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +0100960}
Darryl Green940d72c2018-07-13 13:18:51 +0100961
Ronald Cron5c522922020-11-14 16:35:34 +0100962/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200963 *
964 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +0200965 * available, as opposed to a key in a secure element and/or to be used
966 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200967 *
Ronald Cronddae0f52021-08-24 15:39:44 +0200968 * This is a temporary function that may be used instead of
969 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
970 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +0200971 *
Ryan Everett098c6652024-01-03 13:03:36 +0000972 * On success, the returned key slot has been registered for reading.
973 * It is the responsibility of the caller to call psa_unregister_read(slot)
974 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +0200975 */
Ronald Cron5c522922020-11-14 16:35:34 +0100976static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
977 mbedtls_svc_key_id_t key,
978 psa_key_slot_t **p_slot,
979 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +0200981{
Gilles Peskine449bd832023-01-11 14:50:10 +0100982 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
983 usage, alg);
984 if (status != PSA_SUCCESS) {
985 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200986 }
Ronald Cronf95a2b12020-10-22 15:24:49 +0200987
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everettfb792ca2024-01-31 13:40:05 +0000989 psa_unregister_read_under_mutex(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 *p_slot = NULL;
991 return PSA_ERROR_NOT_SUPPORTED;
992 }
993
994 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +0200995}
Gilles Peskine28f8f302019-07-24 13:30:31 +0200996
Gilles Peskine449bd832023-01-11 14:50:10 +0100997psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +0000998{
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001000 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001002
Ronald Cronea0f8a62020-11-25 17:52:23 +01001003 slot->key.data = NULL;
1004 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001005
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001007}
1008
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001009/** Completely wipe a slot in memory, including its policy.
1010 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001011psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001012{
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001014
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 /*
1016 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001017 * do our best to report an unexpected amount of registered readers or
1018 * an unexpected state.
1019 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1020 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1022 * function is called as part of the execution of a test suite, the
1023 * execution of the test suite is stopped in error if the assertion fails.
1024 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001025 switch (slot->state) {
1026 case PSA_SLOT_FULL:
1027 /* In this state psa_wipe_key_slot() must only be called if the
1028 * caller is the last reader. */
1029 case PSA_SLOT_PENDING_DELETION:
1030 /* In this state psa_wipe_key_slot() must only be called if the
1031 * caller is the last reader. */
1032 if (slot->registered_readers != 1) {
1033 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1034 status = PSA_ERROR_CORRUPTION_DETECTED;
1035 }
1036 break;
1037 case PSA_SLOT_FILLING:
1038 /* In this state registered_readers must be 0. */
1039 if (slot->registered_readers != 0) {
1040 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1041 status = PSA_ERROR_CORRUPTION_DETECTED;
1042 }
1043 break;
1044 case PSA_SLOT_EMPTY:
1045 /* The slot is already empty, it cannot be wiped. */
1046 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1047 status = PSA_ERROR_CORRUPTION_DETECTED;
1048 break;
1049 default:
1050 /* The slot's state is invalid. */
1051 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001052 }
1053
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001054 /* Multipart operations may still be using the key. This is safe
1055 * because all multipart operation objects are independent from
1056 * the key slot: if they need to access the key after the setup
1057 * phase, they have a copy of the key. Note that this means that
1058 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001059 /* At this point, key material and other type-specific content has
1060 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001061 * zeroize because the metadata is not particularly sensitive.
1062 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 memset(slot, 0, sizeof(*slot));
1064 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001065}
1066
Gilles Peskine449bd832023-01-11 14:50:10 +01001067psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001068{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001069 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001070 psa_status_t status; /* status of the last operation */
1071 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001072#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1073 psa_se_drv_table_entry_t *driver;
1074#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001075
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (mbedtls_svc_key_id_is_null(key)) {
1077 return PSA_SUCCESS;
1078 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001079
Ronald Cronf2911112020-10-29 17:51:10 +01001080 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001081 * Get the description of the key in a key slot, and register to read it.
1082 * In the case of a persistent key, this will load the key description
1083 * from persistent memory if not done yet.
1084 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001085 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001086 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 status = psa_get_and_lock_key_slot(key, &slot);
1088 if (status != PSA_SUCCESS) {
1089 return status;
1090 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001091
Ryan Everett7ed542e2024-01-17 11:39:09 +00001092 /* Set the key slot containing the key description's state to
1093 * PENDING_DELETION. This stops new operations from registering
1094 * to read the slot. Current readers can safely continue to access
1095 * the key within the slot; the last registered reader will
1096 * automatically wipe the slot when they call psa_unregister_read().
1097 * If the key is persistent, we can now delete the copy of the key
1098 * from memory. If the key is opaque, we require the driver to
1099 * deal with the deletion. */
Ryan Everettc70ce572024-01-03 16:04:33 +00001100 slot->state = PSA_SLOT_PENDING_DELETION;
Ronald Cronf2911112020-10-29 17:51:10 +01001101
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001103 /* Refuse the destruction of a read-only key (which may or may not work
1104 * if we attempt it, depending on whether the key is merely read-only
1105 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001106 * Just do the best we can, which is to wipe the copy in memory
1107 * (done in this function's cleanup code). */
1108 overall_status = PSA_ERROR_NOT_PERMITTED;
1109 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001110 }
1111
Gilles Peskine354f7672019-07-12 23:46:38 +02001112#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001113 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1114 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001115 /* For a key in a secure element, we need to do three things:
1116 * remove the key file in internal storage, destroy the
1117 * key inside the secure element, and update the driver's
1118 * persistent data. Start a transaction that will encompass these
1119 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001121 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001123 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 status = psa_crypto_save_transaction();
1125 if (status != PSA_SUCCESS) {
1126 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001127 /* We should still try to destroy the key in the secure
1128 * element and the key metadata in storage. This is especially
1129 * important if the error is that the storage is full.
1130 * But how to do it exactly without risking an inconsistent
1131 * state after a reset?
1132 * https://github.com/ARMmbed/mbed-crypto/issues/215
1133 */
1134 overall_status = status;
1135 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001136 }
1137
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 status = psa_destroy_se_key(driver,
1139 psa_key_slot_get_slot_number(slot));
1140 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001141 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001143 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001144#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1145
Darryl Greend49a4992018-06-18 17:27:26 +01001146#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001148 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001149 * The slot will still hold a copy of the key until the last reader
1150 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 status = psa_destroy_persistent_key(slot->attr.id);
1152 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001153 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001155
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001156 /* TODO: other slots may have a copy of the same key. We should
1157 * invalidate them.
1158 * https://github.com/ARMmbed/mbed-crypto/issues/214
1159 */
Darryl Greend49a4992018-06-18 17:27:26 +01001160 }
1161#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001162
Gilles Peskinefc762652019-07-22 19:30:34 +02001163#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 if (driver != NULL) {
1165 status = psa_save_se_persistent_data(driver);
1166 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001167 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 }
1169 status = psa_crypto_stop_transaction();
1170 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001171 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001173 }
1174#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1175
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001176exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001177 /* Unregister from reading the slot. If we are the last active reader
1178 * then this will wipe the slot. */
1179 status = psa_unregister_read(slot);
1180 /* Prioritize CORRUPTION_DETECTED from unregistering over
1181 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001183 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 }
1185 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001186}
1187
Valerio Settib2bcedb2023-07-10 11:24:00 +02001188#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001189 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001190static psa_status_t psa_get_rsa_public_exponent(
1191 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001193{
1194 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001195 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001196 uint8_t *buffer = NULL;
1197 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001199
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1201 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001202 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 }
1204 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001205 /* It's the default value, which is reported as an empty string,
1206 * so there's nothing to do. */
1207 goto exit;
1208 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001209
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 buflen = mbedtls_mpi_size(&mpi);
1211 buffer = mbedtls_calloc(1, buflen);
1212 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001213 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1214 goto exit;
1215 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1217 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001218 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001220 attributes->domain_parameters = buffer;
1221 attributes->domain_parameters_size = buflen;
1222
1223exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 mbedtls_mpi_free(&mpi);
1225 if (ret != 0) {
1226 mbedtls_free(buffer);
1227 }
1228 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001229}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001230#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001231 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001232
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001233/** Retrieve all the publicly-accessible attributes of a key.
1234 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001235psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1236 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001237{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001238 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001239 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001240 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001241
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001243
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1245 if (status != PSA_SUCCESS) {
1246 return status;
1247 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001248
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001249 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001250 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1251 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001252
1253#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1255 psa_set_key_slot_number(attributes,
1256 psa_key_slot_get_slot_number(slot));
1257 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001258#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001259
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001261#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1262 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001263 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001264 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001265 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001266 /* TODO: This is a temporary situation where domain parameters are deprecated,
1267 * but we need it for namely generating an RSA key with a non-default exponent.
1268 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001271 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001272
Ronald Cron90857082020-11-25 14:58:33 +01001273 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 slot->attr.type,
1275 slot->key.data,
1276 slot->key.bytes,
1277 &rsa);
1278 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001279 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001281
Gilles Peskine449bd832023-01-11 14:50:10 +01001282 status = psa_get_rsa_public_exponent(rsa,
1283 attributes);
1284 mbedtls_rsa_free(rsa);
1285 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001286 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001287 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001288#else
1289 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1290 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1291 attributes->domain_parameters = NULL;
1292 attributes->domain_parameters_size = SIZE_MAX;
1293 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001294#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1295 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001296 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001297 default:
1298 /* Nothing else to do. */
1299 break;
1300 }
1301
Gilles Peskine449bd832023-01-11 14:50:10 +01001302 if (status != PSA_SUCCESS) {
1303 psa_reset_key_attributes(attributes);
1304 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001305
Ryan Everetta103ec92024-01-31 13:59:57 +00001306 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001307
Gilles Peskine449bd832023-01-11 14:50:10 +01001308 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001309}
1310
Gilles Peskinec8000c02019-08-02 20:15:51 +02001311#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1312psa_status_t psa_get_key_slot_number(
1313 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001315{
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001317 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 return PSA_SUCCESS;
1319 } else {
1320 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001321 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001322}
1323#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1324
Gilles Peskine449bd832023-01-11 14:50:10 +01001325static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1326 size_t key_buffer_size,
1327 uint8_t *data,
1328 size_t data_size,
1329 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001330{
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 if (key_buffer_size > data_size) {
1332 return PSA_ERROR_BUFFER_TOO_SMALL;
1333 }
1334 memcpy(data, key_buffer, key_buffer_size);
1335 memset(data + key_buffer_size, 0,
1336 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001337 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001338 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001339}
1340
Ronald Cron7285cda2020-11-26 14:46:37 +01001341psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001342 const psa_key_attributes_t *attributes,
1343 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001345{
Ronald Crond18b5f82020-11-25 16:46:05 +01001346 psa_key_type_t type = attributes->core.type;
1347
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 if (key_type_is_raw_bytes(type) ||
1349 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001350 PSA_KEY_TYPE_IS_ECC(type) ||
1351 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 return psa_export_key_buffer_internal(
1353 key_buffer, key_buffer_size,
1354 data, data_size, data_length);
1355 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001356 /* This shouldn't happen in the reference implementation, but
1357 it is valid for a special-purpose implementation to omit
1358 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001360 }
1361}
1362
Gilles Peskine449bd832023-01-11 14:50:10 +01001363psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1364 uint8_t *data,
1365 size_t data_size,
1366 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001367{
1368 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1369 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1370 psa_key_slot_t *slot;
1371
Ronald Crone907e552021-01-18 13:22:38 +01001372 /* Reject a zero-length output buffer now, since this can never be a
1373 * valid key representation. This way we know that data must be a valid
1374 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001375 if (data_size == 0) {
1376 return PSA_ERROR_BUFFER_TOO_SMALL;
1377 }
Ronald Crone907e552021-01-18 13:22:38 +01001378
Ronald Cron9486f9d2020-11-26 13:36:23 +01001379 /* Set the key to empty now, so that even when there are errors, we always
1380 * set data_length to a value between 0 and data_size. On error, setting
1381 * the key to empty is a good choice because an empty key representation is
1382 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001383 *data_length = 0;
1384
Ronald Cron9486f9d2020-11-26 13:36:23 +01001385 /* Export requires the EXPORT flag. There is an exception for public keys,
1386 * which don't require any flag, but
1387 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1388 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1390 PSA_KEY_USAGE_EXPORT, 0);
1391 if (status != PSA_SUCCESS) {
1392 return status;
1393 }
mohammad160306e79202018-03-28 13:17:44 +03001394
Ronald Crond18b5f82020-11-25 16:46:05 +01001395 psa_key_attributes_t attributes = {
1396 .core = slot->attr
1397 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 status = psa_driver_wrapper_export_key(&attributes,
1399 slot->key.data, slot->key.bytes,
1400 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001401
Ryan Everetta103ec92024-01-31 13:59:57 +00001402 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001403
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001405}
1406
Ronald Cron7285cda2020-11-26 14:46:37 +01001407psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001408 const psa_key_attributes_t *attributes,
1409 const uint8_t *key_buffer,
1410 size_t key_buffer_size,
1411 uint8_t *data,
1412 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001414{
Ronald Crond18b5f82020-11-25 16:46:05 +01001415 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001416
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001417 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001418 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1419 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001420 /* Exporting public -> public */
1421 return psa_export_key_buffer_internal(
1422 key_buffer, key_buffer_size,
1423 data, data_size, data_length);
1424 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001425#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001426 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1427 return mbedtls_psa_rsa_export_public_key(attributes,
1428 key_buffer,
1429 key_buffer_size,
1430 data,
1431 data_size,
1432 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001433#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001434 /* We don't know how to convert a private RSA key to public. */
1435 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001436#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001437 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001438 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001439#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001440 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1441 return mbedtls_psa_ecp_export_public_key(attributes,
1442 key_buffer,
1443 key_buffer_size,
1444 data,
1445 data_size,
1446 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001447#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001448 /* We don't know how to convert a private ECC key to public */
1449 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001450#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001451 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001452 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001453#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001454 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001455 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001456 key_buffer,
1457 key_buffer_size,
1458 data, data_size,
1459 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001460#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001461 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001462#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001463 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001465 (void) key_buffer;
1466 (void) key_buffer_size;
1467 (void) data;
1468 (void) data_size;
1469 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001470 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001471 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001472}
Ronald Crond18b5f82020-11-25 16:46:05 +01001473
Gilles Peskine449bd832023-01-11 14:50:10 +01001474psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1475 uint8_t *data,
1476 size_t data_size,
1477 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001478{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001479 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001480 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001481 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001482 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001483
Ronald Crone907e552021-01-18 13:22:38 +01001484 /* Reject a zero-length output buffer now, since this can never be a
1485 * valid key representation. This way we know that data must be a valid
1486 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 if (data_size == 0) {
1488 return PSA_ERROR_BUFFER_TOO_SMALL;
1489 }
Ronald Crone907e552021-01-18 13:22:38 +01001490
Darryl Greendd8fb772018-11-07 16:00:44 +00001491 /* Set the key to empty now, so that even when there are errors, we always
1492 * set data_length to a value between 0 and data_size. On error, setting
1493 * the key to empty is a good choice because an empty key representation is
1494 * unlikely to be accepted anywhere. */
1495 *data_length = 0;
1496
1497 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1499 if (status != PSA_SUCCESS) {
1500 return status;
1501 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001502
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1504 status = PSA_ERROR_INVALID_ARGUMENT;
1505 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001506 }
1507
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001508 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001509 .core = slot->attr
1510 };
Ronald Cron67227982020-11-26 15:16:05 +01001511 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001512 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001514
1515exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00001516 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001517
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001519}
1520
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001521MBEDTLS_STATIC_ASSERT(
1522 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1523 "One or more key attribute flag is listed as both external-only and dual-use")
1524MBEDTLS_STATIC_ASSERT(
1525 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1526 "One or more key attribute flag is listed as both internal-only and dual-use")
1527MBEDTLS_STATIC_ASSERT(
1528 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1529 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001530
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001531/** Validate that a key policy is internally well-formed.
1532 *
1533 * This function only rejects invalid policies. It does not validate the
1534 * consistency of the policy with respect to other attributes of the key
1535 * such as the key type.
1536 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001537static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001538{
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1540 PSA_KEY_USAGE_COPY |
1541 PSA_KEY_USAGE_ENCRYPT |
1542 PSA_KEY_USAGE_DECRYPT |
1543 PSA_KEY_USAGE_SIGN_MESSAGE |
1544 PSA_KEY_USAGE_VERIFY_MESSAGE |
1545 PSA_KEY_USAGE_SIGN_HASH |
1546 PSA_KEY_USAGE_VERIFY_HASH |
1547 PSA_KEY_USAGE_VERIFY_DERIVATION |
1548 PSA_KEY_USAGE_DERIVE)) != 0) {
1549 return PSA_ERROR_INVALID_ARGUMENT;
1550 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001551
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001553}
1554
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001555/** Validate the internal consistency of key attributes.
1556 *
1557 * This function only rejects invalid attribute values. If does not
1558 * validate the consistency of the attributes with any key data that may
1559 * be involved in the creation of the key.
1560 *
1561 * Call this function early in the key creation process.
1562 *
1563 * \param[in] attributes Key attributes for the new key.
1564 * \param[out] p_drv On any return, the driver for the key, if any.
1565 * NULL for a transparent key.
1566 *
1567 */
1568static psa_status_t psa_validate_key_attributes(
1569 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001571{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001572 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1574 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001575
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 status = psa_validate_key_location(lifetime, p_drv);
1577 if (status != PSA_SUCCESS) {
1578 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001579 }
1580
Gilles Peskine449bd832023-01-11 14:50:10 +01001581 status = psa_validate_key_persistence(lifetime);
1582 if (status != PSA_SUCCESS) {
1583 return status;
1584 }
1585
1586 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1587 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1588 return PSA_ERROR_INVALID_ARGUMENT;
1589 }
1590 } else {
1591 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1592 return PSA_ERROR_INVALID_ARGUMENT;
1593 }
1594 }
1595
1596 status = psa_validate_key_policy(&attributes->core.policy);
1597 if (status != PSA_SUCCESS) {
1598 return status;
1599 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001600
1601 /* Refuse to create overly large keys.
1602 * Note that this doesn't trigger on import if the attributes don't
1603 * explicitly specify a size (so psa_get_key_bits returns 0), so
1604 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1606 return PSA_ERROR_NOT_SUPPORTED;
1607 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001608
Gilles Peskine91e8c332019-08-02 19:19:39 +02001609 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001610 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1611 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1612 return PSA_ERROR_INVALID_ARGUMENT;
1613 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001614
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001616}
1617
Gilles Peskine4747d192019-04-17 15:05:45 +02001618/** Prepare a key slot to receive key material.
1619 *
1620 * This function allocates a key slot and sets its metadata.
1621 *
1622 * If this function fails, call psa_fail_key_creation().
1623 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001624 * This function is intended to be used as follows:
1625 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001626 * it with the specified attributes, and in case of a volatile key assign it
1627 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001628 * -# Populate the slot with the key material.
1629 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1630 * In case of failure at any step, stop the sequence and call
1631 * psa_fail_key_creation().
1632 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001633 * On success, the key slot's state is PSA_SLOT_FILLING.
1634 * It is the responsibility of the caller to change the slot's state to
1635 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001636 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001637 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001638 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001639 * \param[out] p_slot On success, a pointer to the prepared slot.
1640 * \param[out] p_drv On any return, the driver for the key, if any.
1641 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001642 *
1643 * \retval #PSA_SUCCESS
1644 * The key slot is ready to receive key material.
1645 * \return If this function fails, the key slot is an invalid state.
1646 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001647 */
1648static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001649 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001650 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001651 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001652 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001653{
1654 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001655 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001656 psa_key_slot_t *slot;
1657
Gilles Peskinedf179142019-07-15 22:02:14 +02001658 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001659 *p_drv = NULL;
1660
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 status = psa_validate_key_attributes(attributes, p_drv);
1662 if (status != PSA_SUCCESS) {
1663 return status;
1664 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001665
Ryan Everettb69118e2024-01-02 15:54:32 +00001666 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 if (status != PSA_SUCCESS) {
1668 return status;
1669 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001670 slot = *p_slot;
1671
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001672 /* We're storing the declared bit-size of the key. It's up to each
1673 * creation mechanism to verify that this information is correct.
1674 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001675 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001676 * is optional (import, copy). In case of a volatile key, assign it the
1677 * volatile key identifier associated to the slot returned to contain its
1678 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001679
1680 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001681 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001682#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1683 slot->attr.id = volatile_key_id;
1684#else
1685 slot->attr.id.key_id = volatile_key_id;
1686#endif
1687 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001688
Gilles Peskine91e8c332019-08-02 19:19:39 +02001689 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001690 * external-only flags, query `attributes`. Thanks to the check
1691 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001692 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001693 * may have set. */
1694 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001695
Gilles Peskinecbaff462019-07-12 23:46:04 +02001696#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001697 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001698 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001699 * create the key file in internal storage, create the
1700 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001701 * persistent data. This is done by starting a transaction that will
1702 * encompass these three actions.
1703 * For registering a volatile key, we just need to find an appropriate
1704 * slot number inside the SE. Since the key is designated volatile, creating
1705 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001706 /* The first thing to do is to find a slot number for the new key.
1707 * We save the slot number in persistent storage as part of the
1708 * transaction data. It will be needed to recover if the power
1709 * fails during the key creation process, to clean up on the secure
1710 * element side after restarting. Obtaining a slot number from the
1711 * secure element driver updates its persistent state, but we do not yet
1712 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001713 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001715 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1717 &slot_number);
1718 if (status != PSA_SUCCESS) {
1719 return status;
1720 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001721
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1723 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001724 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001725 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001726 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 status = psa_crypto_save_transaction();
1728 if (status != PSA_SUCCESS) {
1729 (void) psa_crypto_stop_transaction();
1730 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001731 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001732 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001733
1734 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001736 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001739 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001741 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001742#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1743
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001745}
Gilles Peskine4747d192019-04-17 15:05:45 +02001746
1747/** Finalize the creation of a key once its key material has been set.
1748 *
1749 * This entails writing the key to persistent storage.
1750 *
1751 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001752 * See the documentation of psa_start_key_creation() for the intended use
1753 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001754 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001755 * If the finalization succeeds, the function sets the key slot's state to
1756 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1757 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001758 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001759 * \param[in,out] slot Pointer to the slot with key material.
1760 * \param[in] driver The secure element driver for the key,
1761 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001762 * \param[out] key On success, identifier of the key. Note that the
1763 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001764 *
1765 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001766 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001767 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1768 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1769 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1770 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1771 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1772 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001773 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001774 * \return If this function fails, the key slot is an invalid state.
1775 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001776 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001777static psa_status_t psa_finish_key_creation(
1778 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001779 psa_se_drv_table_entry_t *driver,
1780 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001781{
1782 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001783 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001784 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001785
1786#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001788#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001790 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001791 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001793
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001794 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1795 sizeof(data.slot_number),
1796 "Slot number size does not match psa_se_key_data_storage_t");
1797
Gilles Peskine449bd832023-01-11 14:50:10 +01001798 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1799 status = psa_save_persistent_key(&slot->attr,
1800 (uint8_t *) &data,
1801 sizeof(data));
1802 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001803#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1804 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001805 /* Key material is saved in export representation in the slot, so
1806 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 status = psa_save_persistent_key(&slot->attr,
1808 slot->key.data,
1809 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001810 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001811 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001812#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1813
Gilles Peskinecbaff462019-07-12 23:46:04 +02001814#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001815 /* Finish the transaction for a key creation. This does not
1816 * happen when registering an existing key. Detect this case
1817 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001818 * creation of a persistent key in a secure element requires a transaction,
1819 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001820 if (driver != NULL &&
1821 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1822 status = psa_save_se_persistent_data(driver);
1823 if (status != PSA_SUCCESS) {
1824 psa_destroy_persistent_key(slot->attr.id);
1825 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001826 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001828 }
1829#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1830
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001832 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001833 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1834 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001836 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001838 }
Ronald Cron50972942020-11-14 11:28:25 +01001839
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001841}
1842
1843/** Abort the creation of a key.
1844 *
1845 * You may call this function after calling psa_start_key_creation(),
1846 * or after psa_finish_key_creation() fails. In other circumstances, this
1847 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001848 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001849 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001850 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001851 * \param[in,out] slot Pointer to the slot with key material.
1852 * \param[in] driver The secure element driver for the key,
1853 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001854 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001855static void psa_fail_key_creation(psa_key_slot_t *slot,
1856 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001857{
Gilles Peskine011e4282019-06-26 18:34:38 +02001858 (void) driver;
1859
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001861 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001863
1864#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001865 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001866 * element, and the failure happened later (when saving metadata
1867 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001868 * element.
1869 * https://github.com/ARMmbed/mbed-crypto/issues/217
1870 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001871
Gilles Peskined7729582019-08-05 15:55:54 +02001872 /* Abort the ongoing transaction if any (there may not be one if
1873 * the creation process failed before starting one, or if the
1874 * key creation is a registration of a key in a secure element).
1875 * Earlier functions must already have done what it takes to undo any
1876 * partial creation. All that's left is to update the transaction data
1877 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001879#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1880
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001882}
1883
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001884/** Validate optional attributes during key creation.
1885 *
1886 * Some key attributes are optional during key creation. If they are
1887 * specified in the attributes structure, check that they are consistent
1888 * with the data in the slot.
1889 *
1890 * This function should be called near the end of key creation, after
1891 * the slot in memory is fully populated but before saving persistent data.
1892 */
1893static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001894 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001895 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001896{
Gilles Peskine449bd832023-01-11 14:50:10 +01001897 if (attributes->core.type != 0) {
1898 if (attributes->core.type != slot->attr.type) {
1899 return PSA_ERROR_INVALID_ARGUMENT;
1900 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001901 }
1902
Gilles Peskine449bd832023-01-11 14:50:10 +01001903 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001904#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1905 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001906 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1907 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001908 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001909 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001910 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001911
Ronald Cron90857082020-11-25 14:58:33 +01001912 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 slot->attr.type,
1914 slot->key.data,
1915 slot->key.bytes,
1916 &rsa);
1917 if (status != PSA_SUCCESS) {
1918 return status;
1919 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001920
Gilles Peskine449bd832023-01-11 14:50:10 +01001921 mbedtls_mpi_init(&actual);
1922 mbedtls_mpi_init(&required);
1923 ret = mbedtls_rsa_export(rsa,
1924 NULL, NULL, NULL, NULL, &actual);
1925 mbedtls_rsa_free(rsa);
1926 mbedtls_free(rsa);
1927 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001928 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 }
1930 ret = mbedtls_mpi_read_binary(&required,
1931 attributes->domain_parameters,
1932 attributes->domain_parameters_size);
1933 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001934 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 }
1936 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001937 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 }
1939rsa_exit:
1940 mbedtls_mpi_free(&actual);
1941 mbedtls_mpi_free(&required);
1942 if (ret != 0) {
1943 return mbedtls_to_psa_error(ret);
1944 }
1945 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001946#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1947 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001948 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001949 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001951 }
1952 }
1953
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 if (attributes->core.bits != 0) {
1955 if (attributes->core.bits != slot->attr.bits) {
1956 return PSA_ERROR_INVALID_ARGUMENT;
1957 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001958 }
1959
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001961}
1962
Gilles Peskine449bd832023-01-11 14:50:10 +01001963psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1964 const uint8_t *data,
1965 size_t data_length,
1966 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001967{
1968 psa_status_t status;
1969 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02001970 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001971 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05301972 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001973
Ronald Cron81709fc2020-11-14 12:10:32 +01001974 *key = MBEDTLS_SVC_KEY_ID_INIT;
1975
Gilles Peskine0f84d622019-09-12 19:03:13 +02001976 /* Reject zero-length symmetric keys (including raw data key objects).
1977 * This also rejects any key which might be encoded as an empty string,
1978 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 if (data_length == 0) {
1980 return PSA_ERROR_INVALID_ARGUMENT;
1981 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02001982
Archana449608b2021-09-08 15:36:05 +05301983 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 if (data_length > SIZE_MAX / 8) {
1985 return PSA_ERROR_NOT_SUPPORTED;
1986 }
Archana6ed4bda2021-08-04 10:47:15 +05301987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
1989 &slot, &driver);
1990 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001991 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001993
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01001994 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05301995 * storage ( thus not in the case of importing a key in a secure element
1996 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
1997 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 if (slot->key.data == NULL) {
1999 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302000 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 attributes, data, data_length, &storage_size);
2002 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302003 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 }
Archanad8a83dc2021-06-14 10:04:16 +05302005 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 status = psa_allocate_buffer_to_slot(slot, storage_size);
2007 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002008 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002010 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002011
2012 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 status = psa_driver_wrapper_import_key(attributes,
2014 data, data_length,
2015 slot->key.data,
2016 slot->key.bytes,
2017 &slot->key.bytes, &bits);
2018 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002019 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002021
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002023 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002025 status = PSA_ERROR_INVALID_ARGUMENT;
2026 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002027 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002028
Archana6ed4bda2021-08-04 10:47:15 +05302029 /* Enforce a size limit, and in particular ensure that the bit
2030 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302032 status = PSA_ERROR_NOT_SUPPORTED;
2033 goto exit;
2034 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 status = psa_validate_optional_attributes(slot, attributes);
2036 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002037 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002041exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 if (status != PSA_SUCCESS) {
2043 psa_fail_key_creation(slot, driver);
2044 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002045
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002047}
2048
Gilles Peskined7729582019-08-05 15:55:54 +02002049#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2050psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002052{
2053 psa_status_t status;
2054 psa_key_slot_t *slot = NULL;
2055 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002056 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002057
2058 /* Leaving attributes unspecified is not currently supported.
2059 * It could make sense to query the key type and size from the
2060 * secure element, but not all secure elements support this
2061 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2063 return PSA_ERROR_NOT_SUPPORTED;
2064 }
2065 if (psa_get_key_bits(attributes) == 0) {
2066 return PSA_ERROR_NOT_SUPPORTED;
2067 }
Gilles Peskined7729582019-08-05 15:55:54 +02002068
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2070 &slot, &driver);
2071 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002072 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 }
Gilles Peskined7729582019-08-05 15:55:54 +02002074
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002076
2077exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 if (status != PSA_SUCCESS) {
2079 psa_fail_key_creation(slot, driver);
2080 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002081
Gilles Peskined7729582019-08-05 15:55:54 +02002082 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 psa_close_key(key);
2084 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002085}
2086#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2087
Gilles Peskine449bd832023-01-11 14:50:10 +01002088psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2089 const psa_key_attributes_t *specified_attributes,
2090 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002091{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002092 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002093 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002094 psa_key_slot_t *source_slot = NULL;
2095 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002096 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002097 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302098 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002099
Ronald Cron81709fc2020-11-14 12:10:32 +01002100 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2101
Archana8a180362021-07-05 02:18:48 +05302102 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2104 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002105 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 status = psa_validate_optional_attributes(source_slot,
2109 specified_attributes);
2110 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002111 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002113
Archana9d17bf42021-09-10 06:22:44 +05302114 /* The target key type and number of bits have been validated by
2115 * psa_validate_optional_attributes() to be either equal to zero or
2116 * equal to the ones of the source key. So it is safe to inherit
2117 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302118 * */
Archana9d17bf42021-09-10 06:22:44 +05302119 actual_attributes.core.bits = source_slot->attr.bits;
2120 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302121
2122
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 status = psa_restrict_key_policy(source_slot->attr.type,
2124 &actual_attributes.core.policy,
2125 &source_slot->attr.policy);
2126 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002127 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002129
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2131 &target_slot, &driver);
2132 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002133 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 }
2135 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2136 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302137 /*
Archana9d17bf42021-09-10 06:22:44 +05302138 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302139 * the source key would need to be exported as plaintext and re-imported
2140 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302141 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302142 * appropriate API invocations from the application, if needed.
2143 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002144 status = PSA_ERROR_NOT_SUPPORTED;
2145 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002146 }
Archana8a180362021-07-05 02:18:48 +05302147 /*
2148 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302149 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302150 * - For opaque keys this translates to an invocation of the drivers'
2151 * copy_key entry point through the dispatch layer.
2152 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2154 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2155 &storage_size);
2156 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302157 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 }
Archana374fe5b2021-09-08 15:50:28 +05302159
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2161 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302162 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 }
Archana374fe5b2021-09-08 15:50:28 +05302164
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 status = psa_driver_wrapper_copy_key(&actual_attributes,
2166 source_slot->key.data,
2167 source_slot->key.bytes,
2168 target_slot->key.data,
2169 target_slot->key.bytes,
2170 &target_slot->key.bytes);
2171 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302172 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 }
2174 } else {
2175 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302176 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 source_slot->key.bytes);
2178 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302179 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 }
Archana8a180362021-07-05 02:18:48 +05302181 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002183exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 if (status != PSA_SUCCESS) {
2185 psa_fail_key_creation(target_slot, driver);
2186 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002187
Ryan Everetta103ec92024-01-31 13:59:57 +00002188 unlock_status = psa_unregister_read_under_mutex(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002189
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002191}
2192
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002193
2194
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002195/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002196/* Message digests */
2197/****************************************************************/
2198
Gilles Peskine449bd832023-01-11 14:50:10 +01002199psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002200{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002201 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 if (operation->id == 0) {
2203 return PSA_SUCCESS;
2204 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002207 operation->id = 0;
2208
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002210}
2211
Gilles Peskine449bd832023-01-11 14:50:10 +01002212psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2213 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002214{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002215 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002216
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002217 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002219 status = PSA_ERROR_BAD_STATE;
2220 goto exit;
2221 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002222
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002224 status = PSA_ERROR_INVALID_ARGUMENT;
2225 goto exit;
2226 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002227
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002228 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2229 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002231
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002233
2234exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (status != PSA_SUCCESS) {
2236 psa_hash_abort(operation);
2237 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002238
2239 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002240}
2241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2243 const uint8_t *input,
2244 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002245{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002246 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2247
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002249 status = PSA_ERROR_BAD_STATE;
2250 goto exit;
2251 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002252
Steven Cooremanc8288352021-03-04 14:02:19 +01002253 /* Don't require hash implementations to behave correctly on a
2254 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 if (input_length == 0) {
2256 return PSA_SUCCESS;
2257 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002258
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002260
2261exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 if (status != PSA_SUCCESS) {
2263 psa_hash_abort(operation);
2264 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002265
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002267}
2268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2270 uint8_t *hash,
2271 size_t hash_size,
2272 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002273{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002274 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 if (operation->id == 0) {
2276 return PSA_ERROR_BAD_STATE;
2277 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002278
Steven Cooreman1e582352021-02-18 17:24:37 +01002279 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 operation, hash, hash_size, hash_length);
2281 psa_hash_abort(operation);
2282 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002283}
2284
Gilles Peskine449bd832023-01-11 14:50:10 +01002285psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2286 const uint8_t *hash,
2287 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002288{
Ronald Cron69a63422021-10-18 09:47:58 +02002289 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002290 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002291 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 operation,
2293 actual_hash, sizeof(actual_hash),
2294 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002295
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002297 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002299
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002301 status = PSA_ERROR_INVALID_SIGNATURE;
2302 goto exit;
2303 }
2304
Dave Rodgman78701152023-08-29 14:20:18 +01002305 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002306 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002308
2309exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2311 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002312 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002316}
2317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318psa_status_t psa_hash_compute(psa_algorithm_t alg,
2319 const uint8_t *input, size_t input_length,
2320 uint8_t *hash, size_t hash_size,
2321 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002322{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002323 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 if (!PSA_ALG_IS_HASH(alg)) {
2325 return PSA_ERROR_INVALID_ARGUMENT;
2326 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2329 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002330}
2331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332psa_status_t psa_hash_compare(psa_algorithm_t alg,
2333 const uint8_t *input, size_t input_length,
2334 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002335{
Ronald Cron69a63422021-10-18 09:47:58 +02002336 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002337 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002338
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 if (!PSA_ALG_IS_HASH(alg)) {
2340 return PSA_ERROR_INVALID_ARGUMENT;
2341 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002342
Steven Cooreman1e582352021-02-18 17:24:37 +01002343 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 alg, input, input_length,
2345 actual_hash, sizeof(actual_hash),
2346 &actual_hash_length);
2347 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002348 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 }
2350 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002351 status = PSA_ERROR_INVALID_SIGNATURE;
2352 goto exit;
2353 }
Dave Rodgman78701152023-08-29 14:20:18 +01002354 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002355 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002357
2358exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2360 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002361}
2362
Gilles Peskine449bd832023-01-11 14:50:10 +01002363psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2364 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002365{
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 if (source_operation->id == 0 ||
2367 target_operation->id != 0) {
2368 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002369 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002370
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2372 target_operation);
2373 if (status != PSA_SUCCESS) {
2374 psa_hash_abort(target_operation);
2375 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002378}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002379
2380
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002381/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002382/* MAC */
2383/****************************************************************/
2384
Gilles Peskine449bd832023-01-11 14:50:10 +01002385psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002386{
Steven Cooremane6804192021-03-19 18:28:56 +01002387 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 if (operation->id == 0) {
2389 return PSA_SUCCESS;
2390 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002391
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002393 operation->mac_size = 0;
2394 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002395 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002396
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002398}
2399
Ronald Cron2dff3b22021-06-17 16:33:22 +02002400static psa_status_t psa_mac_finalize_alg_and_key_validation(
2401 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002402 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002404{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 psa_key_type_t key_type = psa_get_key_type(attributes);
2407 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002408
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 if (!PSA_ALG_IS_MAC(alg)) {
2410 return PSA_ERROR_INVALID_ARGUMENT;
2411 }
Steven Cooremane6804192021-03-19 18:28:56 +01002412
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002413 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 status = psa_mac_key_can_do(alg, key_type);
2415 if (status != PSA_SUCCESS) {
2416 return status;
2417 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002418
Steven Cooremand1a68f12021-05-10 11:13:41 +02002419 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002421
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002423 /* A very short MAC is too short for security since it can be
2424 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2425 * so we make this our minimum, even though 32 bits is still
2426 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002428 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002429
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2431 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002432 /* It's impossible to "truncate" to a larger length than the full length
2433 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002435 }
2436
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002438 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2439 * that is disabled in the compile-time configuration. The result can
2440 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2441 * configuration into account. In this case, force a return of
2442 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2443 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2444 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2445 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2446 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002448 }
2449
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002451}
2452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2454 mbedtls_svc_key_id_t key,
2455 psa_algorithm_t alg,
2456 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002457{
2458 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2459 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002460 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002461 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002462
2463 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002465 status = PSA_ERROR_BAD_STATE;
2466 goto exit;
2467 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002468
2469 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 key,
2471 &slot,
2472 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2473 alg);
2474 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002475 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002477
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002478 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002479 .core = slot->attr
2480 };
2481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2483 &operation->mac_size);
2484 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002485 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002487
2488 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002489 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002490 if (is_sign) {
2491 status = psa_driver_wrapper_mac_sign_setup(operation,
2492 &attributes,
2493 slot->key.data,
2494 slot->key.bytes,
2495 alg);
2496 } else {
2497 status = psa_driver_wrapper_mac_verify_setup(operation,
2498 &attributes,
2499 slot->key.data,
2500 slot->key.bytes,
2501 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002502 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002503
Gilles Peskinefbfac682018-07-08 20:51:54 +02002504exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 if (status != PSA_SUCCESS) {
2506 psa_mac_abort(operation);
2507 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002508
Ryan Everett1b70a072024-01-04 10:32:49 +00002509 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002512}
2513
Gilles Peskine449bd832023-01-11 14:50:10 +01002514psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2515 mbedtls_svc_key_id_t key,
2516 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002517{
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002519}
2520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2522 mbedtls_svc_key_id_t key,
2523 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002524{
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002526}
2527
Gilles Peskine449bd832023-01-11 14:50:10 +01002528psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2529 const uint8_t *input,
2530 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002531{
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 if (operation->id == 0) {
2533 return PSA_ERROR_BAD_STATE;
2534 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002535
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002536 /* Don't require hash implementations to behave correctly on a
2537 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 if (input_length == 0) {
2539 return PSA_SUCCESS;
2540 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002541
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2543 input, input_length);
2544 if (status != PSA_SUCCESS) {
2545 psa_mac_abort(operation);
2546 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002549}
2550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2552 uint8_t *mac,
2553 size_t mac_size,
2554 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002555{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002556 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2557 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002558
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002560 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002561 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002562 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002565 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002566 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002567 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002568
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002569 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2570 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002572 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002573 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002574 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002577 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002578 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002579 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 status = psa_driver_wrapper_mac_sign_finish(operation,
2582 mac, operation->mac_size,
2583 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002584
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002585exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002586 /* In case of success, set the potential excess room in the output buffer
2587 * to an invalid value, to avoid potentially leaking a longer MAC.
2588 * In case of error, set the output length and content to a safe default,
2589 * such that in case the caller misses an error check, the output would be
2590 * an unachievable MAC.
2591 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002593 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002594 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002595 }
mohammad16036df908f2018-04-02 08:34:15 -07002596
Paul Elliottdc42ca82023-02-24 18:11:59 +00002597 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002602}
2603
Gilles Peskine449bd832023-01-11 14:50:10 +01002604psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2605 const uint8_t *mac,
2606 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002607{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002608 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2609 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002612 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002613 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002614 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002615
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002617 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002618 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002619 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002620
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002622 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002623 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002624 }
2625
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 status = psa_driver_wrapper_mac_verify_finish(operation,
2627 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002628
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002629exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002631
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002633}
2634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2636 psa_algorithm_t alg,
2637 const uint8_t *input,
2638 size_t input_length,
2639 uint8_t *mac,
2640 size_t mac_size,
2641 size_t *mac_length,
2642 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002643{
2644 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002645 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2646 psa_key_slot_t *slot;
2647 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002648 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002649
Ronald Cron51131b52021-06-17 17:17:20 +02002650 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 key,
2652 &slot,
2653 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2654 alg);
2655 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002656 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002658
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002659 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002660 .core = slot->attr
2661 };
2662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2664 &operation_mac_size);
2665 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002666 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002670 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002671 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002672 }
2673
2674 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 &attributes,
2676 slot->key.data, slot->key.bytes,
2677 alg,
2678 input, input_length,
2679 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002680
2681exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002682 /* In case of success, set the potential excess room in the output buffer
2683 * to an invalid value, to avoid potentially leaking a longer MAC.
2684 * In case of error, set the output length and content to a safe default,
2685 * such that in case the caller misses an error check, the output would be
2686 * an unachievable MAC.
2687 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002689 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002690 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002691 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002692
2693 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002694
Ryan Everetta103ec92024-01-31 13:59:57 +00002695 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002698}
2699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002701 psa_algorithm_t alg,
2702 const uint8_t *input,
2703 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 uint8_t *mac,
2705 size_t mac_size,
2706 size_t *mac_length)
2707{
2708 return psa_mac_compute_internal(key, alg,
2709 input, input_length,
2710 mac, mac_size, mac_length, 1);
2711}
2712
2713psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2714 psa_algorithm_t alg,
2715 const uint8_t *input,
2716 size_t input_length,
2717 const uint8_t *mac,
2718 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002719{
2720 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002721 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2722 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002723
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 status = psa_mac_compute_internal(key, alg,
2725 input, input_length,
2726 actual_mac, sizeof(actual_mac),
2727 &actual_mac_length, 0);
2728 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002729 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002731
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002733 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002734 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002735 }
Dave Rodgman78701152023-08-29 14:20:18 +01002736 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002737 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002738 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002739 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002740
2741exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002743
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002745}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002746
Gilles Peskinee59236f2018-01-27 23:32:46 +01002747/****************************************************************/
2748/* Asymmetric cryptography */
2749/****************************************************************/
2750
Gilles Peskine449bd832023-01-11 14:50:10 +01002751static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2752 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002753{
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 if (input_is_message) {
2755 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2756 return PSA_ERROR_INVALID_ARGUMENT;
2757 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002758
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2760 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2761 return PSA_ERROR_INVALID_ARGUMENT;
2762 }
2763 }
2764 } else {
2765 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2766 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002767 }
2768 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002769
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002771}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002772
Gilles Peskine449bd832023-01-11 14:50:10 +01002773static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2774 int input_is_message,
2775 psa_algorithm_t alg,
2776 const uint8_t *input,
2777 size_t input_length,
2778 uint8_t *signature,
2779 size_t signature_size,
2780 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002781{
2782 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2783 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2784 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002785 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002786
2787 *signature_length = 0;
2788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 status = psa_sign_verify_check_alg(input_is_message, alg);
2790 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002791 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002793
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002794 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002795 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002796 * buffer can in principle be empty since it doesn't actually have
2797 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 if (signature_size == 0) {
2799 return PSA_ERROR_BUFFER_TOO_SMALL;
2800 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002801
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002802 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 key, &slot,
2804 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2805 PSA_KEY_USAGE_SIGN_HASH,
2806 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002807
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002809 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002811
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002813 status = PSA_ERROR_INVALID_ARGUMENT;
2814 goto exit;
2815 }
2816
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002817 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002819 };
2820
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002822 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002823 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002824 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 signature, signature_size, signature_length);
2826 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002827
2828 status = psa_driver_wrapper_sign_hash(
2829 &attributes, slot->key.data, slot->key.bytes,
2830 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002832 }
2833
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002834
2835exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002836 psa_wipe_tag_output_buffer(signature, status, signature_size,
2837 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002838
Ryan Everetta103ec92024-01-31 13:59:57 +00002839 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002840
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002842}
2843
Gilles Peskine449bd832023-01-11 14:50:10 +01002844static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2845 int input_is_message,
2846 psa_algorithm_t alg,
2847 const uint8_t *input,
2848 size_t input_length,
2849 const uint8_t *signature,
2850 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002851{
2852 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2853 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2854 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 status = psa_sign_verify_check_alg(input_is_message, alg);
2857 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002858 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +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_VERIFY_MESSAGE :
2864 PSA_KEY_USAGE_VERIFY_HASH,
2865 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if (status != PSA_SUCCESS) {
2868 return status;
2869 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002870
2871 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002873 };
2874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002876 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002877 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002878 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 signature, signature_length);
2880 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002881 status = psa_driver_wrapper_verify_hash(
2882 &attributes, slot->key.data, slot->key.bytes,
2883 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002885 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002886
Ryan Everetta103ec92024-01-31 13:59:57 +00002887 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002888
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002890
2891}
2892
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002893psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002894 const psa_key_attributes_t *attributes,
2895 const uint8_t *key_buffer,
2896 size_t key_buffer_size,
2897 psa_algorithm_t alg,
2898 const uint8_t *input,
2899 size_t input_length,
2900 uint8_t *signature,
2901 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002903{
2904 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002907 size_t hash_length;
2908 uint8_t hash[PSA_HASH_MAX_SIZE];
2909
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002910 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 PSA_ALG_SIGN_GET_HASH(alg),
2912 input, input_length,
2913 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002916 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002918
2919 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 attributes, key_buffer, key_buffer_size,
2921 alg, hash, hash_length,
2922 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002923 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002926}
2927
Gilles Peskine449bd832023-01-11 14:50:10 +01002928psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2929 psa_algorithm_t alg,
2930 const uint8_t *input,
2931 size_t input_length,
2932 uint8_t *signature,
2933 size_t signature_size,
2934 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002935{
2936 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002937 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002939}
2940
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002941psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002942 const psa_key_attributes_t *attributes,
2943 const uint8_t *key_buffer,
2944 size_t key_buffer_size,
2945 psa_algorithm_t alg,
2946 const uint8_t *input,
2947 size_t input_length,
2948 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002950{
2951 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002952
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002954 size_t hash_length;
2955 uint8_t hash[PSA_HASH_MAX_SIZE];
2956
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002957 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 PSA_ALG_SIGN_GET_HASH(alg),
2959 input, input_length,
2960 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002961
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002963 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002965
2966 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 attributes, key_buffer, key_buffer_size,
2968 alg, hash, hash_length,
2969 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002970 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002971
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002973}
2974
Gilles Peskine449bd832023-01-11 14:50:10 +01002975psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
2976 psa_algorithm_t alg,
2977 const uint8_t *input,
2978 size_t input_length,
2979 const uint8_t *signature,
2980 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002981{
2982 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002983 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002985}
2986
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002987psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01002988 const psa_key_attributes_t *attributes,
2989 const uint8_t *key_buffer, size_t key_buffer_size,
2990 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002992{
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
2994 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
2995 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01002996#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
2998 return mbedtls_psa_rsa_sign_hash(
2999 attributes,
3000 key_buffer, key_buffer_size,
3001 alg, hash, hash_length,
3002 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003003#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3004 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 } else {
3006 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003007 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3009 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003010#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3012 return mbedtls_psa_ecdsa_sign_hash(
3013 attributes,
3014 key_buffer, key_buffer_size,
3015 alg, hash, hash_length,
3016 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003017#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3018 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 } else {
3020 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003021 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003022 }
Ronald Cron4501c982021-03-19 20:09:32 +01003023
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 (void) key_buffer;
3025 (void) key_buffer_size;
3026 (void) hash;
3027 (void) hash_length;
3028 (void) signature;
3029 (void) signature_size;
3030 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003033}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003034
Gilles Peskine449bd832023-01-11 14:50:10 +01003035psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3036 psa_algorithm_t alg,
3037 const uint8_t *hash,
3038 size_t hash_length,
3039 uint8_t *signature,
3040 size_t signature_size,
3041 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003042{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003043 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003044 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003046}
3047
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003048psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003049 const psa_key_attributes_t *attributes,
3050 const uint8_t *key_buffer, size_t key_buffer_size,
3051 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003053{
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3055 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3056 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003057#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3059 return mbedtls_psa_rsa_verify_hash(
3060 attributes,
3061 key_buffer, key_buffer_size,
3062 alg, hash, hash_length,
3063 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003064#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3065 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 } else {
3067 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003068 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3070 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003071#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3073 return mbedtls_psa_ecdsa_verify_hash(
3074 attributes,
3075 key_buffer, key_buffer_size,
3076 alg, hash, hash_length,
3077 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003078#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3079 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 } else {
3081 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003082 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003083 }
Ronald Cron4501c982021-03-19 20:09:32 +01003084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 (void) key_buffer;
3086 (void) key_buffer_size;
3087 (void) hash;
3088 (void) hash_length;
3089 (void) signature;
3090 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003091
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003093}
3094
Gilles Peskine449bd832023-01-11 14:50:10 +01003095psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3096 psa_algorithm_t alg,
3097 const uint8_t *hash,
3098 size_t hash_length,
3099 const uint8_t *signature,
3100 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003101{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003102 return psa_verify_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_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003105}
3106
Gilles Peskine449bd832023-01-11 14:50:10 +01003107psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3108 psa_algorithm_t alg,
3109 const uint8_t *input,
3110 size_t input_length,
3111 const uint8_t *salt,
3112 size_t salt_length,
3113 uint8_t *output,
3114 size_t output_size,
3115 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003116{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003117 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003118 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003119 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003120 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003121
Darryl Green5cc689a2018-07-24 15:34:10 +01003122 (void) input;
3123 (void) input_length;
3124 (void) salt;
3125 (void) output;
3126 (void) output_size;
3127
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003128 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003129
Gilles Peskine449bd832023-01-11 14:50:10 +01003130 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3131 return PSA_ERROR_INVALID_ARGUMENT;
3132 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003133
Valerio Setti5bb454a2024-01-15 10:43:16 +01003134 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3136 if (status != PSA_SUCCESS) {
3137 return status;
3138 }
3139 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3140 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003141 status = PSA_ERROR_INVALID_ARGUMENT;
3142 goto exit;
3143 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003144
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003145 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003147 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003148
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003149 status = psa_driver_wrapper_asymmetric_encrypt(
3150 &attributes, slot->key.data, slot->key.bytes,
3151 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003153exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003154 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003155
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003157}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3160 psa_algorithm_t alg,
3161 const uint8_t *input,
3162 size_t input_length,
3163 const uint8_t *salt,
3164 size_t salt_length,
3165 uint8_t *output,
3166 size_t output_size,
3167 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003168{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003169 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003170 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003171 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003172 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003173
Darryl Green5cc689a2018-07-24 15:34:10 +01003174 (void) input;
3175 (void) input_length;
3176 (void) salt;
3177 (void) output;
3178 (void) output_size;
3179
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003180 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003181
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3183 return PSA_ERROR_INVALID_ARGUMENT;
3184 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003185
Valerio Setti5bb454a2024-01-15 10:43:16 +01003186 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003187 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3188 if (status != PSA_SUCCESS) {
3189 return status;
3190 }
3191 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003192 status = PSA_ERROR_INVALID_ARGUMENT;
3193 goto exit;
3194 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003195
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003196 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003198 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003199
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003200 status = psa_driver_wrapper_asymmetric_decrypt(
3201 &attributes, slot->key.data, slot->key.bytes,
3202 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003203 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003204
3205exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003206 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003207
Gilles Peskine449bd832023-01-11 14:50:10 +01003208 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003209}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003210
Paul Elliott9fe12f62022-11-30 19:16:02 +00003211/****************************************************************/
3212/* Asymmetric interruptible cryptography */
3213/****************************************************************/
3214
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003215static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3216
Paul Elliott9fe12f62022-11-30 19:16:02 +00003217void psa_interruptible_set_max_ops(uint32_t max_ops)
3218{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003219 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003220}
3221
3222uint32_t psa_interruptible_get_max_ops(void)
3223{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003224 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003225}
3226
Paul Elliott9fe12f62022-11-30 19:16:02 +00003227uint32_t psa_sign_hash_get_num_ops(
3228 const psa_sign_hash_interruptible_operation_t *operation)
3229{
Paul Elliott296ede92022-12-15 17:00:30 +00003230 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003231}
3232
3233uint32_t psa_verify_hash_get_num_ops(
3234 const psa_verify_hash_interruptible_operation_t *operation)
3235{
Paul Elliott296ede92022-12-15 17:00:30 +00003236 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003237}
3238
Paul Elliott59ad9452022-12-18 15:09:02 +00003239static psa_status_t psa_sign_hash_abort_internal(
3240 psa_sign_hash_interruptible_operation_t *operation)
3241{
3242 if (operation->id == 0) {
3243 /* The object has (apparently) been initialized but it is not (yet)
3244 * in use. It's ok to call abort on such an object, and there's
3245 * nothing to do. */
3246 return PSA_SUCCESS;
3247 }
3248
3249 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3250
3251 status = psa_driver_wrapper_sign_hash_abort(operation);
3252
3253 operation->id = 0;
3254
Paul Elliotte6145dc2023-02-07 12:51:21 +00003255 /* Do not clear either the error_occurred or num_ops elements here as they
3256 * only want to be cleared by the application calling abort, not by abort
3257 * being called at completion of an operation. */
3258
Paul Elliott59ad9452022-12-18 15:09:02 +00003259 return status;
3260}
3261
Paul Elliott9fe12f62022-11-30 19:16:02 +00003262psa_status_t psa_sign_hash_start(
3263 psa_sign_hash_interruptible_operation_t *operation,
3264 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3265 const uint8_t *hash, size_t hash_length)
3266{
3267 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3268 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3269 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003270 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003271
Paul Elliottc9774412023-02-06 15:14:07 +00003272 /* Check that start has not been previously called, or operation has not
3273 * previously errored. */
3274 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003275 return PSA_ERROR_BAD_STATE;
3276 }
3277
Paul Elliott9fe12f62022-11-30 19:16:02 +00003278 status = psa_sign_verify_check_alg(0, alg);
3279 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003280 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003281 return status;
3282 }
3283
3284 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3285 PSA_KEY_USAGE_SIGN_HASH,
3286 alg);
3287
3288 if (status != PSA_SUCCESS) {
3289 goto exit;
3290 }
3291
3292 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3293 status = PSA_ERROR_INVALID_ARGUMENT;
3294 goto exit;
3295 }
3296
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003297 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003298 .core = slot->attr
3299 };
3300
Paul Elliott296ede92022-12-15 17:00:30 +00003301 /* Ensure ops count gets reset, in case of operation re-use. */
3302 operation->num_ops = 0;
3303
Paul Elliott9fe12f62022-11-30 19:16:02 +00003304 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3305 slot->key.data,
3306 slot->key.bytes, alg,
3307 hash, hash_length);
3308exit:
3309
3310 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003311 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003312 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003313 }
3314
Ryan Everett1b70a072024-01-04 10:32:49 +00003315 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003316
Paul Elliottc9774412023-02-06 15:14:07 +00003317 if (unlock_status != PSA_SUCCESS) {
3318 operation->error_occurred = 1;
3319 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003320
Paul Elliottc9774412023-02-06 15:14:07 +00003321 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003322}
3323
3324
3325psa_status_t psa_sign_hash_complete(
3326 psa_sign_hash_interruptible_operation_t *operation,
3327 uint8_t *signature, size_t signature_size,
3328 size_t *signature_length)
3329{
3330 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3331
3332 *signature_length = 0;
3333
Paul Elliottc9774412023-02-06 15:14:07 +00003334 /* Check that start has been called first, and that operation has not
3335 * previously errored. */
3336 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003337 status = PSA_ERROR_BAD_STATE;
3338 goto exit;
3339 }
3340
Paul Elliott096abc42023-02-03 18:33:23 +00003341 /* Immediately reject a zero-length signature buffer. This guarantees that
3342 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003343 if (signature_size == 0) {
3344 status = PSA_ERROR_BUFFER_TOO_SMALL;
3345 goto exit;
3346 }
3347
3348 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3349 signature_size,
3350 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003351
Paul Elliott296ede92022-12-15 17:00:30 +00003352 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003353 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003354
Paul Elliottebe225c2023-02-10 14:32:53 +00003355exit:
3356
Paul Elliott59200a22023-02-21 15:07:40 +00003357 psa_wipe_tag_output_buffer(signature, status, signature_size,
3358 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003359
Paul Elliott53bb3122023-02-10 14:22:22 +00003360 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003361 if (status != PSA_SUCCESS) {
3362 operation->error_occurred = 1;
3363 }
3364
Paul Elliott59ad9452022-12-18 15:09:02 +00003365 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003366 }
3367
3368 return status;
3369}
3370
3371psa_status_t psa_sign_hash_abort(
3372 psa_sign_hash_interruptible_operation_t *operation)
3373{
Paul Elliott59ad9452022-12-18 15:09:02 +00003374 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3375
3376 status = psa_sign_hash_abort_internal(operation);
3377
3378 /* We clear the number of ops done here, so that it is not cleared when
3379 * the operation fails or succeeds, only on manual abort. */
3380 operation->num_ops = 0;
3381
Paul Elliottc9774412023-02-06 15:14:07 +00003382 /* Likewise, failure state. */
3383 operation->error_occurred = 0;
3384
Paul Elliott59ad9452022-12-18 15:09:02 +00003385 return status;
3386}
3387
3388static psa_status_t psa_verify_hash_abort_internal(
3389 psa_verify_hash_interruptible_operation_t *operation)
3390{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003391 if (operation->id == 0) {
3392 /* The object has (apparently) been initialized but it is not (yet)
3393 * in use. It's ok to call abort on such an object, and there's
3394 * nothing to do. */
3395 return PSA_SUCCESS;
3396 }
3397
Paul Elliott59ad9452022-12-18 15:09:02 +00003398 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3399
3400 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003401
3402 operation->id = 0;
3403
Paul Elliotte6145dc2023-02-07 12:51:21 +00003404 /* Do not clear either the error_occurred or num_ops elements here as they
3405 * only want to be cleared by the application calling abort, not by abort
3406 * being called at completion of an operation. */
3407
Paul Elliott59ad9452022-12-18 15:09:02 +00003408 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003409}
3410
3411psa_status_t psa_verify_hash_start(
3412 psa_verify_hash_interruptible_operation_t *operation,
3413 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3414 const uint8_t *hash, size_t hash_length,
3415 const uint8_t *signature, size_t signature_length)
3416{
3417 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3418 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3419 psa_key_slot_t *slot;
3420
Paul Elliottc9774412023-02-06 15:14:07 +00003421 /* Check that start has not been previously called, or operation has not
3422 * previously errored. */
3423 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003424 return PSA_ERROR_BAD_STATE;
3425 }
3426
3427 status = psa_sign_verify_check_alg(0, alg);
3428 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003429 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003430 return status;
3431 }
3432
3433 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3434 PSA_KEY_USAGE_VERIFY_HASH,
3435 alg);
3436
3437 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003438 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003439 return status;
3440 }
3441
3442 psa_key_attributes_t attributes = {
3443 .core = slot->attr
3444 };
3445
Paul Elliott296ede92022-12-15 17:00:30 +00003446 /* Ensure ops count gets reset, in case of operation re-use. */
3447 operation->num_ops = 0;
3448
Paul Elliott9fe12f62022-11-30 19:16:02 +00003449 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3450 slot->key.data,
3451 slot->key.bytes,
3452 alg, hash, hash_length,
3453 signature, signature_length);
3454
3455 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003456 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003457 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003458 }
3459
Ryan Everett1b70a072024-01-04 10:32:49 +00003460 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003461
Paul Elliottc9774412023-02-06 15:14:07 +00003462 if (unlock_status != PSA_SUCCESS) {
3463 operation->error_occurred = 1;
3464 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003465
Paul Elliottc9774412023-02-06 15:14:07 +00003466 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003467}
3468
3469psa_status_t psa_verify_hash_complete(
3470 psa_verify_hash_interruptible_operation_t *operation)
3471{
3472 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3473
Paul Elliottc9774412023-02-06 15:14:07 +00003474 /* Check that start has been called first, and that operation has not
3475 * previously errored. */
3476 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003477 status = PSA_ERROR_BAD_STATE;
3478 goto exit;
3479 }
3480
3481 status = psa_driver_wrapper_verify_hash_complete(operation);
3482
Paul Elliott296ede92022-12-15 17:00:30 +00003483 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003484 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003485 operation);
3486
Paul Elliottebe225c2023-02-10 14:32:53 +00003487exit:
3488
Paul Elliott9fe12f62022-11-30 19:16:02 +00003489 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003490 if (status != PSA_SUCCESS) {
3491 operation->error_occurred = 1;
3492 }
3493
Paul Elliott59ad9452022-12-18 15:09:02 +00003494 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003495 }
3496
3497 return status;
3498}
3499
3500psa_status_t psa_verify_hash_abort(
3501 psa_verify_hash_interruptible_operation_t *operation)
3502{
Paul Elliott59ad9452022-12-18 15:09:02 +00003503 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003504
Paul Elliott59ad9452022-12-18 15:09:02 +00003505 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003506
Paul Elliott59ad9452022-12-18 15:09:02 +00003507 /* We clear the number of ops done here, so that it is not cleared when
3508 * the operation fails or succeeds, only on manual abort. */
3509 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003510
Paul Elliottc9774412023-02-06 15:14:07 +00003511 /* Likewise, failure state. */
3512 operation->error_occurred = 0;
3513
Paul Elliott59ad9452022-12-18 15:09:02 +00003514 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003515}
3516
Paul Elliott588f8ed2022-12-02 18:10:26 +00003517/****************************************************************/
3518/* Asymmetric interruptible cryptography internal */
3519/* implementations */
3520/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003521
Paul Elliott588f8ed2022-12-02 18:10:26 +00003522void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3523{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003524
Paul Elliott588f8ed2022-12-02 18:10:26 +00003525#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3526 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3527 defined(MBEDTLS_ECP_RESTARTABLE)
3528
3529 /* Internal implementation uses zero to indicate infinite number max ops,
3530 * therefore avoid this value, and set to minimum possible. */
3531 if (max_ops == 0) {
3532 max_ops = 1;
3533 }
3534
Paul Elliott588f8ed2022-12-02 18:10:26 +00003535 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003536#else
3537 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003538#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3539 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3540 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3541}
3542
Paul Elliott588f8ed2022-12-02 18:10:26 +00003543uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003544 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003545{
3546#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3547 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3548 defined(MBEDTLS_ECP_RESTARTABLE)
3549
Paul Elliott93d9ca82023-02-15 18:14:21 +00003550 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003551#else
3552 (void) operation;
3553 return 0;
3554#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3555 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3556 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3557}
3558
3559uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003560 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003561{
3562 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3563 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3564 defined(MBEDTLS_ECP_RESTARTABLE)
3565
Paul Elliott93d9ca82023-02-15 18:14:21 +00003566 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003567#else
3568 (void) operation;
3569 return 0;
3570#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3571 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3572 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3573}
3574
3575psa_status_t mbedtls_psa_sign_hash_start(
3576 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3577 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3578 size_t key_buffer_size, psa_algorithm_t alg,
3579 const uint8_t *hash, size_t hash_length)
3580{
3581 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003582 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003583
Paul Elliott068fe072023-01-16 13:59:15 +00003584 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3585 return PSA_ERROR_NOT_SUPPORTED;
3586 }
3587
3588 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003589 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003590 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003591
3592#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003593 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3594 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003595
Paul Elliotta1c94092023-02-15 16:38:04 +00003596 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3597
Paul Elliott93d9ca82023-02-15 18:14:21 +00003598 /* Ensure num_ops is zero'ed in case of context re-use. */
3599 operation->num_ops = 0;
3600
Paul Elliott068fe072023-01-16 13:59:15 +00003601 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3602 attributes->core.bits,
3603 key_buffer,
3604 key_buffer_size,
3605 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003606
Paul Elliott068fe072023-01-16 13:59:15 +00003607 if (status != PSA_SUCCESS) {
3608 return status;
3609 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003610
Paul Elliott1bc59df2023-02-05 13:41:57 +00003611 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003612 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003613
Paul Elliott068fe072023-01-16 13:59:15 +00003614 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003615 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003616 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003617
Paul Elliott0290a762023-02-09 14:30:24 +00003618 /* We only need to store the same length of hash as the private key size
3619 * here, it would be truncated by the internal implementation anyway. */
3620 required_hash_length = (hash_length < operation->coordinate_bytes ?
3621 hash_length : operation->coordinate_bytes);
3622
Paul Elliottba70ad42023-02-15 18:23:53 +00003623 if (required_hash_length > sizeof(operation->hash)) {
3624 /* Shouldn't happen, but better safe than sorry. */
3625 return PSA_ERROR_CORRUPTION_DETECTED;
3626 }
3627
Paul Elliott0290a762023-02-09 14:30:24 +00003628 memcpy(operation->hash, hash, required_hash_length);
3629 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003630
3631 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003632
3633#else
Paul Elliott068fe072023-01-16 13:59:15 +00003634 (void) operation;
3635 (void) key_buffer;
3636 (void) key_buffer_size;
3637 (void) alg;
3638 (void) hash;
3639 (void) hash_length;
3640 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003641 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003642
Paul Elliott068fe072023-01-16 13:59:15 +00003643 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003644#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3645 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3646 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003647}
3648
3649psa_status_t mbedtls_psa_sign_hash_complete(
3650 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3651 uint8_t *signature, size_t signature_size,
3652 size_t *signature_length)
3653{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003654#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3655 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3656 defined(MBEDTLS_ECP_RESTARTABLE)
3657
Paul Elliotta1c94092023-02-15 16:38:04 +00003658 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003659 mbedtls_mpi r;
3660 mbedtls_mpi s;
3661
Paul Elliott46845252023-02-03 14:59:11 +00003662 mbedtls_mpi_init(&r);
3663 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003664
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003665 /* Ensure max_ops is set to the current value (or default). */
3666 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3667
Paul Elliotta1c94092023-02-15 16:38:04 +00003668 if (signature_size < 2 * operation->coordinate_bytes) {
3669 status = PSA_ERROR_BUFFER_TOO_SMALL;
3670 goto exit;
3671 }
3672
Paul Elliott588f8ed2022-12-02 18:10:26 +00003673 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003674
Paul Elliott588f8ed2022-12-02 18:10:26 +00003675#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3676 status = mbedtls_to_psa_error(
3677 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003678 &r,
3679 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003680 &operation->ctx->d,
3681 operation->hash,
3682 operation->hash_length,
3683 operation->md_alg,
3684 mbedtls_psa_get_random,
3685 MBEDTLS_PSA_RANDOM_STATE,
3686 &operation->restart_ctx));
3687#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003688 status = PSA_ERROR_NOT_SUPPORTED;
3689 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003690#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3691 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003692 status = mbedtls_to_psa_error(
3693 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003694 &r,
3695 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003696 &operation->ctx->d,
3697 operation->hash,
3698 operation->hash_length,
3699 mbedtls_psa_get_random,
3700 MBEDTLS_PSA_RANDOM_STATE,
3701 mbedtls_psa_get_random,
3702 MBEDTLS_PSA_RANDOM_STATE,
3703 &operation->restart_ctx));
3704 }
3705
Paul Elliottf8e5b562023-02-19 18:43:45 +00003706 /* Hide the fact that the restart context only holds a delta of number of
3707 * ops done during the last operation, not an absolute value. */
3708 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3709
Paul Elliott724bd252023-02-08 12:35:08 +00003710 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003711 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003712 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003713 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003714 operation->coordinate_bytes)
3715 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003716
3717 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003718 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003719 }
3720
3721 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003722 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003723 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003724 operation->coordinate_bytes,
3725 operation->coordinate_bytes)
3726 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003727
3728 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003729 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003730 }
3731
Paul Elliott1bc59df2023-02-05 13:41:57 +00003732 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003733
Paul Elliott724bd252023-02-08 12:35:08 +00003734 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003735 }
Paul Elliott724bd252023-02-08 12:35:08 +00003736
3737exit:
3738
3739 mbedtls_mpi_free(&r);
3740 mbedtls_mpi_free(&s);
3741 return status;
3742
Paul Elliott588f8ed2022-12-02 18:10:26 +00003743 #else
3744
3745 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003746 (void) signature;
3747 (void) signature_size;
3748 (void) signature_length;
3749
3750 return PSA_ERROR_NOT_SUPPORTED;
3751
3752#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3753 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3754 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3755}
3756
3757psa_status_t mbedtls_psa_sign_hash_abort(
3758 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3759{
3760
3761#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3762 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3763 defined(MBEDTLS_ECP_RESTARTABLE)
3764
3765 if (operation->ctx) {
3766 mbedtls_ecdsa_free(operation->ctx);
3767 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003768 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003769 }
3770
3771 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3772
Paul Elliott93d9ca82023-02-15 18:14:21 +00003773 operation->num_ops = 0;
3774
Paul Elliott588f8ed2022-12-02 18:10:26 +00003775 return PSA_SUCCESS;
3776
3777#else
3778
3779 (void) operation;
3780
3781 return PSA_ERROR_NOT_SUPPORTED;
3782
3783#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3784 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3785 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3786}
3787
3788psa_status_t mbedtls_psa_verify_hash_start(
3789 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3790 const psa_key_attributes_t *attributes,
3791 const uint8_t *key_buffer, size_t key_buffer_size,
3792 psa_algorithm_t alg,
3793 const uint8_t *hash, size_t hash_length,
3794 const uint8_t *signature, size_t signature_length)
3795{
3796 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003797 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003798 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003799
Paul Elliott068fe072023-01-16 13:59:15 +00003800 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3801 return PSA_ERROR_NOT_SUPPORTED;
3802 }
3803
3804 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003805 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003806 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003807
3808#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003809 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3810 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003811
Paul Elliotta1c94092023-02-15 16:38:04 +00003812 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3813 mbedtls_mpi_init(&operation->r);
3814 mbedtls_mpi_init(&operation->s);
3815
Paul Elliott93d9ca82023-02-15 18:14:21 +00003816 /* Ensure num_ops is zero'ed in case of context re-use. */
3817 operation->num_ops = 0;
3818
Paul Elliott068fe072023-01-16 13:59:15 +00003819 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3820 attributes->core.bits,
3821 key_buffer,
3822 key_buffer_size,
3823 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003824
Paul Elliott068fe072023-01-16 13:59:15 +00003825 if (status != PSA_SUCCESS) {
3826 return status;
3827 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003828
Paul Elliottc569fc22023-02-10 13:02:54 +00003829 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003830
Paul Elliott1bc59df2023-02-05 13:41:57 +00003831 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003832 return PSA_ERROR_INVALID_SIGNATURE;
3833 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003834
Paul Elliott068fe072023-01-16 13:59:15 +00003835 status = mbedtls_to_psa_error(
3836 mbedtls_mpi_read_binary(&operation->r,
3837 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003838 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003839
Paul Elliott068fe072023-01-16 13:59:15 +00003840 if (status != PSA_SUCCESS) {
3841 return status;
3842 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003843
Paul Elliott068fe072023-01-16 13:59:15 +00003844 status = mbedtls_to_psa_error(
3845 mbedtls_mpi_read_binary(&operation->s,
3846 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003847 coordinate_bytes,
3848 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003849
Paul Elliott068fe072023-01-16 13:59:15 +00003850 if (status != PSA_SUCCESS) {
3851 return status;
3852 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003853
Paul Elliott2c9843f2023-02-15 17:32:42 +00003854 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003855
Paul Elliott2c9843f2023-02-15 17:32:42 +00003856 if (status != PSA_SUCCESS) {
3857 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003858 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003859
Paul Elliott0290a762023-02-09 14:30:24 +00003860 /* We only need to store the same length of hash as the private key size
3861 * here, it would be truncated by the internal implementation anyway. */
3862 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3863 coordinate_bytes);
3864
Paul Elliottba70ad42023-02-15 18:23:53 +00003865 if (required_hash_length > sizeof(operation->hash)) {
3866 /* Shouldn't happen, but better safe than sorry. */
3867 return PSA_ERROR_CORRUPTION_DETECTED;
3868 }
3869
Paul Elliott0290a762023-02-09 14:30:24 +00003870 memcpy(operation->hash, hash, required_hash_length);
3871 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003872
3873 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003874#else
Paul Elliott068fe072023-01-16 13:59:15 +00003875 (void) operation;
3876 (void) key_buffer;
3877 (void) key_buffer_size;
3878 (void) alg;
3879 (void) hash;
3880 (void) hash_length;
3881 (void) signature;
3882 (void) signature_length;
3883 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003884 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003885 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003886
Paul Elliott068fe072023-01-16 13:59:15 +00003887 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003888#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3889 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3890 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003891}
3892
3893psa_status_t mbedtls_psa_verify_hash_complete(
3894 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3895{
3896
3897#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3898 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3899 defined(MBEDTLS_ECP_RESTARTABLE)
3900
Paul Elliottf8e5b562023-02-19 18:43:45 +00003901 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3902
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003903 /* Ensure max_ops is set to the current value (or default). */
3904 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3905
Paul Elliottf8e5b562023-02-19 18:43:45 +00003906 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003907 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3908 operation->hash,
3909 operation->hash_length,
3910 &operation->ctx->Q,
3911 &operation->r,
3912 &operation->s,
3913 &operation->restart_ctx));
3914
Paul Elliottf8e5b562023-02-19 18:43:45 +00003915 /* Hide the fact that the restart context only holds a delta of number of
3916 * ops done during the last operation, not an absolute value. */
3917 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3918
3919 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003920#else
3921 (void) operation;
3922
3923 return PSA_ERROR_NOT_SUPPORTED;
3924
3925#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3926 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3927 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3928}
3929
3930psa_status_t mbedtls_psa_verify_hash_abort(
3931 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3932{
3933
3934#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3935 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3936 defined(MBEDTLS_ECP_RESTARTABLE)
3937
3938 if (operation->ctx) {
3939 mbedtls_ecdsa_free(operation->ctx);
3940 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003941 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003942 }
3943
3944 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3945
Paul Elliott93d9ca82023-02-15 18:14:21 +00003946 operation->num_ops = 0;
3947
Paul Elliott588f8ed2022-12-02 18:10:26 +00003948 mbedtls_mpi_free(&operation->r);
3949 mbedtls_mpi_free(&operation->s);
3950
3951 return PSA_SUCCESS;
3952
3953#else
3954 (void) operation;
3955
3956 return PSA_ERROR_NOT_SUPPORTED;
3957
3958#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3959 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3960 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3961}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003962
mohammad1603503973b2018-03-12 15:59:30 +02003963/****************************************************************/
3964/* Symmetric cryptography */
3965/****************************************************************/
3966
Gilles Peskine449bd832023-01-11 14:50:10 +01003967static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3968 mbedtls_svc_key_id_t key,
3969 psa_algorithm_t alg,
3970 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003971{
3972 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3973 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01003974 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003975 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3976 PSA_KEY_USAGE_ENCRYPT :
3977 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003978 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02003979
3980 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003981 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01003982 status = PSA_ERROR_BAD_STATE;
3983 goto exit;
3984 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003985
Gilles Peskine449bd832023-01-11 14:50:10 +01003986 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01003987 status = PSA_ERROR_INVALID_ARGUMENT;
3988 goto exit;
3989 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003990
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3992 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003993 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003994 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003995
Ronald Cron49fafa92021-03-10 08:34:23 +01003996 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003997 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003998 * so we only set it (in the driver wrapper) after resources have been
3999 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004000 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004001 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004002 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004004 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 }
4006 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004007
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004008 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004009 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004010 };
4011
Ronald Cronab99ac22020-10-01 16:38:28 +02004012 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 if (cipher_operation == MBEDTLS_ENCRYPT) {
4014 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4015 &attributes,
4016 slot->key.data,
4017 slot->key.bytes,
4018 alg);
4019 } else {
4020 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4021 &attributes,
4022 slot->key.data,
4023 slot->key.bytes,
4024 alg);
4025 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004026
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004027exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 if (status != PSA_SUCCESS) {
4029 psa_cipher_abort(operation);
4030 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004031
Ryan Everett1b70a072024-01-04 10:32:49 +00004032 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004033
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004035}
4036
Gilles Peskine449bd832023-01-11 14:50:10 +01004037psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4038 mbedtls_svc_key_id_t key,
4039 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004040{
Gilles Peskine449bd832023-01-11 14:50:10 +01004041 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004042}
4043
Gilles Peskine449bd832023-01-11 14:50:10 +01004044psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4045 mbedtls_svc_key_id_t key,
4046 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004047{
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004049}
4050
Gilles Peskine449bd832023-01-11 14:50:10 +01004051psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4052 uint8_t *iv,
4053 size_t iv_size,
4054 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004055{
Ronald Cron6d051732020-10-01 14:10:20 +02004056 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004057 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004058 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004059
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004061 status = PSA_ERROR_BAD_STATE;
4062 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004063 }
4064
Gilles Peskine449bd832023-01-11 14:50:10 +01004065 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004066 status = PSA_ERROR_BAD_STATE;
4067 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004068 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004069
Ronald Cron2fb90522021-07-05 12:31:44 +02004070 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004071 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004072 status = PSA_ERROR_BUFFER_TOO_SMALL;
4073 goto exit;
4074 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004075
Gilles Peskine449bd832023-01-11 14:50:10 +01004076 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004077 status = PSA_ERROR_GENERIC_ERROR;
4078 goto exit;
4079 }
4080
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 status = psa_generate_random(local_iv, default_iv_length);
4082 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004083 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 }
Ronald Cron5618a392021-03-26 09:52:26 +01004085
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 status = psa_driver_wrapper_cipher_set_iv(operation,
4087 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004088
4089exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004090 if (status == PSA_SUCCESS) {
4091 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004092 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004093 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004095 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004097 }
Ronald Cron6d051732020-10-01 14:10:20 +02004098
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004100}
4101
Gilles Peskine449bd832023-01-11 14:50:10 +01004102psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4103 const uint8_t *iv,
4104 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004105{
Ronald Cron6d051732020-10-01 14:10:20 +02004106 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004107
Gilles Peskine449bd832023-01-11 14:50:10 +01004108 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004109 status = PSA_ERROR_BAD_STATE;
4110 goto exit;
4111 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004112
Gilles Peskine449bd832023-01-11 14:50:10 +01004113 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004114 status = PSA_ERROR_BAD_STATE;
4115 goto exit;
4116 }
Ronald Crona0d68172021-03-26 10:15:08 +01004117
Gilles Peskine449bd832023-01-11 14:50:10 +01004118 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004119 status = PSA_ERROR_INVALID_ARGUMENT;
4120 goto exit;
4121 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004122
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 status = psa_driver_wrapper_cipher_set_iv(operation,
4124 iv,
4125 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004126
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004127exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004129 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004130 } else {
4131 psa_cipher_abort(operation);
4132 }
4133 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004134}
4135
Gilles Peskine449bd832023-01-11 14:50:10 +01004136psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4137 const uint8_t *input,
4138 size_t input_length,
4139 uint8_t *output,
4140 size_t output_size,
4141 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004142{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004143 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004144
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004146 status = PSA_ERROR_BAD_STATE;
4147 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004148 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004149
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004151 status = PSA_ERROR_BAD_STATE;
4152 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004153 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004154
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 status = psa_driver_wrapper_cipher_update(operation,
4156 input,
4157 input_length,
4158 output,
4159 output_size,
4160 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004161
4162exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 if (status != PSA_SUCCESS) {
4164 psa_cipher_abort(operation);
4165 }
Ronald Cron6d051732020-10-01 14:10:20 +02004166
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004168}
4169
Gilles Peskine449bd832023-01-11 14:50:10 +01004170psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4171 uint8_t *output,
4172 size_t output_size,
4173 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004174{
David Saadab4ecc272019-02-14 13:48:10 +02004175 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004176
Gilles Peskine449bd832023-01-11 14:50:10 +01004177 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004178 status = PSA_ERROR_BAD_STATE;
4179 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004180 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004181
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004183 status = PSA_ERROR_BAD_STATE;
4184 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004185 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004186
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 status = psa_driver_wrapper_cipher_finish(operation,
4188 output,
4189 output_size,
4190 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004191
4192exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 if (status == PSA_SUCCESS) {
4194 return psa_cipher_abort(operation);
4195 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004196 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004198
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004200 }
mohammad1603503973b2018-03-12 15:59:30 +02004201}
4202
Gilles Peskine449bd832023-01-11 14:50:10 +01004203psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004204{
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004206 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004207 * in use. It's ok to call abort on such an object, and there's
4208 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004210 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004211
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004213
Ronald Cron49fafa92021-03-10 08:34:23 +01004214 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004215 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004216 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004217
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004219}
4220
Gilles Peskine449bd832023-01-11 14:50:10 +01004221psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4222 psa_algorithm_t alg,
4223 const uint8_t *input,
4224 size_t input_length,
4225 uint8_t *output,
4226 size_t output_size,
4227 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004228{
4229 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004230 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004231 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004232 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4233 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004234 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004235
Gilles Peskine449bd832023-01-11 14:50:10 +01004236 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004237 status = PSA_ERROR_INVALID_ARGUMENT;
4238 goto exit;
4239 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004240
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4242 PSA_KEY_USAGE_ENCRYPT,
4243 alg);
4244 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004245 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004247
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004248 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004250 };
4251
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4253 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004254 status = PSA_ERROR_GENERIC_ERROR;
4255 goto exit;
4256 }
4257
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 if (default_iv_length > 0) {
4259 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004260 status = PSA_ERROR_BUFFER_TOO_SMALL;
4261 goto exit;
4262 }
4263
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 status = psa_generate_random(local_iv, default_iv_length);
4265 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004266 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004268 }
4269
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004270 status = psa_driver_wrapper_cipher_encrypt(
4271 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004272 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004273 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004275
4276exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004277 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004279 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004280 }
Ronald Cron23919522021-07-08 19:00:07 +02004281
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 if (status == PSA_SUCCESS) {
4283 if (default_iv_length > 0) {
4284 memcpy(output, local_iv, default_iv_length);
4285 }
4286 *output_length += default_iv_length;
4287 } else {
4288 *output_length = 0;
4289 }
4290
4291 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004292}
4293
Gilles Peskine449bd832023-01-11 14:50:10 +01004294psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4295 psa_algorithm_t alg,
4296 const uint8_t *input,
4297 size_t input_length,
4298 uint8_t *output,
4299 size_t output_size,
4300 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004301{
4302 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004303 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004304 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004305 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004306
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004308 status = PSA_ERROR_INVALID_ARGUMENT;
4309 goto exit;
4310 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004311
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4313 PSA_KEY_USAGE_DECRYPT,
4314 alg);
4315 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004316 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004318
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004319 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004321 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004322
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4324 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004325 status = PSA_ERROR_INVALID_ARGUMENT;
4326 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004328 status = PSA_ERROR_INVALID_ARGUMENT;
4329 goto exit;
4330 }
4331
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004332 status = psa_driver_wrapper_cipher_decrypt(
4333 &attributes, slot->key.data, slot->key.bytes,
4334 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004336
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004337exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004338 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004339 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004340 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004342
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004344 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 }
Ronald Cron23919522021-07-08 19:00:07 +02004346
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004348}
4349
4350
mohammad16035955c982018-04-26 00:53:03 +03004351/****************************************************************/
4352/* AEAD */
4353/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004354
Paul Elliottbaff51c2021-09-28 17:44:45 +01004355/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004356static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004357{
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004359}
4360
4361/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004362static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4363 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004364{
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004366
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004368#if defined(PSA_WANT_ALG_GCM)
4369 case PSA_ALG_GCM:
4370 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 * arbitrarily large nonces. Please note that we do not generally
4372 * recommend the usage of nonces of greater length than
4373 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4374 * size, which can then lead to collisions if you encrypt a very
4375 * large number of messages.*/
4376 if (nonce_length != 0) {
4377 return PSA_SUCCESS;
4378 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004379 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004380#endif /* PSA_WANT_ALG_GCM */
4381#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004382 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (nonce_length >= 7 && nonce_length <= 13) {
4384 return PSA_SUCCESS;
4385 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004386 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004387#endif /* PSA_WANT_ALG_CCM */
4388#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004389 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 if (nonce_length == 12) {
4391 return PSA_SUCCESS;
4392 } else if (nonce_length == 8) {
4393 return PSA_ERROR_NOT_SUPPORTED;
4394 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004395 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004396#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004397 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004398 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004400 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004403}
4404
Gilles Peskine449bd832023-01-11 14:50:10 +01004405static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004406{
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4408 return PSA_ERROR_INVALID_ARGUMENT;
4409 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004412}
4413
Gilles Peskine449bd832023-01-11 14:50:10 +01004414psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4415 psa_algorithm_t alg,
4416 const uint8_t *nonce,
4417 size_t nonce_length,
4418 const uint8_t *additional_data,
4419 size_t additional_data_length,
4420 const uint8_t *plaintext,
4421 size_t plaintext_length,
4422 uint8_t *ciphertext,
4423 size_t ciphertext_size,
4424 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004425{
Ronald Cron215633c2021-03-16 17:15:37 +01004426 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4427 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004428
mohammad1603f08a5502018-06-03 15:05:47 +03004429 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004430
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 status = psa_aead_check_algorithm(alg);
4432 if (status != PSA_SUCCESS) {
4433 return status;
4434 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004435
Ronald Cron9a986162021-03-26 12:40:07 +01004436 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4438 if (status != PSA_SUCCESS) {
4439 return status;
4440 }
mohammad16035955c982018-04-26 00:53:03 +03004441
Ronald Cron215633c2021-03-16 17:15:37 +01004442 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004444 };
mohammad16035955c982018-04-26 00:53:03 +03004445
Gilles Peskine449bd832023-01-11 14:50:10 +01004446 status = psa_aead_check_nonce_length(alg, nonce_length);
4447 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004448 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004450
Ronald Cronde822812021-03-17 16:08:20 +01004451 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004452 &attributes, slot->key.data, slot->key.bytes,
4453 alg,
4454 nonce, nonce_length,
4455 additional_data, additional_data_length,
4456 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004458
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4460 memset(ciphertext, 0, ciphertext_size);
4461 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004462
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004463exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004464 psa_unregister_read_under_mutex(slot);
mohammad16035955c982018-04-26 00:53:03 +03004465
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004467}
4468
Gilles Peskine449bd832023-01-11 14:50:10 +01004469psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4470 psa_algorithm_t alg,
4471 const uint8_t *nonce,
4472 size_t nonce_length,
4473 const uint8_t *additional_data,
4474 size_t additional_data_length,
4475 const uint8_t *ciphertext,
4476 size_t ciphertext_length,
4477 uint8_t *plaintext,
4478 size_t plaintext_size,
4479 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004480{
Ronald Cron215633c2021-03-16 17:15:37 +01004481 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4482 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004483
Gilles Peskineee652a32018-06-01 19:23:52 +02004484 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004485
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 status = psa_aead_check_algorithm(alg);
4487 if (status != PSA_SUCCESS) {
4488 return status;
4489 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004490
Ronald Cron9a986162021-03-26 12:40:07 +01004491 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4493 if (status != PSA_SUCCESS) {
4494 return status;
4495 }
mohammad16035955c982018-04-26 00:53:03 +03004496
Ronald Cron215633c2021-03-16 17:15:37 +01004497 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004499 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004500
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 status = psa_aead_check_nonce_length(alg, nonce_length);
4502 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004503 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004505
Ronald Cronde822812021-03-17 16:08:20 +01004506 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004507 &attributes, slot->key.data, slot->key.bytes,
4508 alg,
4509 nonce, nonce_length,
4510 additional_data, additional_data_length,
4511 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004513
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 if (status != PSA_SUCCESS && plaintext_size != 0) {
4515 memset(plaintext, 0, plaintext_size);
4516 }
mohammad160360a64d02018-06-03 17:20:42 +03004517
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004518exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004519 psa_unregister_read_under_mutex(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004520
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 return status;
mohammad16035955c982018-04-26 00:53:03 +03004522}
4523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4525{
4526 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004527
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004529#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004531 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4533 return PSA_ERROR_INVALID_ARGUMENT;
4534 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004535 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004536#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004537
Przemek Stekiel86679c72022-10-06 17:06:56 +02004538#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004540 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4542 return PSA_ERROR_INVALID_ARGUMENT;
4543 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004544 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004545#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004546
Przemek Stekiel86679c72022-10-06 17:06:56 +02004547#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004549 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 if (tag_len != 16) {
4551 return PSA_ERROR_INVALID_ARGUMENT;
4552 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004553 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004554#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004555
4556 default:
4557 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004559 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004561}
4562
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004563/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004564static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4565 int is_encrypt,
4566 mbedtls_svc_key_id_t key,
4567 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004568{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004569 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4570 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4571 psa_key_slot_t *slot = NULL;
4572 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004573 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004574
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 status = psa_aead_check_algorithm(alg);
4576 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004577 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004581 status = PSA_ERROR_BAD_STATE;
4582 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004583 }
4584
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 if (operation->nonce_set || operation->lengths_set ||
4586 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004587 status = PSA_ERROR_BAD_STATE;
4588 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004589 }
4590
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004592 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004594 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004596
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4598 alg);
4599 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004600 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004602
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004603 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004604 .core = slot->attr
4605 };
4606
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004608 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004610
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 if (is_encrypt) {
4612 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4613 &attributes,
4614 slot->key.data,
4615 slot->key.bytes,
4616 alg);
4617 } else {
4618 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4619 &attributes,
4620 slot->key.data,
4621 slot->key.bytes,
4622 alg);
4623 }
4624 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004625 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004627
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004629
4630exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004631 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004632
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004634 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004636 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 } else {
4638 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004639 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004640
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004642}
4643
Paul Elliott302ff6b2021-04-20 18:10:30 +01004644/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004645psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4646 mbedtls_svc_key_id_t key,
4647 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004648{
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004650}
4651
4652/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004653psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4654 mbedtls_svc_key_id_t key,
4655 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004656{
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004658}
4659
4660/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004661psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4662 uint8_t *nonce,
4663 size_t nonce_size,
4664 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004665{
4666 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004667 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004668 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004669
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004670 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004671
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004673 status = PSA_ERROR_BAD_STATE;
4674 goto exit;
4675 }
4676
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004678 status = PSA_ERROR_BAD_STATE;
4679 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004680 }
4681
Paul Elliotte193ea82021-10-01 13:00:16 +01004682 /* For CCM, this size may not be correct according to the PSA
4683 * specification. The PSA Crypto 1.0.1 specification states:
4684 *
4685 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4686 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4687 *
4688 * However this restriction that L has to be the smallest integer is not
4689 * applied in practice, and it is not implementable here since the
4690 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004691 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4692 operation->alg);
4693 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004694 status = PSA_ERROR_BUFFER_TOO_SMALL;
4695 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004696 }
4697
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 status = psa_generate_random(local_nonce, required_nonce_size);
4699 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004700 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004702
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004704
Paul Elliott39dc6b82021-05-11 19:16:09 +01004705exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 if (status == PSA_SUCCESS) {
4707 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004708 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 } else {
4710 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004711 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004712
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004714}
4715
4716/* Set the nonce for a multipart authenticated encryption or decryption
4717 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004718psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4719 const uint8_t *nonce,
4720 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004721{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004722 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4723
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004725 status = PSA_ERROR_BAD_STATE;
4726 goto exit;
4727 }
4728
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004730 status = PSA_ERROR_BAD_STATE;
4731 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004732 }
4733
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4735 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004736 status = PSA_ERROR_INVALID_ARGUMENT;
4737 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004738 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004739
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4741 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004742
Paul Elliott39dc6b82021-05-11 19:16:09 +01004743exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004745 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 } else {
4747 psa_aead_abort(operation);
4748 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004751}
4752
4753/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004754psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4755 size_t ad_length,
4756 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004757{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004758 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4759
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004761 status = PSA_ERROR_BAD_STATE;
4762 goto exit;
4763 }
4764
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 if (operation->lengths_set || operation->ad_started ||
4766 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004767 status = PSA_ERROR_BAD_STATE;
4768 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004769 }
4770
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004772#if defined(PSA_WANT_ALG_GCM)
4773 case PSA_ALG_GCM:
4774 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 * bits. Without the guard this code will generate warnings on 32bit
4776 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004777#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 if (((uint64_t) ad_length) >> 61 != 0 ||
4779 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004780 status = PSA_ERROR_INVALID_ARGUMENT;
4781 goto exit;
4782 }
Paul Elliott325d3742021-09-27 17:56:28 +01004783#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004784 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004785#endif /* PSA_WANT_ALG_GCM */
4786#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004787 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004789 status = PSA_ERROR_INVALID_ARGUMENT;
4790 goto exit;
4791 }
4792 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004793#endif /* PSA_WANT_ALG_CCM */
4794#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004795 case PSA_ALG_CHACHA20_POLY1305:
4796 /* No length restrictions for ChaChaPoly. */
4797 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004798#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004799 default:
4800 break;
4801 }
Paul Elliott325d3742021-09-27 17:56:28 +01004802
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4804 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004805
Paul Elliott39dc6b82021-05-11 19:16:09 +01004806exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004808 operation->ad_remaining = ad_length;
4809 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004810 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 } else {
4812 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004813 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004814
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004816}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004817
4818/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004819psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4820 const uint8_t *input,
4821 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004822{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004823 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4824
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004826 status = PSA_ERROR_BAD_STATE;
4827 goto exit;
4828 }
4829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004831 status = PSA_ERROR_BAD_STATE;
4832 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004833 }
4834
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 if (operation->lengths_set) {
4836 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004837 status = PSA_ERROR_INVALID_ARGUMENT;
4838 goto exit;
4839 }
4840
4841 operation->ad_remaining -= input_length;
4842 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004843#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004845 status = PSA_ERROR_BAD_STATE;
4846 goto exit;
4847 }
4848#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004849
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 status = psa_driver_wrapper_aead_update_ad(operation, input,
4851 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004852
Paul Elliott39dc6b82021-05-11 19:16:09 +01004853exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004855 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 } else {
4857 psa_aead_abort(operation);
4858 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004859
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004861}
4862
4863/* Encrypt or decrypt a message fragment in an active multipart AEAD
4864 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004865psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4866 const uint8_t *input,
4867 size_t input_length,
4868 uint8_t *output,
4869 size_t output_size,
4870 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004871{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004872 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004873
4874 *output_length = 0;
4875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004877 status = PSA_ERROR_BAD_STATE;
4878 goto exit;
4879 }
4880
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004882 status = PSA_ERROR_BAD_STATE;
4883 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004884 }
4885
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004887 /* Additional data length was supplied, but not all the additional
4888 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004890 status = PSA_ERROR_INVALID_ARGUMENT;
4891 goto exit;
4892 }
4893
4894 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004896 status = PSA_ERROR_INVALID_ARGUMENT;
4897 goto exit;
4898 }
4899
4900 operation->body_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(operation, input, input_length,
4910 output, output_size,
4911 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004912
Paul Elliott39dc6b82021-05-11 19:16:09 +01004913exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004915 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 } else {
4917 psa_aead_abort(operation);
4918 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004919
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004921}
4922
Gilles Peskine449bd832023-01-11 14:50:10 +01004923static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004924{
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 if (operation->id == 0 || !operation->nonce_set) {
4926 return PSA_ERROR_BAD_STATE;
4927 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004928
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4930 operation->body_remaining != 0)) {
4931 return PSA_ERROR_INVALID_ARGUMENT;
4932 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004933
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004935}
4936
Paul Elliott302ff6b2021-04-20 18:10:30 +01004937/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004938psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4939 uint8_t *ciphertext,
4940 size_t ciphertext_size,
4941 size_t *ciphertext_length,
4942 uint8_t *tag,
4943 size_t tag_size,
4944 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004945{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004946 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4947
Paul Elliott302ff6b2021-04-20 18:10:30 +01004948 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004949 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004950
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 status = psa_aead_final_checks(operation);
4952 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004953 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004955
Gilles Peskine449bd832023-01-11 14:50:10 +01004956 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004957 status = PSA_ERROR_BAD_STATE;
4958 goto exit;
4959 }
4960
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4962 ciphertext_size,
4963 ciphertext_length,
4964 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004965
Paul Elliott39dc6b82021-05-11 19:16:09 +01004966exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004967
4968
Paul Elliottf47b0952021-05-21 18:02:33 +01004969 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01004970 * the zero tag size, make sure the tag is set to something implausible.
4971 * Even if the operation succeeds, make sure we clear the rest of the
4972 * buffer to prevent potential leakage of anything previously placed in
4973 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00004974 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01004975
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004977
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004979}
4980
4981/* Finish authenticating and decrypting a message in a multipart AEAD
4982 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004983psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
4984 uint8_t *plaintext,
4985 size_t plaintext_size,
4986 size_t *plaintext_length,
4987 const uint8_t *tag,
4988 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004989{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004990 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4991
Paul Elliott302ff6b2021-04-20 18:10:30 +01004992 *plaintext_length = 0;
4993
Gilles Peskine449bd832023-01-11 14:50:10 +01004994 status = psa_aead_final_checks(operation);
4995 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004996 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004998
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005000 status = PSA_ERROR_BAD_STATE;
5001 goto exit;
5002 }
5003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5005 plaintext_size,
5006 plaintext_length,
5007 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005008
5009exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005011
Gilles Peskine449bd832023-01-11 14:50:10 +01005012 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005013}
5014
5015/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005016psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005017{
5018 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5019
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005021 /* The object has (apparently) been initialized but it is not (yet)
5022 * in use. It's ok to call abort on such an object, and there's
5023 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005025 }
5026
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005028
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005030
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005032}
5033
Gilles Peskinee59236f2018-01-27 23:32:46 +01005034/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005035/* Generators */
5036/****************************************************************/
5037
Przemek Stekiel69c46792022-06-10 12:59:51 +02005038#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005039 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005040 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305041 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305042 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005043#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005044#endif /* At least one builtin KDF */
5045
Przemek Stekiel69c46792022-06-10 12:59:51 +02005046#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005047 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5048 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5049static psa_status_t psa_key_derivation_start_hmac(
5050 psa_mac_operation_t *operation,
5051 psa_algorithm_t hash_alg,
5052 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005054{
5055 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5056 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5058 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5059 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005060
Steven Cooreman72f736a2021-05-07 14:14:37 +02005061 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005063
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 status = psa_driver_wrapper_mac_sign_setup(operation,
5065 &attributes,
5066 hmac_key, hmac_key_length,
5067 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005068
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 psa_reset_key_attributes(&attributes);
5070 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005071}
5072#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005073
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005074#define HKDF_STATE_INIT 0 /* no input yet */
5075#define HKDF_STATE_STARTED 1 /* got salt */
5076#define HKDF_STATE_KEYED 2 /* got key */
5077#define HKDF_STATE_OUTPUT 3 /* output started */
5078
Gilles Peskinecbe66502019-05-16 16:59:18 +02005079static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005081{
Gilles Peskine449bd832023-01-11 14:50:10 +01005082 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5083 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5084 } else {
5085 return operation->alg;
5086 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005087}
5088
Gilles Peskine449bd832023-01-11 14:50:10 +01005089psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005090{
5091 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5093 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005094 /* The object has (apparently) been initialized but it is not
5095 * in use. It's ok to call abort on such an object, and there's
5096 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005098#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5100 mbedtls_free(operation->ctx.hkdf.info);
5101 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5102 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005103#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005104#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5105 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5107 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5108 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5109 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005110 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005112 }
5113
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005115 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005117 }
5118
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005120 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005122 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005123#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005125 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005127 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005128#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005129 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005130
5131 /* We leave the fields Ai and output_block to be erased safely by the
5132 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005134#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5135 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005136#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5138 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5139 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5140 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005141#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305142#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305143 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305144 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005145 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305146 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305147 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305148
5149 status = PSA_SUCCESS;
5150 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305151#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005152 {
5153 status = PSA_ERROR_BAD_STATE;
5154 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 mbedtls_platform_zeroize(operation, sizeof(*operation));
5156 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005157}
5158
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005159psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005161{
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005163 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005165 }
5166
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005167 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005169}
5170
Gilles Peskine449bd832023-01-11 14:50:10 +01005171psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5172 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005173{
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 if (operation->alg == 0) {
5175 return PSA_ERROR_BAD_STATE;
5176 }
5177 if (capacity > operation->capacity) {
5178 return PSA_ERROR_INVALID_ARGUMENT;
5179 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005180 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005182}
5183
Przemek Stekiel69c46792022-06-10 12:59:51 +02005184#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005185/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005186static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5187 psa_algorithm_t kdf_alg,
5188 uint8_t *output,
5189 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005190{
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5192 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005193 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005194 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005195#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005197#else
5198 const uint8_t last_block = 0xff;
5199#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005200
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 if (hkdf->state < HKDF_STATE_KEYED ||
5202 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005203#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005205#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 )) {
5207 return PSA_ERROR_BAD_STATE;
5208 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005209 hkdf->state = HKDF_STATE_OUTPUT;
5210
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005212 /* Copy what remains of the current block */
5213 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005215 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005216 }
5217 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005218 output += n;
5219 output_length -= n;
5220 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005222 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005224 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005225 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005226 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005227 * object was corrupted or if this function is called directly
5228 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 if (hkdf->block_number == last_block) {
5230 return PSA_ERROR_BAD_STATE;
5231 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005232
5233 /* We need a new block */
5234 ++hkdf->block_number;
5235 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005236
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5238 hash_alg,
5239 hkdf->prk,
5240 hash_length);
5241 if (status != PSA_SUCCESS) {
5242 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005243 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005244
5245 if (hkdf->block_number != 1) {
5246 status = psa_mac_update(&hkdf->hmac,
5247 hkdf->output_block,
5248 hash_length);
5249 if (status != PSA_SUCCESS) {
5250 return status;
5251 }
5252 }
5253 status = psa_mac_update(&hkdf->hmac,
5254 hkdf->info,
5255 hkdf->info_length);
5256 if (status != PSA_SUCCESS) {
5257 return status;
5258 }
5259 status = psa_mac_update(&hkdf->hmac,
5260 &hkdf->block_number, 1);
5261 if (status != PSA_SUCCESS) {
5262 return status;
5263 }
5264 status = psa_mac_sign_finish(&hkdf->hmac,
5265 hkdf->output_block,
5266 sizeof(hkdf->output_block),
5267 &hmac_output_length);
5268 if (status != PSA_SUCCESS) {
5269 return status;
5270 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005271 }
5272
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005274}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005275#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005276
John Durkop07cc04a2020-11-16 22:08:34 -08005277#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5278 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005279static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5280 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005282{
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5284 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005285 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5286 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005287 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005288
Janos Follath7742fee2019-06-17 12:58:10 +01005289 /* We can't be wanting more output after block 0xff, otherwise
5290 * the capacity check in psa_key_derivation_output_bytes() would have
5291 * prevented this call. It could happen only if the operation
5292 * object was corrupted or if this function is called directly
5293 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 if (tls12_prf->block_number == 0xff) {
5295 return PSA_ERROR_CORRUPTION_DETECTED;
5296 }
Janos Follath7742fee2019-06-17 12:58:10 +01005297
5298 /* We need a new block */
5299 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005300 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005301
5302 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5303 *
5304 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5305 *
5306 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5307 * HMAC_hash(secret, A(2) + seed) +
5308 * HMAC_hash(secret, A(3) + seed) + ...
5309 *
5310 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005311 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005312 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005313 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005314 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005315 * is currently extracted as `output_block` and where i is
5316 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005317 */
5318
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 status = psa_key_derivation_start_hmac(&hmac,
5320 hash_alg,
5321 tls12_prf->secret,
5322 tls12_prf->secret_length);
5323 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005324 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005326
5327 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005328 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005329 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5330 * the variable seed and in this instance means it in the context of the
5331 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 status = psa_mac_update(&hmac,
5333 tls12_prf->label,
5334 tls12_prf->label_length);
5335 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005336 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 }
5338 status = psa_mac_update(&hmac,
5339 tls12_prf->seed,
5340 tls12_prf->seed_length);
5341 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005342 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 }
5344 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005345 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5347 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005348 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005350 }
5351
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 status = psa_mac_sign_finish(&hmac,
5353 tls12_prf->Ai, hash_length,
5354 &hmac_output_length);
5355 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005356 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 }
5358 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005359 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005361
5362 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 status = psa_key_derivation_start_hmac(&hmac,
5364 hash_alg,
5365 tls12_prf->secret,
5366 tls12_prf->secret_length);
5367 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005368 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 }
5370 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5371 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005372 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 }
5374 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5375 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005376 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005377 }
5378 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5379 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005380 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 }
5382 status = psa_mac_sign_finish(&hmac,
5383 tls12_prf->output_block, hash_length,
5384 &hmac_output_length);
5385 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005386 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005388
Janos Follath7742fee2019-06-17 12:58:10 +01005389
5390cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 cleanup_status = psa_mac_abort(&hmac);
5392 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005393 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005395
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005397}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005398
Janos Follath844eb0e2019-06-19 12:10:49 +01005399static psa_status_t psa_key_derivation_tls12_prf_read(
5400 psa_tls12_prf_key_derivation_t *tls12_prf,
5401 psa_algorithm_t alg,
5402 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005404{
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5406 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005407 psa_status_t status;
5408 uint8_t offset, length;
5409
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005411 case PSA_TLS12_PRF_STATE_LABEL_SET:
5412 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5413 break;
5414 case PSA_TLS12_PRF_STATE_OUTPUT:
5415 break;
5416 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005418 }
5419
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005421 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 if (tls12_prf->left_in_block == 0) {
5423 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5424 alg);
5425 if (status != PSA_SUCCESS) {
5426 return status;
5427 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005428
5429 continue;
5430 }
5431
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005433 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005435 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005437
5438 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005440 output += length;
5441 output_length -= length;
5442 tls12_prf->left_in_block -= length;
5443 }
5444
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005446}
John Durkop07cc04a2020-11-16 22:08:34 -08005447#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5448 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005449
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005450#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5451static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5452 psa_tls12_ecjpake_to_pms_t *ecjpake,
5453 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005455{
5456 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005457 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005458
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 if (output_length != 32) {
5460 return PSA_ERROR_INVALID_ARGUMENT;
5461 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005462
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5464 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5465 &output_size);
5466 if (status != PSA_SUCCESS) {
5467 return status;
5468 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005469
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 if (output_size != output_length) {
5471 return PSA_ERROR_GENERIC_ERROR;
5472 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005473
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005475}
5476#endif
5477
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305478#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305479static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5480 psa_pbkdf2_key_derivation_t *pbkdf2,
5481 psa_algorithm_t prf_alg,
5482 uint8_t prf_output_length,
5483 psa_key_attributes_t *attributes)
5484{
5485 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305486 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305487 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305488 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305489 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305490 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305491 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305492
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305493 mac_operation.is_sign = 1;
5494 mac_operation.mac_size = prf_output_length;
5495 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305496
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305497 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5498 attributes,
5499 pbkdf2->password,
5500 pbkdf2->password_length,
5501 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305502 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305503 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305504 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305505 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5506 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305507 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305508 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305509 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305510 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305511 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305512 }
5513 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5514 &mac_output_length);
5515 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305516 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305517 }
5518
5519 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305520 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305521 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305522 }
5523
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305524 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305525
5526 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305527 /* We are passing prf_output_length as mac_size because the driver
5528 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305529 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305530 status = psa_driver_wrapper_mac_compute(attributes,
5531 pbkdf2->password,
5532 pbkdf2->password_length,
5533 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305534 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305535 &mac_output_length);
5536 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305537 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305538 }
5539
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305540 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305541 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305542
5543cleanup:
5544 /* Zeroise buffers to clear sensitive data from memory. */
5545 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5546 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305547}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305548
5549static psa_status_t psa_key_derivation_pbkdf2_read(
5550 psa_pbkdf2_key_derivation_t *pbkdf2,
5551 psa_algorithm_t kdf_alg,
5552 uint8_t *output,
5553 size_t output_length)
5554{
5555 psa_status_t status;
5556 psa_algorithm_t prf_alg;
5557 uint8_t prf_output_length;
5558 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5559 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5560 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5561
5562 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5563 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5564 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5565 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305566 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5567 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305568 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305569 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305570 } else {
5571 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305572 }
5573
5574 switch (pbkdf2->state) {
5575 case PSA_PBKDF2_STATE_PASSWORD_SET:
5576 /* Initially we need a new block so bytes_used is equal to block size*/
5577 pbkdf2->bytes_used = prf_output_length;
5578 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5579 break;
5580 case PSA_PBKDF2_STATE_OUTPUT:
5581 break;
5582 default:
5583 return PSA_ERROR_BAD_STATE;
5584 }
5585
5586 while (output_length != 0) {
5587 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5588 if (n > output_length) {
5589 n = (uint8_t) output_length;
5590 }
5591 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5592 output += n;
5593 output_length -= n;
5594 pbkdf2->bytes_used += n;
5595
5596 if (output_length == 0) {
5597 break;
5598 }
5599
5600 /* We need a new block */
5601 pbkdf2->bytes_used = 0;
5602 pbkdf2->block_number++;
5603
5604 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5605 prf_output_length,
5606 &attributes);
5607 if (status != PSA_SUCCESS) {
5608 return status;
5609 }
5610 }
5611
5612 return PSA_SUCCESS;
5613}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305614#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305615
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005616psa_status_t psa_key_derivation_output_bytes(
5617 psa_key_derivation_operation_t *operation,
5618 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005620{
5621 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005623
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005625 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005627 }
5628
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005630 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005631 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005632 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005633 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005634 goto exit;
5635 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005637 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005638 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005639 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5640 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005641 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005642 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005644 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005645 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005646
Przemek Stekiel69c46792022-06-10 12:59:51 +02005647#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5649 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5650 output, output_length);
5651 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005652#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005653#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5654 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5656 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5657 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5658 kdf_alg, output,
5659 output_length);
5660 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005661#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5662 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005663#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005665 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5667 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005668#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305669#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305670 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305671 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5672 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305673 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305674#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005675
Gilles Peskineeab56e42018-07-12 17:12:33 +02005676 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005677 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005679 }
5680
5681exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005683 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005684 * This allows us to differentiate between exhausted operations and
5685 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5686 * operations. */
5687 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005688 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005689 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005691 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005693}
5694
David Brown7807bf72021-02-09 16:28:23 -07005695#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005696static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005697{
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 if (data_size >= 8) {
5699 mbedtls_des_key_set_parity(data);
5700 }
5701 if (data_size >= 16) {
5702 mbedtls_des_key_set_parity(data + 8);
5703 }
5704 if (data_size >= 24) {
5705 mbedtls_des_key_set_parity(data + 16);
5706 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005707}
David Brown7807bf72021-02-09 16:28:23 -07005708#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005709
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005710/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 * ECC keys on a Weierstrass elliptic curve require the generation
5712 * of a private key which is an integer
5713 * in the range [1, N - 1], where N is the boundary of the private key domain:
5714 * N is the prime p for Diffie-Hellman, or the order of the
5715 * curve’s base point for ECC.
5716 *
5717 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5718 * This function generates the private key using the following process:
5719 *
5720 * 1. Draw a byte string of length ceiling(m/8) bytes.
5721 * 2. If m is not a multiple of 8, set the most significant
5722 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5723 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5724 * 4. If k > N - 2, discard the result and return to step 1.
5725 * 5. Output k + 1 as the private key.
5726 *
5727 * This method allows compliance to NIST standards, specifically the methods titled
5728 * Key-Pair Generation by Testing Candidates in the following publications:
5729 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5730 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5731 * Diffie-Hellman keys.
5732 *
5733 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5734 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5735 *
5736 * Note: Function allocates memory for *data buffer, so given *data should be
5737 * always NULL.
5738 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005739#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5740#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005741static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005742 psa_key_slot_t *slot,
5743 size_t bits,
5744 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005745 uint8_t **data
5746 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005747{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005748 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005749 mbedtls_mpi k;
5750 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005751 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005752 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005753 size_t m;
5754 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005755
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 mbedtls_mpi_init(&k);
5757 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005758
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005759 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005761 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005762 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005763
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005765 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005766 goto cleanup;
5767 }
5768
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005769 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005771
Gilles Peskine449bd832023-01-11 14:50:10 +01005772 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005773
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005774 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005775 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005776 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005777
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005778 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005779
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005780 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005782
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005783 /* Note: This function is always called with *data == NULL and it
5784 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005785 *data = mbedtls_calloc(1, m_bytes);
5786 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005787 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005788 goto cleanup;
5789 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005790
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005792 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005793 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005794 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005796
5797 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005799 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005800 * (8 * ceiling(m/8) - m) bits of the first byte in
5801 * the string to zero.
5802 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005804 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005805 }
5806
5807 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 * big-endian byte string.
5809 */
5810 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005811
5812 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 * Result of comparison is returned. When it indicates error
5814 * then this function is called again.
5815 */
5816 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005817 }
5818
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005819 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5821 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005822cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 if (ret != 0) {
5824 status = mbedtls_to_psa_error(ret);
5825 }
5826 if (status != PSA_SUCCESS) {
5827 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005828 *data = NULL;
5829 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 mbedtls_mpi_free(&k);
5831 mbedtls_mpi_free(&diff_N_2);
5832 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005833}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005834
5835/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5836 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5837 *
5838 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5839 * draw a 32-byte string and process it as specified in
5840 * Elliptic Curves for Security [RFC7748] §5.
5841 *
5842 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5843 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5844 *
5845 * Note: Function allocates memory for *data buffer, so given *data should be
5846 * always NULL.
5847 */
5848
5849static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5850 size_t bits,
5851 psa_key_derivation_operation_t *operation,
5852 uint8_t **data
5853 )
5854{
5855 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005856 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005857
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005859 case 255:
5860 output_length = 32;
5861 break;
5862 case 448:
5863 output_length = 56;
5864 break;
5865 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005867 break;
5868 }
5869
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005871
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 if (*data == NULL) {
5873 return PSA_ERROR_INSUFFICIENT_MEMORY;
5874 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005875
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005877
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005879 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005881
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005883 case 255:
5884 (*data)[0] &= 248;
5885 (*data)[31] &= 127;
5886 (*data)[31] |= 64;
5887 break;
5888 case 448:
5889 (*data)[0] &= 252;
5890 (*data)[55] |= 128;
5891 break;
5892 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005894 break;
5895 }
5896
5897 return status;
5898}
Valerio Setti86587ab2023-06-27 13:09:30 +02005899#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5900static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5901 psa_key_slot_t *slot, size_t bits,
5902 psa_key_derivation_operation_t *operation, uint8_t **data)
5903{
5904 (void) slot;
5905 (void) bits;
5906 (void) operation;
5907 (void) data;
5908 return PSA_ERROR_NOT_SUPPORTED;
5909}
5910
5911static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5912 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5913{
5914 (void) bits;
5915 (void) operation;
5916 (void) data;
5917 return PSA_ERROR_NOT_SUPPORTED;
5918}
5919#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5920#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005921
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005922static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005923 psa_key_slot_t *slot,
5924 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005926{
5927 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005928 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305929 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005930 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005931 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005932
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5934 return PSA_ERROR_INVALID_ARGUMENT;
5935 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005936
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005937#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005938 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5940 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5941 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005942 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5944 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005945 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 }
5947 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005948 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5950 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005951 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005953 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005954 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005955#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005956 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 if (key_type_is_raw_bytes(slot->attr.type)) {
5958 if (bits % 8 != 0) {
5959 return PSA_ERROR_INVALID_ARGUMENT;
5960 }
5961 data = mbedtls_calloc(1, bytes);
5962 if (data == NULL) {
5963 return PSA_ERROR_INSUFFICIENT_MEMORY;
5964 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005965
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 status = psa_key_derivation_output_bytes(operation, data, bytes);
5967 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005968 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 }
David Brown12ca5032021-02-11 11:02:00 -07005970#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 if (slot->attr.type == PSA_KEY_TYPE_DES) {
5972 psa_des_set_key_parity(data, bytes);
5973 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01005974#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 } else {
5976 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005977 }
Ronald Crondd04d422020-11-28 15:14:42 +01005978
Ronald Cronbf33c932020-11-28 18:06:53 +01005979 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005980 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01005982 };
5983
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
5985 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
5986 &storage_size);
5987 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305988 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 }
Archanad8a83dc2021-06-14 10:04:16 +05305990 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 status = psa_allocate_buffer_to_slot(slot, storage_size);
5992 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05305993 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 }
Archanad8a83dc2021-06-14 10:04:16 +05305995
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 status = psa_driver_wrapper_import_key(&attributes,
5997 data, bytes,
5998 slot->key.data,
5999 slot->key.bytes,
6000 &slot->key.bytes, &bits);
6001 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006002 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006004
6005exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 mbedtls_free(data);
6007 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006008}
6009
Gilles Peskine449bd832023-01-11 14:50:10 +01006010psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6011 psa_key_derivation_operation_t *operation,
6012 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006013{
6014 psa_status_t status;
6015 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006016 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006017
Ronald Cron81709fc2020-11-14 12:10:32 +01006018 *key = MBEDTLS_SVC_KEY_ID_INIT;
6019
Gilles Peskine0f84d622019-09-12 19:03:13 +02006020 /* Reject any attempt to create a zero-length key so that we don't
6021 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 if (psa_get_key_bits(attributes) == 0) {
6023 return PSA_ERROR_INVALID_ARGUMENT;
6024 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006025
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 if (operation->alg == PSA_ALG_NONE) {
6027 return PSA_ERROR_BAD_STATE;
6028 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006029
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 if (!operation->can_output_key) {
6031 return PSA_ERROR_NOT_PERMITTED;
6032 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006033
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6035 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006036#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006038 /* Deriving a key in a secure element is not implemented yet. */
6039 status = PSA_ERROR_NOT_SUPPORTED;
6040 }
6041#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 if (status == PSA_SUCCESS) {
6043 status = psa_generate_derived_key_internal(slot,
6044 attributes->core.bits,
6045 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006046 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 if (status == PSA_SUCCESS) {
6048 status = psa_finish_key_creation(slot, driver, key);
6049 }
6050 if (status != PSA_SUCCESS) {
6051 psa_fail_key_creation(slot, driver);
6052 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006053
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006055}
6056
Gilles Peskineeab56e42018-07-12 17:12:33 +02006057
6058
6059/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006060/* Key derivation */
6061/****************************************************************/
6062
Steven Cooreman932ffb72021-02-15 12:14:32 +01006063#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006064static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006065{
6066#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6068 return 1;
6069 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006070#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006071#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6073 return 1;
6074 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006075#endif
6076#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6078 return 1;
6079 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006080#endif
6081#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6083 return 1;
6084 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006085#endif
6086#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6088 return 1;
6089 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006090#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006091#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6093 return 1;
6094 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006095#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306096#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6097 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6098 return 1;
6099 }
6100#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306101#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6102 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6103 return 1;
6104 }
6105#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006107}
6108
Gilles Peskine449bd832023-01-11 14:50:10 +01006109static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006110{
6111 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 psa_status_t status = psa_hash_setup(&operation, alg);
6113 psa_hash_abort(&operation);
6114 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006115}
6116
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306117static psa_status_t psa_key_derivation_set_maximum_capacity(
6118 psa_key_derivation_operation_t *operation,
6119 psa_algorithm_t kdf_alg)
6120{
6121#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6122 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6123 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6124 return PSA_SUCCESS;
6125 }
6126#endif
6127#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
6128 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6129#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05306130 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306131 PSA_KEY_TYPE_AES,
6132 128U,
6133 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306134#else
6135 operation->capacity = SIZE_MAX;
6136#endif
6137 return PSA_SUCCESS;
6138 }
6139#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
6140
6141 /* After this point, if kdf_alg is not valid then value of hash_alg may be
6142 * invalid or meaningless but it does not affect this function */
6143 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
6144 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306145 if (hash_size == 0) {
6146 return PSA_ERROR_NOT_SUPPORTED;
6147 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306148
6149 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6150 * we might fail later, which is somewhat unfriendly and potentially
6151 * risk-prone. */
6152 psa_status_t status = psa_hash_try_support(hash_alg);
6153 if (status != PSA_SUCCESS) {
6154 return status;
6155 }
6156
6157#if defined(PSA_WANT_ALG_HKDF)
6158 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6159 operation->capacity = 255 * hash_size;
6160 } else
6161#endif
6162#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6163 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6164 operation->capacity = hash_size;
6165 } else
6166#endif
6167#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6168 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6169 operation->capacity = 255 * hash_size;
6170 } else
6171#endif
6172#if defined(PSA_WANT_ALG_TLS12_PRF)
6173 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6174 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6175 operation->capacity = SIZE_MAX;
6176 } else
6177#endif
6178#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6179 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6180 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6181 /* Master Secret is always 48 bytes
6182 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6183 operation->capacity = 48U;
6184 } else
6185#endif
6186#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6187 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6188#if (SIZE_MAX > UINT32_MAX)
6189 operation->capacity = UINT32_MAX * hash_size;
6190#else
6191 operation->capacity = SIZE_MAX;
6192#endif
6193 } else
6194#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6195 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306196 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306197 status = PSA_ERROR_NOT_SUPPORTED;
6198 }
6199 return status;
6200}
6201
Gilles Peskine969c5d62019-01-16 15:53:06 +01006202static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006203 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006205{
Janos Follath5fe19732019-06-20 15:09:30 +01006206 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6207 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006209
Gilles Peskine969c5d62019-01-16 15:53:06 +01006210 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 if (!is_kdf_alg_supported(kdf_alg)) {
6212 return PSA_ERROR_NOT_SUPPORTED;
6213 }
John Durkop07cc04a2020-11-16 22:08:34 -08006214
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306215 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6216 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306217 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006218}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006219
Gilles Peskine449bd832023-01-11 14:50:10 +01006220static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006221{
6222#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 if (alg == PSA_ALG_ECDH) {
6224 return PSA_SUCCESS;
6225 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006226#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006227#if defined(PSA_WANT_ALG_FFDH)
6228 if (alg == PSA_ALG_FFDH) {
6229 return PSA_SUCCESS;
6230 }
6231#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006232 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006234}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006235
6236static int psa_key_derivation_allows_free_form_secret_input(
6237 psa_algorithm_t kdf_alg)
6238{
6239#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6240 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6241 return 0;
6242 }
6243#endif
6244 (void) kdf_alg;
6245 return 1;
6246}
John Durkop07cc04a2020-11-16 22:08:34 -08006247#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006248
Gilles Peskine449bd832023-01-11 14:50:10 +01006249psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6250 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006251{
6252 psa_status_t status;
6253
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 if (operation->alg != 0) {
6255 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006256 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006257
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6259 return PSA_ERROR_INVALID_ARGUMENT;
6260 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6261#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6262 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6263 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6264 status = psa_key_agreement_try_support(ka_alg);
6265 if (status != PSA_SUCCESS) {
6266 return status;
6267 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006268 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6269 return PSA_ERROR_INVALID_ARGUMENT;
6270 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6272#else
6273 return PSA_ERROR_NOT_SUPPORTED;
6274#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6275 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6276#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6277 status = psa_key_derivation_setup_kdf(operation, alg);
6278#else
6279 return PSA_ERROR_NOT_SUPPORTED;
6280#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6281 } else {
6282 return PSA_ERROR_INVALID_ARGUMENT;
6283 }
6284
6285 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006286 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 }
6288 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006289}
6290
Przemek Stekiel69c46792022-06-10 12:59:51 +02006291#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006292static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6293 psa_algorithm_t kdf_alg,
6294 psa_key_derivation_step_t step,
6295 const uint8_t *data,
6296 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006297{
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006299 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006301 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006302#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6304 return PSA_ERROR_INVALID_ARGUMENT;
6305 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006306#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006307 if (hkdf->state != HKDF_STATE_INIT) {
6308 return PSA_ERROR_BAD_STATE;
6309 } else {
6310 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6311 hash_alg,
6312 data, data_length);
6313 if (status != PSA_SUCCESS) {
6314 return status;
6315 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006316 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006318 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006319 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006320#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006322 /* We shouldn't be in different state as HKDF_EXPAND only allows
6323 * two inputs: SECRET (this case) and INFO which does not modify
6324 * the state. It could happen only if the hkdf
6325 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006326 if (hkdf->state != HKDF_STATE_INIT) {
6327 return PSA_ERROR_BAD_STATE;
6328 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006329
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006330 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6332 return PSA_ERROR_INVALID_ARGUMENT;
6333 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006334
Gilles Peskine449bd832023-01-11 14:50:10 +01006335 memcpy(hkdf->prk, data, data_length);
6336 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006337#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006338 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006339 /* HKDF: If no salt was provided, use an empty salt.
6340 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006341 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006342#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6344 return PSA_ERROR_BAD_STATE;
6345 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006346#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6348 hash_alg,
6349 NULL, 0);
6350 if (status != PSA_SUCCESS) {
6351 return status;
6352 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006353 hkdf->state = HKDF_STATE_STARTED;
6354 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006355 if (hkdf->state != HKDF_STATE_STARTED) {
6356 return PSA_ERROR_BAD_STATE;
6357 }
6358 status = psa_mac_update(&hkdf->hmac,
6359 data, data_length);
6360 if (status != PSA_SUCCESS) {
6361 return status;
6362 }
6363 status = psa_mac_sign_finish(&hkdf->hmac,
6364 hkdf->prk,
6365 sizeof(hkdf->prk),
6366 &data_length);
6367 if (status != PSA_SUCCESS) {
6368 return status;
6369 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006370 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006371
Gilles Peskine2b522db2019-04-12 15:11:49 +02006372 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006373 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006374#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006376 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006378 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006380#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006381 {
6382 /* Block 0 is empty, and the next block will be
6383 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006385 }
6386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006388 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006389#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006390 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6391 return PSA_ERROR_INVALID_ARGUMENT;
6392 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006393#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006394#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6396 hkdf->state == HKDF_STATE_INIT) {
6397 return PSA_ERROR_BAD_STATE;
6398 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006399#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 if (hkdf->state == HKDF_STATE_OUTPUT) {
6401 return PSA_ERROR_BAD_STATE;
6402 }
6403 if (hkdf->info_set) {
6404 return PSA_ERROR_BAD_STATE;
6405 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006406 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 if (data_length != 0) {
6408 hkdf->info = mbedtls_calloc(1, data_length);
6409 if (hkdf->info == NULL) {
6410 return PSA_ERROR_INSUFFICIENT_MEMORY;
6411 }
6412 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006413 }
6414 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006416 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006418 }
6419}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006420#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006421
John Durkop07cc04a2020-11-16 22:08:34 -08006422#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6423 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006424static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6425 const uint8_t *data,
6426 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006427{
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6429 return PSA_ERROR_BAD_STATE;
6430 }
Janos Follathf08e2652019-06-13 09:05:41 +01006431
Gilles Peskine449bd832023-01-11 14:50:10 +01006432 if (data_length != 0) {
6433 prf->seed = mbedtls_calloc(1, data_length);
6434 if (prf->seed == NULL) {
6435 return PSA_ERROR_INSUFFICIENT_MEMORY;
6436 }
Janos Follathf08e2652019-06-13 09:05:41 +01006437
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006439 prf->seed_length = data_length;
6440 }
Janos Follathf08e2652019-06-13 09:05:41 +01006441
Gilles Peskine43f958b2020-12-13 14:55:14 +01006442 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006443
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006445}
6446
Gilles Peskine449bd832023-01-11 14:50:10 +01006447static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6448 const uint8_t *data,
6449 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006450{
Gilles Peskine449bd832023-01-11 14:50:10 +01006451 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6452 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6453 return PSA_ERROR_BAD_STATE;
6454 }
Janos Follath81550542019-06-13 14:26:34 +01006455
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 if (data_length != 0) {
6457 prf->secret = mbedtls_calloc(1, data_length);
6458 if (prf->secret == NULL) {
6459 return PSA_ERROR_INSUFFICIENT_MEMORY;
6460 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006461
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006463 prf->secret_length = data_length;
6464 }
Janos Follath81550542019-06-13 14:26:34 +01006465
Gilles Peskine43f958b2020-12-13 14:55:14 +01006466 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006467
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006469}
6470
Gilles Peskine449bd832023-01-11 14:50:10 +01006471static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6472 const uint8_t *data,
6473 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006474{
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6476 return PSA_ERROR_BAD_STATE;
6477 }
Janos Follath63028dd2019-06-13 09:15:47 +01006478
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 if (data_length != 0) {
6480 prf->label = mbedtls_calloc(1, data_length);
6481 if (prf->label == NULL) {
6482 return PSA_ERROR_INSUFFICIENT_MEMORY;
6483 }
Janos Follath63028dd2019-06-13 09:15:47 +01006484
Gilles Peskine449bd832023-01-11 14:50:10 +01006485 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006486 prf->label_length = data_length;
6487 }
Janos Follath63028dd2019-06-13 09:15:47 +01006488
Gilles Peskine43f958b2020-12-13 14:55:14 +01006489 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006490
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006492}
6493
Gilles Peskine449bd832023-01-11 14:50:10 +01006494static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6495 psa_key_derivation_step_t step,
6496 const uint8_t *data,
6497 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006498{
Gilles Peskine449bd832023-01-11 14:50:10 +01006499 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006500 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006502 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006504 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006506 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006508 }
6509}
John Durkop07cc04a2020-11-16 22:08:34 -08006510#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6511 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6512
6513#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6514static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6515 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006516 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006518{
6519 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6521 4 + data_length + prf->other_secret_length :
6522 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6525 return PSA_ERROR_INVALID_ARGUMENT;
6526 }
John Durkop07cc04a2020-11-16 22:08:34 -08006527
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 uint8_t *pms = mbedtls_calloc(1, pms_len);
6529 if (pms == NULL) {
6530 return PSA_ERROR_INSUFFICIENT_MEMORY;
6531 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006532 uint8_t *cur = pms;
6533
6534 /* pure-PSK:
6535 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006536 *
6537 * The premaster secret is formed as follows: if the PSK is N octets
6538 * long, concatenate a uint16 with the value N, N zero octets, a second
6539 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006540 *
6541 * mixed-PSK:
6542 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6543 * follows: concatenate a uint16 with the length of the other secret,
6544 * the other secret itself, uint16 with the length of PSK, and the
6545 * PSK itself.
6546 * For details please check:
6547 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6548 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6549 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006550 */
6551
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6553 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6554 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6555 if (prf->other_secret_length != 0) {
6556 memcpy(cur, prf->other_secret, prf->other_secret_length);
6557 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006558 cur += prf->other_secret_length;
6559 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006560 } else {
6561 *cur++ = MBEDTLS_BYTE_1(data_length);
6562 *cur++ = MBEDTLS_BYTE_0(data_length);
6563 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006564 cur += data_length;
6565 }
6566
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 *cur++ = MBEDTLS_BYTE_1(data_length);
6568 *cur++ = MBEDTLS_BYTE_0(data_length);
6569 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006570 cur += data_length;
6571
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006572 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006573
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006574 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006576}
Janos Follath6660f0e2019-06-17 08:44:03 +01006577
Przemek Stekiele47201b2022-04-19 13:53:28 +02006578static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6579 psa_tls12_prf_key_derivation_t *prf,
6580 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006581 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006582{
Gilles Peskine449bd832023-01-11 14:50:10 +01006583 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6584 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006585 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006586
6587 if (data_length != 0) {
6588 prf->other_secret = mbedtls_calloc(1, data_length);
6589 if (prf->other_secret == NULL) {
6590 return PSA_ERROR_INSUFFICIENT_MEMORY;
6591 }
6592
6593 memcpy(prf->other_secret, data, data_length);
6594 prf->other_secret_length = data_length;
6595 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006596 prf->other_secret_length = 0;
6597 }
6598
6599 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6600
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006602}
6603
Janos Follath6660f0e2019-06-17 08:44:03 +01006604static psa_status_t psa_tls12_prf_psk_to_ms_input(
6605 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006606 psa_key_derivation_step_t step,
6607 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006608 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006609{
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006611 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 return psa_tls12_prf_psk_to_ms_set_key(prf,
6613 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006614 break;
6615 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6617 data,
6618 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006619 break;
6620 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006622 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006623
Przemek Stekiele47201b2022-04-19 13:53:28 +02006624 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006625}
John Durkop07cc04a2020-11-16 22:08:34 -08006626#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006627
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006628#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6629static psa_status_t psa_tls12_ecjpake_to_pms_input(
6630 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006631 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006632 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006633 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006634{
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6636 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6637 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006638 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006639
6640 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006641 if (data[0] != 0x04) {
6642 return PSA_ERROR_INVALID_ARGUMENT;
6643 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006644
6645 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006647
Gilles Peskine449bd832023-01-11 14:50:10 +01006648 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006649}
6650#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306651
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306652#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306653static psa_status_t psa_pbkdf2_set_input_cost(
6654 psa_pbkdf2_key_derivation_t *pbkdf2,
6655 psa_key_derivation_step_t step,
6656 uint64_t data)
6657{
6658 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6659 return PSA_ERROR_INVALID_ARGUMENT;
6660 }
6661
6662 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6663 return PSA_ERROR_BAD_STATE;
6664 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306665
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306666 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306667 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306668 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306669
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306670 if (data == 0) {
6671 return PSA_ERROR_INVALID_ARGUMENT;
6672 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306673
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306674 pbkdf2->input_cost = data;
6675 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6676
6677 return PSA_SUCCESS;
6678}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306679
6680static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6681 const uint8_t *data,
6682 size_t data_length)
6683{
Gilles Peskineead17662023-08-20 22:02:51 +02006684 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6685 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6686 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6687 /* Appending to existing salt. No state change. */
6688 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306689 return PSA_ERROR_BAD_STATE;
6690 }
6691
Gilles Peskineca57d782023-07-20 19:08:06 +02006692 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006693 /* Appending an empty string, nothing to do. */
6694 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306695 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306696
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306697 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6698 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306699 return PSA_ERROR_INSUFFICIENT_MEMORY;
6700 }
6701
Gilles Peskineead17662023-08-20 22:02:51 +02006702 if (pbkdf2->salt_length != 0) {
6703 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6704 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306705 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306706 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306707 mbedtls_free(pbkdf2->salt);
6708 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306709 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306710 return PSA_SUCCESS;
6711}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306712
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306713#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306714static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306715 const uint8_t *input,
6716 size_t input_len,
6717 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306718 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306719{
6720 psa_status_t status = PSA_SUCCESS;
6721 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6722 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306723 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306724 } else {
6725 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306726 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306727 }
6728 return status;
6729}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306730#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306731
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306732#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306733static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6734 size_t input_len,
6735 uint8_t *output,
6736 size_t *output_len)
6737{
6738 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306739 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306740 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306741 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306742 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6743 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6744 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306745 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306746 * mac_size as the driver function sets mac_output_length = mac_size
6747 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306748 status = psa_driver_wrapper_mac_compute(&attributes,
6749 zeros, sizeof(zeros),
6750 PSA_ALG_CMAC, input, input_len,
6751 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306752 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6753 128U,
6754 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306755 output_len);
6756 } else {
6757 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306758 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306759 }
6760 return status;
6761}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306762#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306763
6764static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306765 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306766 const uint8_t *data,
6767 size_t data_length)
6768{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306769 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306770 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6771 return PSA_ERROR_BAD_STATE;
6772 }
6773
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306774#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306775 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6776 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6777 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6778 pbkdf2->password,
6779 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306780 } else
6781#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6782#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6783 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306784 status = psa_pbkdf2_cmac_set_password(data, data_length,
6785 pbkdf2->password,
6786 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306787 } else
6788#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6789 {
6790 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306791 }
6792
6793 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6794
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306795 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306796}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306797
6798static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306799 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306800 psa_key_derivation_step_t step,
6801 const uint8_t *data,
6802 size_t data_length)
6803{
6804 switch (step) {
6805 case PSA_KEY_DERIVATION_INPUT_SALT:
6806 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6807 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306808 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306809 default:
6810 return PSA_ERROR_INVALID_ARGUMENT;
6811 }
6812}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306813#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306814
Gilles Peskineb8965192019-09-24 16:21:10 +02006815/** Check whether the given key type is acceptable for the given
6816 * input step of a key derivation.
6817 *
6818 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6819 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6820 * Both secret and non-secret inputs can alternatively have the type
6821 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6822 * that the input was passed as a buffer rather than via a key object.
6823 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006824static int psa_key_derivation_check_input_type(
6825 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006827{
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006829 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 if (key_type == PSA_KEY_TYPE_DERIVE) {
6831 return PSA_SUCCESS;
6832 }
6833 if (key_type == PSA_KEY_TYPE_NONE) {
6834 return PSA_SUCCESS;
6835 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006836 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006837 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 if (key_type == PSA_KEY_TYPE_DERIVE) {
6839 return PSA_SUCCESS;
6840 }
6841 if (key_type == PSA_KEY_TYPE_NONE) {
6842 return PSA_SUCCESS;
6843 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006844 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006845 case PSA_KEY_DERIVATION_INPUT_LABEL:
6846 case PSA_KEY_DERIVATION_INPUT_SALT:
6847 case PSA_KEY_DERIVATION_INPUT_INFO:
6848 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6850 return PSA_SUCCESS;
6851 }
6852 if (key_type == PSA_KEY_TYPE_NONE) {
6853 return PSA_SUCCESS;
6854 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006855 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306856 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6857 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6858 return PSA_SUCCESS;
6859 }
6860 if (key_type == PSA_KEY_TYPE_DERIVE) {
6861 return PSA_SUCCESS;
6862 }
6863 if (key_type == PSA_KEY_TYPE_NONE) {
6864 return PSA_SUCCESS;
6865 }
6866 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006867 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006869}
6870
Janos Follathb80a94e2019-06-12 15:54:46 +01006871static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006872 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006873 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006874 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006875 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006877{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006878 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006880
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 status = psa_key_derivation_check_input_type(step, key_type);
6882 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006883 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006885
Przemek Stekiel69c46792022-06-10 12:59:51 +02006886#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6888 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6889 step, data, data_length);
6890 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006891#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006892#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6894 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6895 step, data, data_length);
6896 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006897#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6898#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6900 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6901 step, data, data_length);
6902 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006903#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006904#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006906 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6908 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006909#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306910#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306911 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306912 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6913 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306914 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306915#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006916 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006917 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006918 (void) data;
6919 (void) data_length;
6920 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006922 }
6923
Gilles Peskine224b0d62019-09-23 18:13:17 +02006924exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 if (status != PSA_SUCCESS) {
6926 psa_key_derivation_abort(operation);
6927 }
6928 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006929}
6930
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306931static psa_status_t psa_key_derivation_input_integer_internal(
6932 psa_key_derivation_operation_t *operation,
6933 psa_key_derivation_step_t step,
6934 uint64_t value)
6935{
6936 psa_status_t status;
6937 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6938
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306939#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306940 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306941 status = psa_pbkdf2_set_input_cost(
6942 &operation->ctx.pbkdf2, step, value);
6943 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306944#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306945 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306946 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306947 (void) value;
6948 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306949 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306950 }
6951
6952 if (status != PSA_SUCCESS) {
6953 psa_key_derivation_abort(operation);
6954 }
6955 return status;
6956}
6957
Janos Follath51f4a0f2019-06-14 11:35:55 +01006958psa_status_t psa_key_derivation_input_bytes(
6959 psa_key_derivation_operation_t *operation,
6960 psa_key_derivation_step_t step,
6961 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006962 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006963{
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 return psa_key_derivation_input_internal(operation, step,
6965 PSA_KEY_TYPE_NONE,
6966 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006967}
6968
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306969psa_status_t psa_key_derivation_input_integer(
6970 psa_key_derivation_operation_t *operation,
6971 psa_key_derivation_step_t step,
6972 uint64_t value)
6973{
6974 return psa_key_derivation_input_integer_internal(operation, step, value);
6975}
6976
Janos Follath51f4a0f2019-06-14 11:35:55 +01006977psa_status_t psa_key_derivation_input_key(
6978 psa_key_derivation_operation_t *operation,
6979 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006980 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006981{
Ronald Cronf95a2b12020-10-22 15:24:49 +02006982 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01006983 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006984 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006985
Ronald Cron5c522922020-11-14 16:35:34 +01006986 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01006987 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
6988 if (status != PSA_SUCCESS) {
6989 psa_key_derivation_abort(operation);
6990 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02006991 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006992
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05306993 /* Passing a key object as a SECRET or PASSWORD input unlocks the
6994 * permission to output to a key object. */
6995 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
6996 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006997 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006999
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 status = psa_key_derivation_input_internal(operation,
7001 step, slot->attr.type,
7002 slot->key.data,
7003 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007004
Ryan Everett1b70a072024-01-04 10:32:49 +00007005 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007006
Gilles Peskine449bd832023-01-11 14:50:10 +01007007 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007008}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007009
7010
7011
7012/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007013/* Key agreement */
7014/****************************************************************/
7015
Gilles Peskine449bd832023-01-11 14:50:10 +01007016psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7017 const uint8_t *key_buffer,
7018 size_t key_buffer_size,
7019 psa_algorithm_t alg,
7020 const uint8_t *peer_key,
7021 size_t peer_key_length,
7022 uint8_t *shared_secret,
7023 size_t shared_secret_size,
7024 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007025{
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007027#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007028 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7030 key_buffer_size, alg,
7031 peer_key, peer_key_length,
7032 shared_secret,
7033 shared_secret_size,
7034 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007035#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007036
7037#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7038 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007039 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007040 peer_key,
7041 peer_key_length,
7042 key_buffer,
7043 key_buffer_size,
7044 shared_secret,
7045 shared_secret_size,
7046 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007047#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7048
Gilles Peskine01d718c2018-09-18 12:01:02 +02007049 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007050 (void) attributes;
7051 (void) key_buffer;
7052 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007053 (void) peer_key;
7054 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007055 (void) shared_secret;
7056 (void) shared_secret_size;
7057 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007059 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007060}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007061
Aditya Deshpande17845b82022-10-13 17:21:01 +01007062/** Internal function for raw key agreement
7063 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007064 * to the driver's implementation if a driver is present.
7065 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007066 * (psa_key_agreement_raw_builtin).
7067 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007068static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7069 psa_key_slot_t *private_key,
7070 const uint8_t *peer_key,
7071 size_t peer_key_length,
7072 uint8_t *shared_secret,
7073 size_t shared_secret_size,
7074 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007075{
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7077 return PSA_ERROR_NOT_SUPPORTED;
7078 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007079
7080 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007082 };
7083
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 return psa_driver_wrapper_key_agreement(&attributes,
7085 private_key->key.data,
7086 private_key->key.bytes, alg,
7087 peer_key, peer_key_length,
7088 shared_secret,
7089 shared_secret_size,
7090 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007091}
7092
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007093/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007094 * to potentially free embedded data structures and wipe confidential data.
7095 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007096static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7097 psa_key_derivation_step_t step,
7098 psa_key_slot_t *private_key,
7099 const uint8_t *peer_key,
7100 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007101{
7102 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007103 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007104 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007106
7107 /* Step 1: run the secret agreement algorithm to generate the shared
7108 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 status = psa_key_agreement_raw_internal(ka_alg,
7110 private_key,
7111 peer_key, peer_key_length,
7112 shared_secret,
7113 sizeof(shared_secret),
7114 &shared_secret_length);
7115 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007116 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007118
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007119 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007120 * the shared secret. A shared secret is permitted wherever a key
7121 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 status = psa_key_derivation_input_internal(operation, step,
7123 PSA_KEY_TYPE_DERIVE,
7124 shared_secret,
7125 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007126exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7128 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007129}
7130
Gilles Peskine449bd832023-01-11 14:50:10 +01007131psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7132 psa_key_derivation_step_t step,
7133 mbedtls_svc_key_id_t private_key,
7134 const uint8_t *peer_key,
7135 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007136{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007137 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007138 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007139 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007140
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7142 return PSA_ERROR_INVALID_ARGUMENT;
7143 }
Ronald Cron5c522922020-11-14 16:35:34 +01007144 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007145 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7146 if (status != PSA_SUCCESS) {
7147 return status;
7148 }
7149 status = psa_key_agreement_internal(operation, step,
7150 slot,
7151 peer_key, peer_key_length);
7152 if (status != PSA_SUCCESS) {
7153 psa_key_derivation_abort(operation);
7154 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007155 /* If a private key has been added as SECRET, we allow the derived
7156 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007158 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007160 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007161
Ryan Everett1b70a072024-01-04 10:32:49 +00007162 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007163
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007165}
7166
Gilles Peskine449bd832023-01-11 14:50:10 +01007167psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7168 mbedtls_svc_key_id_t private_key,
7169 const uint8_t *peer_key,
7170 size_t peer_key_length,
7171 uint8_t *output,
7172 size_t output_size,
7173 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007174{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007175 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007176 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007177 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007178 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007179
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007181 status = PSA_ERROR_INVALID_ARGUMENT;
7182 goto exit;
7183 }
Ronald Cron5c522922020-11-14 16:35:34 +01007184 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7186 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007187 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007189
Gilles Peskine3e561302022-04-14 00:17:15 +02007190 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7191 * for the output size. The PSA specification only guarantees that this
7192 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7193 * but it might be nice to allow smaller buffers if the output fits.
7194 * At the time of writing this comment, with only ECDH implemented,
7195 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7196 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7197 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007198 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007199 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7200 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007201 status = PSA_ERROR_BUFFER_TOO_SMALL;
7202 goto exit;
7203 }
7204
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 status = psa_key_agreement_raw_internal(alg, slot,
7206 peer_key, peer_key_length,
7207 output, output_size,
7208 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007209
7210exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007212 /* If an error happens and is not handled properly, the output
7213 * may be used as a key to protect sensitive data. Arrange for such
7214 * a key to be random, which is likely to result in decryption or
7215 * verification errors. This is better than filling the buffer with
7216 * some constant data such as zeros, which would result in the data
7217 * being protected with a reproducible, easily knowable key.
7218 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007220 *output_length = output_size;
7221 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007222
Ryan Everetta103ec92024-01-31 13:59:57 +00007223 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007224
Gilles Peskine449bd832023-01-11 14:50:10 +01007225 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007226}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007227
7228
Gilles Peskine30524eb2020-11-13 17:02:26 +01007229
Gilles Peskine86a440b2018-11-12 18:39:40 +01007230/****************************************************************/
7231/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007232/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007233
Gilles Peskine672a7712023-04-28 21:00:28 +02007234#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7235#include "entropy_poll.h"
7236#endif
7237
Gilles Peskine30524eb2020-11-13 17:02:26 +01007238/** Initialize the PSA random generator.
7239 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007240static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007241{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007242#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007244#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7245
Gilles Peskine30524eb2020-11-13 17:02:26 +01007246 /* Set default configuration if
7247 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007249 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007250 }
7251 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007252 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007253 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007254
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007256#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7257 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7258 /* The PSA entropy injection feature depends on using NV seed as an entropy
7259 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 mbedtls_entropy_add_source(&rng->entropy,
7261 mbedtls_nv_seed_poll, NULL,
7262 MBEDTLS_ENTROPY_BLOCK_SIZE,
7263 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007264#endif
7265
Gilles Peskine449bd832023-01-11 14:50:10 +01007266 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007267#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007268}
7269
7270/** Deinitialize the PSA random generator.
7271 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007272static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007273{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007274#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007275 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007276#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007277 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7278 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007279#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007280}
7281
7282/** Seed the PSA random generator.
7283 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007284static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007285{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007286#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7287 /* Do nothing: the external RNG seeds itself. */
7288 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007290#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007291 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007292 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7293 drbg_seed, sizeof(drbg_seed) - 1);
7294 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007295#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007296}
7297
Gilles Peskine449bd832023-01-11 14:50:10 +01007298psa_status_t psa_generate_random(uint8_t *output,
7299 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007300{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007301 GUARD_MODULE_INITIALIZED;
7302
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007303#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7304
7305 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007306 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7307 output, output_size,
7308 &output_length);
7309 if (status != PSA_SUCCESS) {
7310 return status;
7311 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007312 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007313 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007314 if (output_length != output_size) {
7315 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7316 }
7317 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007318
7319#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7320
Gilles Peskine449bd832023-01-11 14:50:10 +01007321 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007322 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7324 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7325 output_size);
7326 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7327 output, request_size);
7328 if (ret != 0) {
7329 return mbedtls_to_psa_error(ret);
7330 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007331 output_size -= request_size;
7332 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007333 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007335#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007336}
7337
Gilles Peskine8814fc42020-12-14 15:33:44 +01007338/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007339 *
7340 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7341 * `psa_generate_random(...)`. The state parameter is ignored since the
7342 * PSA API doesn't support passing an explicit state.
7343 *
7344 * In the non-external case, psa_generate_random() calls an
7345 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7346 * and semantics as mbedtls_psa_get_random(). As an optimization,
7347 * instead of doing this back-and-forth between the PSA API and the
7348 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7349 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007350 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007351#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7352int mbedtls_psa_get_random(void *p_rng,
7353 unsigned char *output,
7354 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007355{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007356 /* This function takes a pointer to the RNG state because that's what
7357 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7358 * its own state internally and doesn't let the caller access that state.
7359 * So we just ignore the state parameter, and in practice we'll pass
7360 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007361 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 psa_status_t status = psa_generate_random(output, output_size);
7363 if (status == PSA_SUCCESS) {
7364 return 0;
7365 } else {
7366 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7367 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007368}
7369#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7370
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007371#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007372psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7373 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007374{
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 if (global_data.initialized) {
7376 return PSA_ERROR_NOT_PERMITTED;
7377 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007378
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7380 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7381 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7382 return PSA_ERROR_INVALID_ARGUMENT;
7383 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007384
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007386}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007387#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007388
Ronald Cron3772afe2021-02-08 16:10:05 +01007389/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007390 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007391 * \param type The key type
7392 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007393 *
7394 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007395 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007396 * \retval #PSA_ERROR_INVALID_ARGUMENT
7397 * The size in bits of the key is not valid.
7398 * \retval #PSA_ERROR_NOT_SUPPORTED
7399 * The type and/or the size in bits of the key or the combination of
7400 * the two is not supported.
7401 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007402static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007404{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007406
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 if (key_type_is_raw_bytes(type)) {
7408 status = psa_validate_unstructured_key_bit_size(type, bits);
7409 if (status != PSA_SUCCESS) {
7410 return status;
7411 }
7412 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007413#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7415 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7416 return PSA_ERROR_NOT_SUPPORTED;
7417 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007418 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007419 return PSA_ERROR_NOT_SUPPORTED;
7420 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007421
Ronald Cron01b2aba2020-10-05 09:42:02 +02007422 /* Accept only byte-aligned keys, for the same reasons as
7423 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 if (bits % 8 != 0) {
7425 return PSA_ERROR_NOT_SUPPORTED;
7426 }
7427 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007428#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007429
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007430#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007432 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 return PSA_SUCCESS;
7434 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007435#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007436
Valerio Settia55f0422023-07-10 15:34:41 +02007437#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007438 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007439 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007440 return PSA_ERROR_NOT_SUPPORTED;
7441 }
7442 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007443#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007444 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007446 }
7447
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007449}
7450
Ronald Cron55ed0592020-10-05 10:30:40 +02007451psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007452 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007454{
7455 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007456 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007457
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 if ((attributes->domain_parameters == NULL) &&
7459 (attributes->domain_parameters_size != 0)) {
7460 return PSA_ERROR_INVALID_ARGUMENT;
7461 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007462
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 if (key_type_is_raw_bytes(type)) {
7464 status = psa_generate_random(key_buffer, key_buffer_size);
7465 if (status != PSA_SUCCESS) {
7466 return status;
7467 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007468
David Brown12ca5032021-02-11 11:02:00 -07007469#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 if (type == PSA_KEY_TYPE_DES) {
7471 psa_des_set_key_parity(key_buffer, key_buffer_size);
7472 }
David Brown8107e312021-02-12 08:08:46 -07007473#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007475
Valerio Setti76df8c12023-07-11 14:11:28 +02007476#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7478 return mbedtls_psa_rsa_generate_key(attributes,
7479 key_buffer,
7480 key_buffer_size,
7481 key_buffer_length);
7482 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007483#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007484
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007485#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7487 return mbedtls_psa_ecp_generate_key(attributes,
7488 key_buffer,
7489 key_buffer_size,
7490 key_buffer_length);
7491 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007492#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007493
Valerio Settia55f0422023-07-10 15:34:41 +02007494#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007495 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7496 return mbedtls_psa_ffdh_generate_key(attributes,
7497 key_buffer,
7498 key_buffer_size,
7499 key_buffer_length);
7500 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007501#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007502 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 (void) key_buffer_length;
7504 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007505 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007506
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007508}
Darryl Green0c6575a2018-11-07 16:05:30 +00007509
Gilles Peskine449bd832023-01-11 14:50:10 +01007510psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7511 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007512{
7513 psa_status_t status;
7514 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007515 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007516 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007517
Ronald Cron81709fc2020-11-14 12:10:32 +01007518 *key = MBEDTLS_SVC_KEY_ID_INIT;
7519
Gilles Peskine0f84d622019-09-12 19:03:13 +02007520 /* Reject any attempt to create a zero-length key so that we don't
7521 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 if (psa_get_key_bits(attributes) == 0) {
7523 return PSA_ERROR_INVALID_ARGUMENT;
7524 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007525
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007526 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7528 return PSA_ERROR_INVALID_ARGUMENT;
7529 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007530
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7532 &slot, &driver);
7533 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007534 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 }
Gilles Peskine11792082019-08-06 18:36:36 +02007536
Ronald Cron977c2472020-10-13 08:32:21 +02007537 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307538 * storage ( thus not in the case of generating a key in a secure element
7539 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7540 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 if (slot->key.data == NULL) {
7542 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7543 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007544 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 attributes->core.type, attributes->core.bits);
7546 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007547 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007549
7550 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 attributes->core.type,
7552 attributes->core.bits);
7553 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007554 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 attributes, &key_buffer_size);
7556 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007557 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 }
Ronald Cron977c2472020-10-13 08:32:21 +02007559 }
Ronald Cron977c2472020-10-13 08:32:21 +02007560
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7562 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007563 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 }
Ronald Cron977c2472020-10-13 08:32:21 +02007565 }
7566
Gilles Peskine449bd832023-01-11 14:50:10 +01007567 status = psa_driver_wrapper_generate_key(attributes,
7568 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007569
Gilles Peskine449bd832023-01-11 14:50:10 +01007570 if (status != PSA_SUCCESS) {
7571 psa_remove_key_data_from_memory(slot);
7572 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007573
Gilles Peskine11792082019-08-06 18:36:36 +02007574exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 if (status == PSA_SUCCESS) {
7576 status = psa_finish_key_creation(slot, driver, key);
7577 }
7578 if (status != PSA_SUCCESS) {
7579 psa_fail_key_creation(slot, driver);
7580 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007581
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007583}
7584
Gilles Peskinee59236f2018-01-27 23:32:46 +01007585/****************************************************************/
7586/* Module setup */
7587/****************************************************************/
7588
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007589#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007590psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 void (* entropy_init)(mbedtls_entropy_context *ctx),
7592 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007593{
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7595 return PSA_ERROR_BAD_STATE;
7596 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007597 global_data.rng.entropy_init = entropy_init;
7598 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007600}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007601#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007602
Gilles Peskine449bd832023-01-11 14:50:10 +01007603void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007604{
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007606 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7607 mbedtls_psa_random_free(&global_data.rng);
7608 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007609 /* Wipe all remaining data, including configuration.
7610 * In particular, this sets all state indicator to the value
7611 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007613
7614 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007616}
7617
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007618#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7619/** Recover a transaction that was interrupted by a power failure.
7620 *
7621 * This function is called during initialization, before psa_crypto_init()
7622 * returns. If this function returns a failure status, the initialization
7623 * fails.
7624 */
7625static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007627{
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007629 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7630 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 /* TODO - fall through to the failure case until this
7632 * is implemented.
7633 * https://github.com/ARMmbed/mbed-crypto/issues/218
7634 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007635 default:
7636 /* We found an unsupported transaction in the storage.
7637 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007639 }
7640}
7641#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7642
Gilles Peskine449bd832023-01-11 14:50:10 +01007643psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007644{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007645 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007646
Gilles Peskinec6b69072018-11-20 21:42:52 +01007647 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 if (global_data.initialized != 0) {
7649 return PSA_SUCCESS;
7650 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007651
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007652 /* Init drivers */
7653 status = psa_driver_wrapper_init();
7654 if (status != PSA_SUCCESS) {
7655 goto exit;
7656 }
7657 global_data.drivers_initialized = 1;
7658
Valerio Setti402cfba2023-11-13 10:24:32 +01007659 status = psa_initialize_key_slots();
7660 if (status != PSA_SUCCESS) {
7661 goto exit;
7662 }
7663
Gilles Peskine30524eb2020-11-13 17:02:26 +01007664 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007666 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007667 status = mbedtls_psa_random_seed(&global_data.rng);
7668 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007669 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007670 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007671 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007672
Gilles Peskine4b734222019-07-24 15:56:31 +02007673#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 status = psa_crypto_load_transaction();
7675 if (status == PSA_SUCCESS) {
7676 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7677 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007678 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 }
7680 status = psa_crypto_stop_transaction();
7681 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007682 /* There's no transaction to complete. It's all good. */
7683 status = PSA_SUCCESS;
7684 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007685#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007686
Gilles Peskinec6b69072018-11-20 21:42:52 +01007687 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007688 global_data.initialized = 1;
7689
7690exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 if (status != PSA_SUCCESS) {
7692 mbedtls_psa_crypto_free();
7693 }
7694 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007695}
7696
Yanray Wangffc3c482023-07-11 12:01:04 +08007697#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007698psa_status_t psa_crypto_driver_pake_get_password_len(
7699 const psa_crypto_driver_pake_inputs_t *inputs,
7700 size_t *password_len)
7701{
7702 if (inputs->password_len == 0) {
7703 return PSA_ERROR_BAD_STATE;
7704 }
7705
7706 *password_len = inputs->password_len;
7707
7708 return PSA_SUCCESS;
7709}
7710
7711psa_status_t psa_crypto_driver_pake_get_password(
7712 const psa_crypto_driver_pake_inputs_t *inputs,
7713 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7714{
7715 if (inputs->password_len == 0) {
7716 return PSA_ERROR_BAD_STATE;
7717 }
7718
7719 if (buffer_size < inputs->password_len) {
7720 return PSA_ERROR_BUFFER_TOO_SMALL;
7721 }
7722
7723 memcpy(buffer, inputs->password, inputs->password_len);
7724 *buffer_length = inputs->password_len;
7725
7726 return PSA_SUCCESS;
7727}
7728
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007729psa_status_t psa_crypto_driver_pake_get_user_len(
7730 const psa_crypto_driver_pake_inputs_t *inputs,
7731 size_t *user_len)
7732{
7733 if (inputs->user_len == 0) {
7734 return PSA_ERROR_BAD_STATE;
7735 }
7736
7737 *user_len = inputs->user_len;
7738
7739 return PSA_SUCCESS;
7740}
7741
7742psa_status_t psa_crypto_driver_pake_get_user(
7743 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007744 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007745{
7746 if (inputs->user_len == 0) {
7747 return PSA_ERROR_BAD_STATE;
7748 }
7749
Przemek Stekielc0e62502023-03-14 11:49:36 +01007750 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007751 return PSA_ERROR_BUFFER_TOO_SMALL;
7752 }
7753
Przemek Stekielc0e62502023-03-14 11:49:36 +01007754 memcpy(user_id, inputs->user, inputs->user_len);
7755 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007756
7757 return PSA_SUCCESS;
7758}
7759
7760psa_status_t psa_crypto_driver_pake_get_peer_len(
7761 const psa_crypto_driver_pake_inputs_t *inputs,
7762 size_t *peer_len)
7763{
7764 if (inputs->peer_len == 0) {
7765 return PSA_ERROR_BAD_STATE;
7766 }
7767
7768 *peer_len = inputs->peer_len;
7769
7770 return PSA_SUCCESS;
7771}
7772
7773psa_status_t psa_crypto_driver_pake_get_peer(
7774 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007775 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007776{
7777 if (inputs->peer_len == 0) {
7778 return PSA_ERROR_BAD_STATE;
7779 }
7780
Przemek Stekielc0e62502023-03-14 11:49:36 +01007781 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007782 return PSA_ERROR_BUFFER_TOO_SMALL;
7783 }
7784
Przemek Stekielc0e62502023-03-14 11:49:36 +01007785 memcpy(peer_id, inputs->peer, inputs->peer_len);
7786 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007787
7788 return PSA_SUCCESS;
7789}
7790
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007791psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7792 const psa_crypto_driver_pake_inputs_t *inputs,
7793 psa_pake_cipher_suite_t *cipher_suite)
7794{
7795 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7796 return PSA_ERROR_BAD_STATE;
7797 }
7798
7799 *cipher_suite = inputs->cipher_suite;
7800
7801 return PSA_SUCCESS;
7802}
7803
Neil Armstronga7d08c32022-06-01 18:21:20 +02007804psa_status_t psa_pake_setup(
7805 psa_pake_operation_t *operation,
7806 const psa_pake_cipher_suite_t *cipher_suite)
7807{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007808 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007809
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007810 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007811 status = PSA_ERROR_BAD_STATE;
7812 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007813 }
7814
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007815 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007816 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007817 status = PSA_ERROR_INVALID_ARGUMENT;
7818 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007819 }
7820
Przemek Stekiel51eac532022-12-07 11:04:51 +01007821 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7822
Przemek Stekiele12ed362022-12-21 12:54:46 +01007823 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007824 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7825 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007826 operation->data.inputs.cipher_suite = *cipher_suite;
7827
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007828#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007829 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007830 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007831 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007832
David Horstmann16f01512023-06-14 17:21:07 +01007833 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007834 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007835 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007836#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007837 {
7838 status = PSA_ERROR_NOT_SUPPORTED;
7839 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007840 }
7841
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007842 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7843
Przemek Stekiel51eac532022-12-07 11:04:51 +01007844 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007845exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007846 psa_pake_abort(operation);
7847 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007848}
7849
7850psa_status_t psa_pake_set_password_key(
7851 psa_pake_operation_t *operation,
7852 mbedtls_svc_key_id_t password)
7853{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007854 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007855 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7856 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007857 psa_key_attributes_t attributes;
7858 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007859
Przemek Stekiel51eac532022-12-07 11:04:51 +01007860 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007861 status = PSA_ERROR_BAD_STATE;
7862 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007863 }
7864
Przemek Stekiel6c764412022-11-22 14:05:12 +01007865 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7866 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007867 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007868 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007869 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007870 }
7871
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007872 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007873 .core = slot->attr
7874 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007875
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007876 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007877
Przemek Stekiel51eac532022-12-07 11:04:51 +01007878 if (type != PSA_KEY_TYPE_PASSWORD &&
7879 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7880 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007881 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007882 }
7883
Przemek Stekiel51eac532022-12-07 11:04:51 +01007884 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7885 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007886 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007887 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007888 }
7889
7890 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7891 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007892 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007893exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007894 if (status != PSA_SUCCESS) {
7895 psa_pake_abort(operation);
7896 }
Ryan Everett1b70a072024-01-04 10:32:49 +00007897 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007898 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007899}
7900
7901psa_status_t psa_pake_set_user(
7902 psa_pake_operation_t *operation,
7903 const uint8_t *user_id,
7904 size_t user_id_len)
7905{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007906 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007907
7908 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007909 status = PSA_ERROR_BAD_STATE;
7910 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007911 }
7912
Przemek Stekiel51eac532022-12-07 11:04:51 +01007913 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007914 status = PSA_ERROR_INVALID_ARGUMENT;
7915 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007916 }
7917
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007918 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007919 status = PSA_ERROR_BAD_STATE;
7920 goto exit;
7921 }
7922
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007923 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7924 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007925 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7926 goto exit;
7927 }
7928
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007929 memcpy(operation->data.inputs.user, user_id, user_id_len);
7930 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007931
7932 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007933exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007934 psa_pake_abort(operation);
7935 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007936}
7937
7938psa_status_t psa_pake_set_peer(
7939 psa_pake_operation_t *operation,
7940 const uint8_t *peer_id,
7941 size_t peer_id_len)
7942{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007943 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007944
7945 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007946 status = PSA_ERROR_BAD_STATE;
7947 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007948 }
7949
Przemek Stekiel51eac532022-12-07 11:04:51 +01007950 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007951 status = PSA_ERROR_INVALID_ARGUMENT;
7952 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007953 }
7954
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007955 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007956 status = PSA_ERROR_BAD_STATE;
7957 goto exit;
7958 }
7959
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007960 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7961 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007962 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7963 goto exit;
7964 }
7965
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007966 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7967 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007968
7969 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007970exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007971 psa_pake_abort(operation);
7972 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007973}
7974
7975psa_status_t psa_pake_set_role(
7976 psa_pake_operation_t *operation,
7977 psa_pake_role_t role)
7978{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007979 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007980
Przemek Stekiel51eac532022-12-07 11:04:51 +01007981 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007982 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007983 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007984 }
7985
Przemek Stekiel09104b82023-03-06 14:11:51 +01007986 switch (operation->alg) {
7987#if defined(PSA_WANT_ALG_JPAKE)
7988 case PSA_ALG_JPAKE:
7989 if (role == PSA_PAKE_ROLE_NONE) {
7990 return PSA_SUCCESS;
7991 }
7992 status = PSA_ERROR_INVALID_ARGUMENT;
7993 break;
7994#endif
7995 default:
7996 (void) role;
7997 status = PSA_ERROR_NOT_SUPPORTED;
7998 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007999 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008000exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008001 psa_pake_abort(operation);
8002 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008003}
8004
David Horstmanne7f21e62023-05-12 18:17:21 +01008005/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008006#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008007static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008008 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008009{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008010 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008011 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008012 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008013
David Horstmann024e5c52023-06-14 15:48:21 +01008014 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008015 is_x1 = (stage->outputs < 1);
8016 } else {
8017 is_x1 = (stage->inputs < 1);
8018 }
8019
David Horstmann74a3d8c2023-06-14 18:28:19 +01008020 key_share_step = is_x1 ?
8021 PSA_JPAKE_X1_STEP_KEY_SHARE :
8022 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008023 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008024 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8025 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8026 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8027 } else {
8028 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008029 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008030 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008031}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008032#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008033
Przemek Stekiel2797d372022-12-22 11:19:22 +01008034static psa_status_t psa_pake_complete_inputs(
8035 psa_pake_operation_t *operation)
8036{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008037 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008038 /* Create copy of the inputs on stack as inputs share memory
8039 with the driver context which will be setup by the driver. */
8040 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008041
Przemek Stekielfde11282023-03-13 16:06:09 +01008042 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008043 return PSA_ERROR_BAD_STATE;
8044 }
8045
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008046 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008047 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8048 return PSA_ERROR_BAD_STATE;
8049 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008050 }
8051
Przemek Stekiel18620a32023-01-17 16:34:52 +01008052 /* Clear driver context */
8053 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8054
8055 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008056
8057 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008058 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008059
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008060 /* User and peer are translated to role. */
8061 mbedtls_free(inputs.user);
8062 mbedtls_free(inputs.peer);
8063
Przemek Stekiel2797d372022-12-22 11:19:22 +01008064 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008065#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008066 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008067 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008068 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008069#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008070 {
8071 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008072 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008073 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008074 return status;
8075}
8076
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008077#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008078static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008079 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008080 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008081 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008082{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008083 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8084 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8085 step != PSA_PAKE_STEP_ZK_PROOF) {
8086 return PSA_ERROR_INVALID_ARGUMENT;
8087 }
8088
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008089 psa_jpake_computation_stage_t *computation_stage =
8090 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008091
David Horstmann5da95602023-06-08 15:37:12 +01008092 if (computation_stage->round != PSA_JPAKE_FIRST &&
8093 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008094 return PSA_ERROR_BAD_STATE;
8095 }
8096
David Horstmanne7f21e62023-05-12 18:17:21 +01008097 /* Check that the step we are given is the one we were expecting */
8098 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008099 return PSA_ERROR_BAD_STATE;
8100 }
8101
David Horstmanne7f21e62023-05-12 18:17:21 +01008102 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8103 computation_stage->inputs == 0 &&
8104 computation_stage->outputs == 0) {
8105 /* Start of the round, so function decides whether we are inputting
8106 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008107 computation_stage->io_mode = io_mode;
8108 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008109 /* Middle of the round so the mode we are in must match the function
8110 * called by the user */
8111 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008112 }
8113
8114 return PSA_SUCCESS;
8115}
8116
David Horstmanne7f21e62023-05-12 18:17:21 +01008117static psa_status_t psa_jpake_epilogue(
8118 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008119 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008120{
David Horstmanne7f21e62023-05-12 18:17:21 +01008121 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008122 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008123
David Horstmanne7f21e62023-05-12 18:17:21 +01008124 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8125 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008126 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008127 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008128 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008129 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008130 }
8131 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008132 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008133 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008134 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008135 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008136 }
8137 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008138 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8139 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008140 /* End of a round, move to the next round */
8141 stage->inputs = 0;
8142 stage->outputs = 0;
8143 stage->round++;
8144 }
8145 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008146 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008147 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008148 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008149 return PSA_SUCCESS;
8150}
David Horstmanne7f21e62023-05-12 18:17:21 +01008151
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008152#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008153
Neil Armstronga7d08c32022-06-01 18:21:20 +02008154psa_status_t psa_pake_output(
8155 psa_pake_operation_t *operation,
8156 psa_pake_step_t step,
8157 uint8_t *output,
8158 size_t output_size,
8159 size_t *output_length)
8160{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008161 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008162 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008163 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008164
8165 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008166 status = psa_pake_complete_inputs(operation);
8167 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008168 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008169 }
8170 }
8171
8172 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008173 status = PSA_ERROR_BAD_STATE;
8174 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008175 }
8176
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008177 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008178 status = PSA_ERROR_INVALID_ARGUMENT;
8179 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008180 }
8181
Przemek Stekiele12ed362022-12-21 12:54:46 +01008182 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008183#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008184 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008185 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008186 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008187 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008188 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008189 driver_step = convert_jpake_computation_stage_to_driver_step(
8190 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008191 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008192#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008193 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008194 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008195 status = PSA_ERROR_NOT_SUPPORTED;
8196 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008197 }
8198
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008199 status = psa_driver_wrapper_pake_output(operation, driver_step,
8200 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008201
8202 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008203 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008204 }
8205
8206 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008207#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008208 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008209 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008210 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008211 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008212 }
8213 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008214#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008215 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008216 status = PSA_ERROR_NOT_SUPPORTED;
8217 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008218 }
8219
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008220 return PSA_SUCCESS;
8221exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008222 psa_pake_abort(operation);
8223 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008224}
8225
8226psa_status_t psa_pake_input(
8227 psa_pake_operation_t *operation,
8228 psa_pake_step_t step,
8229 const uint8_t *input,
8230 size_t input_length)
8231{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008232 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008233 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008234 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8235 operation->primitive,
8236 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008237
8238 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008239 status = psa_pake_complete_inputs(operation);
8240 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008241 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008242 }
8243 }
8244
8245 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008246 status = PSA_ERROR_BAD_STATE;
8247 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008248 }
8249
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008250 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008251 status = PSA_ERROR_INVALID_ARGUMENT;
8252 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008253 }
8254
Przemek Stekiele12ed362022-12-21 12:54:46 +01008255 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008256#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008257 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008258 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008259 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008260 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008261 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008262 driver_step = convert_jpake_computation_stage_to_driver_step(
8263 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008264 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008265#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008266 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008267 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008268 status = PSA_ERROR_NOT_SUPPORTED;
8269 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008270 }
8271
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008272 status = psa_driver_wrapper_pake_input(operation, driver_step,
8273 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008274
8275 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008276 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008277 }
8278
8279 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008280#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008281 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008282 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008283 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008284 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008285 }
8286 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008287#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008288 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008289 status = PSA_ERROR_NOT_SUPPORTED;
8290 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008291 }
8292
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008293 return PSA_SUCCESS;
8294exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008295 psa_pake_abort(operation);
8296 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008297}
8298
8299psa_status_t psa_pake_get_implicit_key(
8300 psa_pake_operation_t *operation,
8301 psa_key_derivation_operation_t *output)
8302{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008303 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008304 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008305 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008306 size_t shared_key_len = 0;
8307
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008308 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008309 status = PSA_ERROR_BAD_STATE;
8310 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008311 }
8312
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008313#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008314 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008315 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008316 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008317 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008318 status = PSA_ERROR_BAD_STATE;
8319 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008320 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008321 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008322#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008323 {
8324 status = PSA_ERROR_NOT_SUPPORTED;
8325 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008326 }
8327
Przemek Stekiel0c781802022-11-29 14:53:13 +01008328 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8329 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008330 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008331 &shared_key_len);
8332
8333 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008334 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008335 }
8336
8337 status = psa_key_derivation_input_bytes(output,
8338 PSA_KEY_DERIVATION_INPUT_SECRET,
8339 shared_key,
8340 shared_key_len);
8341
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008342 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008343exit:
8344 abort_status = psa_pake_abort(operation);
8345 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008346}
8347
8348psa_status_t psa_pake_abort(
8349 psa_pake_operation_t *operation)
8350{
Przemek Stekield69dca92023-01-31 19:59:20 +01008351 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008352
Przemek Stekield69dca92023-01-31 19:59:20 +01008353 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008354 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008355 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008356
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008357 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8358 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008359 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008360 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008361 }
8362 if (operation->data.inputs.user != NULL) {
8363 mbedtls_free(operation->data.inputs.user);
8364 }
8365 if (operation->data.inputs.peer != NULL) {
8366 mbedtls_free(operation->data.inputs.peer);
8367 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008368 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008369 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008370
Przemek Stekield69dca92023-01-31 19:59:20 +01008371 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008372}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008373#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008374
Gilles Peskinee59236f2018-01-27 23:32:46 +01008375#endif /* MBEDTLS_PSA_CRYPTO_C */