blob: d53a09da3b8f5eafefbe6fad09782544b6db489c [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 Everett098c6652024-01-03 13:03:36 +0000957 psa_unregister_read(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 Everett098c6652024-01-03 13:03:36 +0000989 psa_unregister_read(*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 Everettc053d962024-01-25 17:56:32 +00001092#if defined(MBEDTLS_THREADING_C)
Ryan Everett763971f2024-01-29 17:13:36 +00001093 /* We cannot unlock between setting the state to PENDING_DELETION
1094 * and destroying the key in storage, as otherwise another thread
1095 * could load the key into a new slot and the key will not be
1096 * fully destroyed. */
Ryan Everettc053d962024-01-25 17:56:32 +00001097 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(
1098 &mbedtls_threading_key_slot_mutex));
1099#endif
Ryan Everett7ed542e2024-01-17 11:39:09 +00001100 /* Set the key slot containing the key description's state to
1101 * PENDING_DELETION. This stops new operations from registering
1102 * to read the slot. Current readers can safely continue to access
1103 * the key within the slot; the last registered reader will
1104 * automatically wipe the slot when they call psa_unregister_read().
1105 * If the key is persistent, we can now delete the copy of the key
1106 * from memory. If the key is opaque, we require the driver to
1107 * deal with the deletion. */
Ryan Everettc053d962024-01-25 17:56:32 +00001108 status = psa_key_slot_state_transition(slot, PSA_SLOT_FULL,
1109 PSA_SLOT_PENDING_DELETION);
1110
1111 if (status != PSA_SUCCESS) {
1112 goto exit;
1113 }
Ronald Cronf2911112020-10-29 17:51:10 +01001114
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001116 /* Refuse the destruction of a read-only key (which may or may not work
1117 * if we attempt it, depending on whether the key is merely read-only
1118 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001119 * Just do the best we can, which is to wipe the copy in memory
1120 * (done in this function's cleanup code). */
1121 overall_status = PSA_ERROR_NOT_PERMITTED;
1122 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001123 }
1124
Gilles Peskine354f7672019-07-12 23:46:38 +02001125#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1127 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001128 /* For a key in a secure element, we need to do three things:
1129 * remove the key file in internal storage, destroy the
1130 * key inside the secure element, and update the driver's
1131 * persistent data. Start a transaction that will encompass these
1132 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001134 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001136 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 status = psa_crypto_save_transaction();
1138 if (status != PSA_SUCCESS) {
1139 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001140 /* We should still try to destroy the key in the secure
1141 * element and the key metadata in storage. This is especially
1142 * important if the error is that the storage is full.
1143 * But how to do it exactly without risking an inconsistent
1144 * state after a reset?
1145 * https://github.com/ARMmbed/mbed-crypto/issues/215
1146 */
1147 overall_status = status;
1148 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001149 }
1150
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 status = psa_destroy_se_key(driver,
1152 psa_key_slot_get_slot_number(slot));
1153 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001154 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001156 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001157#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1158
Darryl Greend49a4992018-06-18 17:27:26 +01001159#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001161 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001162 * The slot will still hold a copy of the key until the last reader
1163 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 status = psa_destroy_persistent_key(slot->attr.id);
1165 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001166 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 }
Darryl Greend49a4992018-06-18 17:27:26 +01001168 }
1169#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001170
Gilles Peskinefc762652019-07-22 19:30:34 +02001171#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 if (driver != NULL) {
1173 status = psa_save_se_persistent_data(driver);
1174 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001175 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 }
1177 status = psa_crypto_stop_transaction();
1178 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001179 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001181 }
1182#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1183
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001184exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001185 /* Unregister from reading the slot. If we are the last active reader
1186 * then this will wipe the slot. */
1187 status = psa_unregister_read(slot);
1188 /* Prioritize CORRUPTION_DETECTED from unregistering over
1189 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001191 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 }
Ryan Everettc053d962024-01-25 17:56:32 +00001193
1194#if defined(MBEDTLS_THREADING_C)
Ryan Everett7fee4f72024-02-09 14:11:27 +00001195 /* Don't overwrite existing errors if the unlock fails. */
1196 status = overall_status;
Ryan Everettc053d962024-01-25 17:56:32 +00001197 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1198 &mbedtls_threading_key_slot_mutex));
1199#endif
1200
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001202}
1203
Valerio Settib2bcedb2023-07-10 11:24:00 +02001204#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001205 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001206static psa_status_t psa_get_rsa_public_exponent(
1207 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001209{
1210 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001211 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001212 uint8_t *buffer = NULL;
1213 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1217 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001218 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 }
1220 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001221 /* It's the default value, which is reported as an empty string,
1222 * so there's nothing to do. */
1223 goto exit;
1224 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 buflen = mbedtls_mpi_size(&mpi);
1227 buffer = mbedtls_calloc(1, buflen);
1228 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001229 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1230 goto exit;
1231 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1233 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001234 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001236 attributes->domain_parameters = buffer;
1237 attributes->domain_parameters_size = buflen;
1238
1239exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001240 mbedtls_mpi_free(&mpi);
1241 if (ret != 0) {
1242 mbedtls_free(buffer);
1243 }
1244 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001245}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001246#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001247 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001248
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001249/** Retrieve all the publicly-accessible attributes of a key.
1250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001251psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1252 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001253{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001254 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001255 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001256 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001257
Gilles Peskine449bd832023-01-11 14:50:10 +01001258 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001259
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1261 if (status != PSA_SUCCESS) {
1262 return status;
1263 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001264
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001265 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1267 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001268
1269#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1271 psa_set_key_slot_number(attributes,
1272 psa_key_slot_get_slot_number(slot));
1273 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001274#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001275
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001277#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1278 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001279 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001280 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001281 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001282 /* TODO: This is a temporary situation where domain parameters are deprecated,
1283 * but we need it for namely generating an RSA key with a non-default exponent.
1284 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001287 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001288
Ronald Cron90857082020-11-25 14:58:33 +01001289 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 slot->attr.type,
1291 slot->key.data,
1292 slot->key.bytes,
1293 &rsa);
1294 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001295 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001297
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 status = psa_get_rsa_public_exponent(rsa,
1299 attributes);
1300 mbedtls_rsa_free(rsa);
1301 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001302 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001303 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001304#else
1305 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1306 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1307 attributes->domain_parameters = NULL;
1308 attributes->domain_parameters_size = SIZE_MAX;
1309 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001310#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1311 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001312 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001313 default:
1314 /* Nothing else to do. */
1315 break;
1316 }
1317
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 if (status != PSA_SUCCESS) {
1319 psa_reset_key_attributes(attributes);
1320 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001321
Ryan Everett1b70a072024-01-04 10:32:49 +00001322 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001323
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001325}
1326
Gilles Peskinec8000c02019-08-02 20:15:51 +02001327#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1328psa_status_t psa_get_key_slot_number(
1329 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001331{
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001333 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 return PSA_SUCCESS;
1335 } else {
1336 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001337 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001338}
1339#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1340
Gilles Peskine449bd832023-01-11 14:50:10 +01001341static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1342 size_t key_buffer_size,
1343 uint8_t *data,
1344 size_t data_size,
1345 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001346{
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 if (key_buffer_size > data_size) {
1348 return PSA_ERROR_BUFFER_TOO_SMALL;
1349 }
1350 memcpy(data, key_buffer, key_buffer_size);
1351 memset(data + key_buffer_size, 0,
1352 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001353 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001355}
1356
Ronald Cron7285cda2020-11-26 14:46:37 +01001357psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001358 const psa_key_attributes_t *attributes,
1359 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001361{
Ronald Crond18b5f82020-11-25 16:46:05 +01001362 psa_key_type_t type = attributes->core.type;
1363
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 if (key_type_is_raw_bytes(type) ||
1365 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001366 PSA_KEY_TYPE_IS_ECC(type) ||
1367 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 return psa_export_key_buffer_internal(
1369 key_buffer, key_buffer_size,
1370 data, data_size, data_length);
1371 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001372 /* This shouldn't happen in the reference implementation, but
1373 it is valid for a special-purpose implementation to omit
1374 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001375 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001376 }
1377}
1378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1380 uint8_t *data,
1381 size_t data_size,
1382 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001383{
1384 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1385 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1386 psa_key_slot_t *slot;
1387
Ronald Crone907e552021-01-18 13:22:38 +01001388 /* Reject a zero-length output buffer now, since this can never be a
1389 * valid key representation. This way we know that data must be a valid
1390 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 if (data_size == 0) {
1392 return PSA_ERROR_BUFFER_TOO_SMALL;
1393 }
Ronald Crone907e552021-01-18 13:22:38 +01001394
Ronald Cron9486f9d2020-11-26 13:36:23 +01001395 /* Set the key to empty now, so that even when there are errors, we always
1396 * set data_length to a value between 0 and data_size. On error, setting
1397 * the key to empty is a good choice because an empty key representation is
1398 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001399 *data_length = 0;
1400
Ronald Cron9486f9d2020-11-26 13:36:23 +01001401 /* Export requires the EXPORT flag. There is an exception for public keys,
1402 * which don't require any flag, but
1403 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1404 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1406 PSA_KEY_USAGE_EXPORT, 0);
1407 if (status != PSA_SUCCESS) {
1408 return status;
1409 }
mohammad160306e79202018-03-28 13:17:44 +03001410
Ronald Crond18b5f82020-11-25 16:46:05 +01001411 psa_key_attributes_t attributes = {
1412 .core = slot->attr
1413 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 status = psa_driver_wrapper_export_key(&attributes,
1415 slot->key.data, slot->key.bytes,
1416 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001417
Ryan Everett1b70a072024-01-04 10:32:49 +00001418 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001421}
1422
Ronald Cron7285cda2020-11-26 14:46:37 +01001423psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001424 const psa_key_attributes_t *attributes,
1425 const uint8_t *key_buffer,
1426 size_t key_buffer_size,
1427 uint8_t *data,
1428 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001430{
Ronald Crond18b5f82020-11-25 16:46:05 +01001431 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001432
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001433 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001434 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1435 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001436 /* Exporting public -> public */
1437 return psa_export_key_buffer_internal(
1438 key_buffer, key_buffer_size,
1439 data, data_size, data_length);
1440 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001441#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001442 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1443 return mbedtls_psa_rsa_export_public_key(attributes,
1444 key_buffer,
1445 key_buffer_size,
1446 data,
1447 data_size,
1448 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001449#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001450 /* We don't know how to convert a private RSA key to public. */
1451 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001452#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001453 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001454 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001455#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001456 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1457 return mbedtls_psa_ecp_export_public_key(attributes,
1458 key_buffer,
1459 key_buffer_size,
1460 data,
1461 data_size,
1462 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001463#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001464 /* We don't know how to convert a private ECC key to public */
1465 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001466#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001467 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001468 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001469#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001470 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001471 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001472 key_buffer,
1473 key_buffer_size,
1474 data, data_size,
1475 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001476#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001477 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001478#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001479 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001481 (void) key_buffer;
1482 (void) key_buffer_size;
1483 (void) data;
1484 (void) data_size;
1485 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001487 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001488}
Ronald Crond18b5f82020-11-25 16:46:05 +01001489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1491 uint8_t *data,
1492 size_t data_size,
1493 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001494{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001495 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001496 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001497 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001498 psa_key_attributes_t attributes;
Darryl Greendd8fb772018-11-07 16:00:44 +00001499
Ronald Crone907e552021-01-18 13:22:38 +01001500 /* Reject a zero-length output buffer now, since this can never be a
1501 * valid key representation. This way we know that data must be a valid
1502 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 if (data_size == 0) {
1504 return PSA_ERROR_BUFFER_TOO_SMALL;
1505 }
Ronald Crone907e552021-01-18 13:22:38 +01001506
Darryl Greendd8fb772018-11-07 16:00:44 +00001507 /* Set the key to empty now, so that even when there are errors, we always
1508 * set data_length to a value between 0 and data_size. On error, setting
1509 * the key to empty is a good choice because an empty key representation is
1510 * unlikely to be accepted anywhere. */
1511 *data_length = 0;
1512
1513 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1515 if (status != PSA_SUCCESS) {
1516 return status;
1517 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001518
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1520 status = PSA_ERROR_INVALID_ARGUMENT;
1521 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001522 }
1523
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001524 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001525 .core = slot->attr
1526 };
Ronald Cron67227982020-11-26 15:16:05 +01001527 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001528 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001530
1531exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001532 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001535}
1536
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001537MBEDTLS_STATIC_ASSERT(
1538 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1539 "One or more key attribute flag is listed as both external-only and dual-use")
1540MBEDTLS_STATIC_ASSERT(
1541 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1542 "One or more key attribute flag is listed as both internal-only and dual-use")
1543MBEDTLS_STATIC_ASSERT(
1544 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1545 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001546
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001547/** Validate that a key policy is internally well-formed.
1548 *
1549 * This function only rejects invalid policies. It does not validate the
1550 * consistency of the policy with respect to other attributes of the key
1551 * such as the key type.
1552 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001553static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001554{
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1556 PSA_KEY_USAGE_COPY |
1557 PSA_KEY_USAGE_ENCRYPT |
1558 PSA_KEY_USAGE_DECRYPT |
1559 PSA_KEY_USAGE_SIGN_MESSAGE |
1560 PSA_KEY_USAGE_VERIFY_MESSAGE |
1561 PSA_KEY_USAGE_SIGN_HASH |
1562 PSA_KEY_USAGE_VERIFY_HASH |
1563 PSA_KEY_USAGE_VERIFY_DERIVATION |
1564 PSA_KEY_USAGE_DERIVE)) != 0) {
1565 return PSA_ERROR_INVALID_ARGUMENT;
1566 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001567
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001569}
1570
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001571/** Validate the internal consistency of key attributes.
1572 *
1573 * This function only rejects invalid attribute values. If does not
1574 * validate the consistency of the attributes with any key data that may
1575 * be involved in the creation of the key.
1576 *
1577 * Call this function early in the key creation process.
1578 *
1579 * \param[in] attributes Key attributes for the new key.
1580 * \param[out] p_drv On any return, the driver for the key, if any.
1581 * NULL for a transparent key.
1582 *
1583 */
1584static psa_status_t psa_validate_key_attributes(
1585 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001587{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001588 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1590 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 status = psa_validate_key_location(lifetime, p_drv);
1593 if (status != PSA_SUCCESS) {
1594 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001595 }
1596
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 status = psa_validate_key_persistence(lifetime);
1598 if (status != PSA_SUCCESS) {
1599 return status;
1600 }
1601
1602 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1603 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1604 return PSA_ERROR_INVALID_ARGUMENT;
1605 }
1606 } else {
1607 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1608 return PSA_ERROR_INVALID_ARGUMENT;
1609 }
1610 }
1611
1612 status = psa_validate_key_policy(&attributes->core.policy);
1613 if (status != PSA_SUCCESS) {
1614 return status;
1615 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001616
1617 /* Refuse to create overly large keys.
1618 * Note that this doesn't trigger on import if the attributes don't
1619 * explicitly specify a size (so psa_get_key_bits returns 0), so
1620 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1622 return PSA_ERROR_NOT_SUPPORTED;
1623 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001624
Gilles Peskine91e8c332019-08-02 19:19:39 +02001625 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001626 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1627 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1628 return PSA_ERROR_INVALID_ARGUMENT;
1629 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001632}
1633
Gilles Peskine4747d192019-04-17 15:05:45 +02001634/** Prepare a key slot to receive key material.
1635 *
1636 * This function allocates a key slot and sets its metadata.
1637 *
1638 * If this function fails, call psa_fail_key_creation().
1639 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001640 * This function is intended to be used as follows:
1641 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001642 * it with the specified attributes, and in case of a volatile key assign it
1643 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001644 * -# Populate the slot with the key material.
1645 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1646 * In case of failure at any step, stop the sequence and call
1647 * psa_fail_key_creation().
1648 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001649 * On success, the key slot's state is PSA_SLOT_FILLING.
1650 * It is the responsibility of the caller to change the slot's state to
1651 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001652 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001653 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001654 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001655 * \param[out] p_slot On success, a pointer to the prepared slot.
1656 * \param[out] p_drv On any return, the driver for the key, if any.
1657 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001658 *
1659 * \retval #PSA_SUCCESS
1660 * The key slot is ready to receive key material.
1661 * \return If this function fails, the key slot is an invalid state.
1662 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001663 */
1664static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001665 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001666 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001667 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001668 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001669{
1670 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001671 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001672 psa_key_slot_t *slot;
1673
Gilles Peskinedf179142019-07-15 22:02:14 +02001674 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001675 *p_drv = NULL;
1676
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 status = psa_validate_key_attributes(attributes, p_drv);
1678 if (status != PSA_SUCCESS) {
1679 return status;
1680 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001681
Ryan Everettb69118e2024-01-02 15:54:32 +00001682 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 if (status != PSA_SUCCESS) {
1684 return status;
1685 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001686 slot = *p_slot;
1687
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001688 /* We're storing the declared bit-size of the key. It's up to each
1689 * creation mechanism to verify that this information is correct.
1690 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001691 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001692 * is optional (import, copy). In case of a volatile key, assign it the
1693 * volatile key identifier associated to the slot returned to contain its
1694 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001695
1696 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001698#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1699 slot->attr.id = volatile_key_id;
1700#else
1701 slot->attr.id.key_id = volatile_key_id;
1702#endif
1703 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001704
Gilles Peskine91e8c332019-08-02 19:19:39 +02001705 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001706 * external-only flags, query `attributes`. Thanks to the check
1707 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001708 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001709 * may have set. */
1710 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001711
Gilles Peskinecbaff462019-07-12 23:46:04 +02001712#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001713 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001714 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001715 * create the key file in internal storage, create the
1716 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001717 * persistent data. This is done by starting a transaction that will
1718 * encompass these three actions.
1719 * For registering a volatile key, we just need to find an appropriate
1720 * slot number inside the SE. Since the key is designated volatile, creating
1721 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001722 /* The first thing to do is to find a slot number for the new key.
1723 * We save the slot number in persistent storage as part of the
1724 * transaction data. It will be needed to recover if the power
1725 * fails during the key creation process, to clean up on the secure
1726 * element side after restarting. Obtaining a slot number from the
1727 * secure element driver updates its persistent state, but we do not yet
1728 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001729 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001731 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1733 &slot_number);
1734 if (status != PSA_SUCCESS) {
1735 return status;
1736 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1739 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001740 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001741 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001742 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 status = psa_crypto_save_transaction();
1744 if (status != PSA_SUCCESS) {
1745 (void) psa_crypto_stop_transaction();
1746 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001747 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001748 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001749
1750 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001752 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001753
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001755 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001757 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001758#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001761}
Gilles Peskine4747d192019-04-17 15:05:45 +02001762
1763/** Finalize the creation of a key once its key material has been set.
1764 *
1765 * This entails writing the key to persistent storage.
1766 *
1767 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001768 * See the documentation of psa_start_key_creation() for the intended use
1769 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001770 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001771 * If the finalization succeeds, the function sets the key slot's state to
1772 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1773 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001774 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001775 * \param[in,out] slot Pointer to the slot with key material.
1776 * \param[in] driver The secure element driver for the key,
1777 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001778 * \param[out] key On success, identifier of the key. Note that the
1779 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001780 *
1781 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001782 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001783 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1784 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1785 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1786 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1787 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1788 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001789 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001790 * \return If this function fails, the key slot is an invalid state.
1791 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001792 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001793static psa_status_t psa_finish_key_creation(
1794 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001795 psa_se_drv_table_entry_t *driver,
1796 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001797{
1798 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001799 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001800 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001801
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001802#if defined(MBEDTLS_THREADING_C)
1803 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1804 &mbedtls_threading_key_slot_mutex));
1805#endif
1806
Gilles Peskine4747d192019-04-17 15:05:45 +02001807#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001809#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001811 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001812 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001814
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001815 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1816 sizeof(data.slot_number),
1817 "Slot number size does not match psa_se_key_data_storage_t");
1818
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1820 status = psa_save_persistent_key(&slot->attr,
1821 (uint8_t *) &data,
1822 sizeof(data));
1823 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001824#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1825 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001826 /* Key material is saved in export representation in the slot, so
1827 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 status = psa_save_persistent_key(&slot->attr,
1829 slot->key.data,
1830 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001831 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001832 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001833#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1834
Gilles Peskinecbaff462019-07-12 23:46:04 +02001835#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001836 /* Finish the transaction for a key creation. This does not
1837 * happen when registering an existing key. Detect this case
1838 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001839 * creation of a persistent key in a secure element requires a transaction,
1840 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 if (driver != NULL &&
1842 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1843 status = psa_save_se_persistent_data(driver);
1844 if (status != PSA_SUCCESS) {
1845 psa_destroy_persistent_key(slot->attr.id);
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001846
1847#if defined(MBEDTLS_THREADING_C)
1848 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1849 &mbedtls_threading_key_slot_mutex));
1850#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001852 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001854 }
1855#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001858 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001859 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1860 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001862 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001864 }
Ronald Cron50972942020-11-14 11:28:25 +01001865
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001866#if defined(MBEDTLS_THREADING_C)
1867 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1868 &mbedtls_threading_key_slot_mutex));
1869#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001871}
1872
1873/** Abort the creation of a key.
1874 *
1875 * You may call this function after calling psa_start_key_creation(),
1876 * or after psa_finish_key_creation() fails. In other circumstances, this
1877 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001878 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001879 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001880 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001881 * \param[in,out] slot Pointer to the slot with key material.
1882 * \param[in] driver The secure element driver for the key,
1883 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001884 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001885static void psa_fail_key_creation(psa_key_slot_t *slot,
1886 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001887{
Gilles Peskine011e4282019-06-26 18:34:38 +02001888 (void) driver;
1889
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001891 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001893
1894#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001895 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001896 * element, and the failure happened later (when saving metadata
1897 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001898 * element.
1899 * https://github.com/ARMmbed/mbed-crypto/issues/217
1900 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001901
Gilles Peskined7729582019-08-05 15:55:54 +02001902 /* Abort the ongoing transaction if any (there may not be one if
1903 * the creation process failed before starting one, or if the
1904 * key creation is a registration of a key in a secure element).
1905 * Earlier functions must already have done what it takes to undo any
1906 * partial creation. All that's left is to update the transaction data
1907 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001909#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1910
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001912}
1913
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001914/** Validate optional attributes during key creation.
1915 *
1916 * Some key attributes are optional during key creation. If they are
1917 * specified in the attributes structure, check that they are consistent
1918 * with the data in the slot.
1919 *
1920 * This function should be called near the end of key creation, after
1921 * the slot in memory is fully populated but before saving persistent data.
1922 */
1923static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001924 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001926{
Gilles Peskine449bd832023-01-11 14:50:10 +01001927 if (attributes->core.type != 0) {
1928 if (attributes->core.type != slot->attr.type) {
1929 return PSA_ERROR_INVALID_ARGUMENT;
1930 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001931 }
1932
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001934#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1935 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01001936 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1937 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001938 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02001939 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02001940 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02001941
Ronald Cron90857082020-11-25 14:58:33 +01001942 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 slot->attr.type,
1944 slot->key.data,
1945 slot->key.bytes,
1946 &rsa);
1947 if (status != PSA_SUCCESS) {
1948 return status;
1949 }
Steven Cooreman75b74362020-07-28 14:30:13 +02001950
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 mbedtls_mpi_init(&actual);
1952 mbedtls_mpi_init(&required);
1953 ret = mbedtls_rsa_export(rsa,
1954 NULL, NULL, NULL, NULL, &actual);
1955 mbedtls_rsa_free(rsa);
1956 mbedtls_free(rsa);
1957 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001958 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 }
1960 ret = mbedtls_mpi_read_binary(&required,
1961 attributes->domain_parameters,
1962 attributes->domain_parameters_size);
1963 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001964 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 }
1966 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001967 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 }
1969rsa_exit:
1970 mbedtls_mpi_free(&actual);
1971 mbedtls_mpi_free(&required);
1972 if (ret != 0) {
1973 return mbedtls_to_psa_error(ret);
1974 }
1975 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02001976#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
1977 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001978 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001979 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001981 }
1982 }
1983
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 if (attributes->core.bits != 0) {
1985 if (attributes->core.bits != slot->attr.bits) {
1986 return PSA_ERROR_INVALID_ARGUMENT;
1987 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001988 }
1989
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001991}
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
1994 const uint8_t *data,
1995 size_t data_length,
1996 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001997{
1998 psa_status_t status;
1999 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002000 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002001 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302002 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002003
Ronald Cron81709fc2020-11-14 12:10:32 +01002004 *key = MBEDTLS_SVC_KEY_ID_INIT;
2005
Gilles Peskine0f84d622019-09-12 19:03:13 +02002006 /* Reject zero-length symmetric keys (including raw data key objects).
2007 * This also rejects any key which might be encoded as an empty string,
2008 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 if (data_length == 0) {
2010 return PSA_ERROR_INVALID_ARGUMENT;
2011 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002012
Archana449608b2021-09-08 15:36:05 +05302013 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 if (data_length > SIZE_MAX / 8) {
2015 return PSA_ERROR_NOT_SUPPORTED;
2016 }
Archana6ed4bda2021-08-04 10:47:15 +05302017
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2019 &slot, &driver);
2020 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002021 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002023
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002024 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302025 * storage ( thus not in the case of importing a key in a secure element
2026 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2027 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 if (slot->key.data == NULL) {
2029 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302030 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 attributes, data, data_length, &storage_size);
2032 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302033 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 }
Archanad8a83dc2021-06-14 10:04:16 +05302035 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 status = psa_allocate_buffer_to_slot(slot, storage_size);
2037 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002038 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002040 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002041
2042 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 status = psa_driver_wrapper_import_key(attributes,
2044 data, data_length,
2045 slot->key.data,
2046 slot->key.bytes,
2047 &slot->key.bytes, &bits);
2048 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002049 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002051
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002053 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002055 status = PSA_ERROR_INVALID_ARGUMENT;
2056 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002057 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002058
Archana6ed4bda2021-08-04 10:47:15 +05302059 /* Enforce a size limit, and in particular ensure that the bit
2060 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302062 status = PSA_ERROR_NOT_SUPPORTED;
2063 goto exit;
2064 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 status = psa_validate_optional_attributes(slot, attributes);
2066 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002067 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002071exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (status != PSA_SUCCESS) {
2073 psa_fail_key_creation(slot, driver);
2074 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002077}
2078
Gilles Peskined7729582019-08-05 15:55:54 +02002079#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2080psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002082{
2083 psa_status_t status;
2084 psa_key_slot_t *slot = NULL;
2085 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002086 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002087
2088 /* Leaving attributes unspecified is not currently supported.
2089 * It could make sense to query the key type and size from the
2090 * secure element, but not all secure elements support this
2091 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2093 return PSA_ERROR_NOT_SUPPORTED;
2094 }
2095 if (psa_get_key_bits(attributes) == 0) {
2096 return PSA_ERROR_NOT_SUPPORTED;
2097 }
Gilles Peskined7729582019-08-05 15:55:54 +02002098
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2100 &slot, &driver);
2101 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002102 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 }
Gilles Peskined7729582019-08-05 15:55:54 +02002104
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002106
2107exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (status != PSA_SUCCESS) {
2109 psa_fail_key_creation(slot, driver);
2110 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002111
Gilles Peskined7729582019-08-05 15:55:54 +02002112 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 psa_close_key(key);
2114 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002115}
2116#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2117
Gilles Peskine449bd832023-01-11 14:50:10 +01002118psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2119 const psa_key_attributes_t *specified_attributes,
2120 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002121{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002122 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002123 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002124 psa_key_slot_t *source_slot = NULL;
2125 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002126 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002127 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302128 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002129
Ronald Cron81709fc2020-11-14 12:10:32 +01002130 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2131
Archana8a180362021-07-05 02:18:48 +05302132 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2134 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002135 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002137
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 status = psa_validate_optional_attributes(source_slot,
2139 specified_attributes);
2140 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002141 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002143
Archana9d17bf42021-09-10 06:22:44 +05302144 /* The target key type and number of bits have been validated by
2145 * psa_validate_optional_attributes() to be either equal to zero or
2146 * equal to the ones of the source key. So it is safe to inherit
2147 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302148 * */
Archana9d17bf42021-09-10 06:22:44 +05302149 actual_attributes.core.bits = source_slot->attr.bits;
2150 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302151
2152
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 status = psa_restrict_key_policy(source_slot->attr.type,
2154 &actual_attributes.core.policy,
2155 &source_slot->attr.policy);
2156 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002157 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002159
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2161 &target_slot, &driver);
2162 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002163 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 }
2165 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2166 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302167 /*
Archana9d17bf42021-09-10 06:22:44 +05302168 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302169 * the source key would need to be exported as plaintext and re-imported
2170 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302171 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302172 * appropriate API invocations from the application, if needed.
2173 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002174 status = PSA_ERROR_NOT_SUPPORTED;
2175 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002176 }
Archana8a180362021-07-05 02:18:48 +05302177 /*
2178 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302179 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302180 * - For opaque keys this translates to an invocation of the drivers'
2181 * copy_key entry point through the dispatch layer.
2182 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2184 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2185 &storage_size);
2186 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302187 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 }
Archana374fe5b2021-09-08 15:50:28 +05302189
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2191 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302192 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 }
Archana374fe5b2021-09-08 15:50:28 +05302194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 status = psa_driver_wrapper_copy_key(&actual_attributes,
2196 source_slot->key.data,
2197 source_slot->key.bytes,
2198 target_slot->key.data,
2199 target_slot->key.bytes,
2200 &target_slot->key.bytes);
2201 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302202 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 }
2204 } else {
2205 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302206 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 source_slot->key.bytes);
2208 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302209 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 }
Archana8a180362021-07-05 02:18:48 +05302211 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002213exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 if (status != PSA_SUCCESS) {
2215 psa_fail_key_creation(target_slot, driver);
2216 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002217
Ryan Everett1b70a072024-01-04 10:32:49 +00002218 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002219
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002221}
2222
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002223
2224
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002225/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002226/* Message digests */
2227/****************************************************************/
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002230{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002231 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 if (operation->id == 0) {
2233 return PSA_SUCCESS;
2234 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002235
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002237 operation->id = 0;
2238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002240}
2241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2243 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002244{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002245 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002246
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002247 /* A context must be freshly initialized before it can be set up. */
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 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002254 status = PSA_ERROR_INVALID_ARGUMENT;
2255 goto exit;
2256 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002257
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002258 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2259 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002261
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002263
2264exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if (status != PSA_SUCCESS) {
2266 psa_hash_abort(operation);
2267 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002268
2269 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002270}
2271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2273 const uint8_t *input,
2274 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002275{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002276 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2277
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002279 status = PSA_ERROR_BAD_STATE;
2280 goto exit;
2281 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002282
Steven Cooremanc8288352021-03-04 14:02:19 +01002283 /* Don't require hash implementations to behave correctly on a
2284 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 if (input_length == 0) {
2286 return PSA_SUCCESS;
2287 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002288
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002290
2291exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 if (status != PSA_SUCCESS) {
2293 psa_hash_abort(operation);
2294 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002295
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002297}
2298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2300 uint8_t *hash,
2301 size_t hash_size,
2302 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002303{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002304 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 if (operation->id == 0) {
2306 return PSA_ERROR_BAD_STATE;
2307 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002308
Steven Cooreman1e582352021-02-18 17:24:37 +01002309 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 operation, hash, hash_size, hash_length);
2311 psa_hash_abort(operation);
2312 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002313}
2314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2316 const uint8_t *hash,
2317 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002318{
Ronald Cron69a63422021-10-18 09:47:58 +02002319 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002320 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002321 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 operation,
2323 actual_hash, sizeof(actual_hash),
2324 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002325
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002327 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002329
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002331 status = PSA_ERROR_INVALID_SIGNATURE;
2332 goto exit;
2333 }
2334
Dave Rodgman78701152023-08-29 14:20:18 +01002335 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002336 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002338
2339exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2341 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002342 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002344
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002346}
2347
Gilles Peskine449bd832023-01-11 14:50:10 +01002348psa_status_t psa_hash_compute(psa_algorithm_t alg,
2349 const uint8_t *input, size_t input_length,
2350 uint8_t *hash, size_t hash_size,
2351 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002352{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002353 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 if (!PSA_ALG_IS_HASH(alg)) {
2355 return PSA_ERROR_INVALID_ARGUMENT;
2356 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2359 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002360}
2361
Gilles Peskine449bd832023-01-11 14:50:10 +01002362psa_status_t psa_hash_compare(psa_algorithm_t alg,
2363 const uint8_t *input, size_t input_length,
2364 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002365{
Ronald Cron69a63422021-10-18 09:47:58 +02002366 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002367 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002368
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 if (!PSA_ALG_IS_HASH(alg)) {
2370 return PSA_ERROR_INVALID_ARGUMENT;
2371 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002372
Steven Cooreman1e582352021-02-18 17:24:37 +01002373 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 alg, input, input_length,
2375 actual_hash, sizeof(actual_hash),
2376 &actual_hash_length);
2377 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002378 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 }
2380 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002381 status = PSA_ERROR_INVALID_SIGNATURE;
2382 goto exit;
2383 }
Dave Rodgman78701152023-08-29 14:20:18 +01002384 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002385 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002387
2388exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2390 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002391}
2392
Gilles Peskine449bd832023-01-11 14:50:10 +01002393psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2394 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002395{
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 if (source_operation->id == 0 ||
2397 target_operation->id != 0) {
2398 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002399 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002400
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2402 target_operation);
2403 if (status != PSA_SUCCESS) {
2404 psa_hash_abort(target_operation);
2405 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002406
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002408}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002409
2410
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002411/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002412/* MAC */
2413/****************************************************************/
2414
Gilles Peskine449bd832023-01-11 14:50:10 +01002415psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002416{
Steven Cooremane6804192021-03-19 18:28:56 +01002417 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 if (operation->id == 0) {
2419 return PSA_SUCCESS;
2420 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002421
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002423 operation->mac_size = 0;
2424 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002425 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002426
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002428}
2429
Ronald Cron2dff3b22021-06-17 16:33:22 +02002430static psa_status_t psa_mac_finalize_alg_and_key_validation(
2431 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002432 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002434{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002435 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 psa_key_type_t key_type = psa_get_key_type(attributes);
2437 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002438
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 if (!PSA_ALG_IS_MAC(alg)) {
2440 return PSA_ERROR_INVALID_ARGUMENT;
2441 }
Steven Cooremane6804192021-03-19 18:28:56 +01002442
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002443 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 status = psa_mac_key_can_do(alg, key_type);
2445 if (status != PSA_SUCCESS) {
2446 return status;
2447 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002448
Steven Cooremand1a68f12021-05-10 11:13:41 +02002449 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002453 /* A very short MAC is too short for security since it can be
2454 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2455 * so we make this our minimum, even though 32 bits is still
2456 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002458 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002459
Gilles Peskine449bd832023-01-11 14:50:10 +01002460 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2461 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002462 /* It's impossible to "truncate" to a larger length than the full length
2463 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002465 }
2466
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002468 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2469 * that is disabled in the compile-time configuration. The result can
2470 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2471 * configuration into account. In this case, force a return of
2472 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2473 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2474 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2475 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2476 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002478 }
2479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002481}
2482
Gilles Peskine449bd832023-01-11 14:50:10 +01002483static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2484 mbedtls_svc_key_id_t key,
2485 psa_algorithm_t alg,
2486 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002487{
2488 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2489 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002490 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002491 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002492
2493 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002495 status = PSA_ERROR_BAD_STATE;
2496 goto exit;
2497 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002498
2499 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 key,
2501 &slot,
2502 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2503 alg);
2504 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002505 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002507
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002508 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002509 .core = slot->attr
2510 };
2511
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2513 &operation->mac_size);
2514 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002515 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002517
2518 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002519 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 if (is_sign) {
2521 status = psa_driver_wrapper_mac_sign_setup(operation,
2522 &attributes,
2523 slot->key.data,
2524 slot->key.bytes,
2525 alg);
2526 } else {
2527 status = psa_driver_wrapper_mac_verify_setup(operation,
2528 &attributes,
2529 slot->key.data,
2530 slot->key.bytes,
2531 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002532 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002533
Gilles Peskinefbfac682018-07-08 20:51:54 +02002534exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 if (status != PSA_SUCCESS) {
2536 psa_mac_abort(operation);
2537 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002538
Ryan Everett1b70a072024-01-04 10:32:49 +00002539 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002540
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002542}
2543
Gilles Peskine449bd832023-01-11 14:50:10 +01002544psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2545 mbedtls_svc_key_id_t key,
2546 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002547{
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002549}
2550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2552 mbedtls_svc_key_id_t key,
2553 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002554{
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002556}
2557
Gilles Peskine449bd832023-01-11 14:50:10 +01002558psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2559 const uint8_t *input,
2560 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002561{
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 if (operation->id == 0) {
2563 return PSA_ERROR_BAD_STATE;
2564 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002565
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002566 /* Don't require hash implementations to behave correctly on a
2567 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 if (input_length == 0) {
2569 return PSA_SUCCESS;
2570 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2573 input, input_length);
2574 if (status != PSA_SUCCESS) {
2575 psa_mac_abort(operation);
2576 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002579}
2580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2582 uint8_t *mac,
2583 size_t mac_size,
2584 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002585{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002586 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2587 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002590 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002591 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002592 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002593
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002595 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002596 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002597 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002598
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002599 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2600 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002602 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002603 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002604 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002605
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002607 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002608 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002609 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 status = psa_driver_wrapper_mac_sign_finish(operation,
2612 mac, operation->mac_size,
2613 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002614
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002615exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002616 /* In case of success, set the potential excess room in the output buffer
2617 * to an invalid value, to avoid potentially leaking a longer MAC.
2618 * In case of error, set the output length and content to a safe default,
2619 * such that in case the caller misses an error check, the output would be
2620 * an unachievable MAC.
2621 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002623 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002624 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002625 }
mohammad16036df908f2018-04-02 08:34:15 -07002626
Paul Elliottdc42ca82023-02-24 18:11:59 +00002627 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002628
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002630
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002632}
2633
Gilles Peskine449bd832023-01-11 14:50:10 +01002634psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2635 const uint8_t *mac,
2636 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002637{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002638 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2639 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002640
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002642 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002643 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002644 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002645
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002647 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002648 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002649 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002652 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002653 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002654 }
2655
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 status = psa_driver_wrapper_mac_verify_finish(operation,
2657 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002658
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002659exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002661
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002663}
2664
Gilles Peskine449bd832023-01-11 14:50:10 +01002665static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2666 psa_algorithm_t alg,
2667 const uint8_t *input,
2668 size_t input_length,
2669 uint8_t *mac,
2670 size_t mac_size,
2671 size_t *mac_length,
2672 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002673{
2674 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002675 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2676 psa_key_slot_t *slot;
2677 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002678 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002679
Ronald Cron51131b52021-06-17 17:17:20 +02002680 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 key,
2682 &slot,
2683 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2684 alg);
2685 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002686 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002688
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002689 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002690 .core = slot->attr
2691 };
2692
Gilles Peskine449bd832023-01-11 14:50:10 +01002693 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2694 &operation_mac_size);
2695 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002696 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002700 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002701 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002702 }
2703
2704 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 &attributes,
2706 slot->key.data, slot->key.bytes,
2707 alg,
2708 input, input_length,
2709 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002710
2711exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002712 /* In case of success, set the potential excess room in the output buffer
2713 * to an invalid value, to avoid potentially leaking a longer MAC.
2714 * In case of error, set the output length and content to a safe default,
2715 * such that in case the caller misses an error check, the output would be
2716 * an unachievable MAC.
2717 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002719 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002720 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002721 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002722
2723 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002724
Ryan Everett1b70a072024-01-04 10:32:49 +00002725 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002728}
2729
Gilles Peskine449bd832023-01-11 14:50:10 +01002730psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002731 psa_algorithm_t alg,
2732 const uint8_t *input,
2733 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 uint8_t *mac,
2735 size_t mac_size,
2736 size_t *mac_length)
2737{
2738 return psa_mac_compute_internal(key, alg,
2739 input, input_length,
2740 mac, mac_size, mac_length, 1);
2741}
2742
2743psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2744 psa_algorithm_t alg,
2745 const uint8_t *input,
2746 size_t input_length,
2747 const uint8_t *mac,
2748 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002749{
2750 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002751 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2752 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002753
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 status = psa_mac_compute_internal(key, alg,
2755 input, input_length,
2756 actual_mac, sizeof(actual_mac),
2757 &actual_mac_length, 0);
2758 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002759 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002761
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002763 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002764 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002765 }
Dave Rodgman78701152023-08-29 14:20:18 +01002766 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002767 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002768 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002769 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002770
2771exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002772 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002773
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002775}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002776
Gilles Peskinee59236f2018-01-27 23:32:46 +01002777/****************************************************************/
2778/* Asymmetric cryptography */
2779/****************************************************************/
2780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2782 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002783{
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 if (input_is_message) {
2785 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2786 return PSA_ERROR_INVALID_ARGUMENT;
2787 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2790 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2791 return PSA_ERROR_INVALID_ARGUMENT;
2792 }
2793 }
2794 } else {
2795 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2796 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002797 }
2798 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002801}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002802
Gilles Peskine449bd832023-01-11 14:50:10 +01002803static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2804 int input_is_message,
2805 psa_algorithm_t alg,
2806 const uint8_t *input,
2807 size_t input_length,
2808 uint8_t *signature,
2809 size_t signature_size,
2810 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002811{
2812 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2813 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2814 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002815 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002816
2817 *signature_length = 0;
2818
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 status = psa_sign_verify_check_alg(input_is_message, alg);
2820 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002821 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002823
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002824 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002825 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002826 * buffer can in principle be empty since it doesn't actually have
2827 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 if (signature_size == 0) {
2829 return PSA_ERROR_BUFFER_TOO_SMALL;
2830 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002831
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002832 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 key, &slot,
2834 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2835 PSA_KEY_USAGE_SIGN_HASH,
2836 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002839 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002841
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002843 status = PSA_ERROR_INVALID_ARGUMENT;
2844 goto exit;
2845 }
2846
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002847 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002849 };
2850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002852 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002853 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002854 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 signature, signature_size, signature_length);
2856 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002857
2858 status = psa_driver_wrapper_sign_hash(
2859 &attributes, slot->key.data, slot->key.bytes,
2860 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002862 }
2863
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002864
2865exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002866 psa_wipe_tag_output_buffer(signature, status, signature_size,
2867 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002868
Ryan Everett1b70a072024-01-04 10:32:49 +00002869 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002872}
2873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2875 int input_is_message,
2876 psa_algorithm_t alg,
2877 const uint8_t *input,
2878 size_t input_length,
2879 const uint8_t *signature,
2880 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002881{
2882 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2883 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2884 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002885
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 status = psa_sign_verify_check_alg(input_is_message, alg);
2887 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002888 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002890
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002891 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 key, &slot,
2893 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2894 PSA_KEY_USAGE_VERIFY_HASH,
2895 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 if (status != PSA_SUCCESS) {
2898 return status;
2899 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002900
2901 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002903 };
2904
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002906 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002907 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002908 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 signature, signature_length);
2910 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002911 status = psa_driver_wrapper_verify_hash(
2912 &attributes, slot->key.data, slot->key.bytes,
2913 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002915 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002916
Ryan Everett1b70a072024-01-04 10:32:49 +00002917 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002918
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002920
2921}
2922
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002923psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002924 const psa_key_attributes_t *attributes,
2925 const uint8_t *key_buffer,
2926 size_t key_buffer_size,
2927 psa_algorithm_t alg,
2928 const uint8_t *input,
2929 size_t input_length,
2930 uint8_t *signature,
2931 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002932 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002933{
2934 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002935
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002937 size_t hash_length;
2938 uint8_t hash[PSA_HASH_MAX_SIZE];
2939
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002940 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 PSA_ALG_SIGN_GET_HASH(alg),
2942 input, input_length,
2943 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002946 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002948
2949 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 attributes, key_buffer, key_buffer_size,
2951 alg, hash, hash_length,
2952 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002953 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002954
Gilles Peskine449bd832023-01-11 14:50:10 +01002955 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002956}
2957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
2959 psa_algorithm_t alg,
2960 const uint8_t *input,
2961 size_t input_length,
2962 uint8_t *signature,
2963 size_t signature_size,
2964 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002965{
2966 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002967 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002968 signature, signature_size, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002969}
2970
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02002971psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002972 const psa_key_attributes_t *attributes,
2973 const uint8_t *key_buffer,
2974 size_t key_buffer_size,
2975 psa_algorithm_t alg,
2976 const uint8_t *input,
2977 size_t input_length,
2978 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002980{
2981 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002984 size_t hash_length;
2985 uint8_t hash[PSA_HASH_MAX_SIZE];
2986
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002987 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 PSA_ALG_SIGN_GET_HASH(alg),
2989 input, input_length,
2990 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02002993 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02002995
2996 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 attributes, key_buffer, key_buffer_size,
2998 alg, hash, hash_length,
2999 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003000 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003001
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003003}
3004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3006 psa_algorithm_t alg,
3007 const uint8_t *input,
3008 size_t input_length,
3009 const uint8_t *signature,
3010 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003011{
3012 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003013 key, 1, alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 signature, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003015}
3016
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003017psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003018 const psa_key_attributes_t *attributes,
3019 const uint8_t *key_buffer, size_t key_buffer_size,
3020 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003022{
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3024 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3025 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003026#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3028 return mbedtls_psa_rsa_sign_hash(
3029 attributes,
3030 key_buffer, key_buffer_size,
3031 alg, hash, hash_length,
3032 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003033#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3034 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 } else {
3036 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003037 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3039 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003040#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3042 return mbedtls_psa_ecdsa_sign_hash(
3043 attributes,
3044 key_buffer, key_buffer_size,
3045 alg, hash, hash_length,
3046 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003047#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3048 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 } else {
3050 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003051 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003052 }
Ronald Cron4501c982021-03-19 20:09:32 +01003053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 (void) key_buffer;
3055 (void) key_buffer_size;
3056 (void) hash;
3057 (void) hash_length;
3058 (void) signature;
3059 (void) signature_size;
3060 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003061
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003063}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003064
Gilles Peskine449bd832023-01-11 14:50:10 +01003065psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3066 psa_algorithm_t alg,
3067 const uint8_t *hash,
3068 size_t hash_length,
3069 uint8_t *signature,
3070 size_t signature_size,
3071 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003072{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003073 return psa_sign_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003074 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003076}
3077
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003078psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003079 const psa_key_attributes_t *attributes,
3080 const uint8_t *key_buffer, size_t key_buffer_size,
3081 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003083{
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3085 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3086 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003087#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003088 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3089 return mbedtls_psa_rsa_verify_hash(
3090 attributes,
3091 key_buffer, key_buffer_size,
3092 alg, hash, hash_length,
3093 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003094#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3095 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 } else {
3097 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003098 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3100 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003101#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3103 return mbedtls_psa_ecdsa_verify_hash(
3104 attributes,
3105 key_buffer, key_buffer_size,
3106 alg, hash, hash_length,
3107 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003108#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3109 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 } else {
3111 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003112 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003113 }
Ronald Cron4501c982021-03-19 20:09:32 +01003114
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 (void) key_buffer;
3116 (void) key_buffer_size;
3117 (void) hash;
3118 (void) hash_length;
3119 (void) signature;
3120 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003121
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003123}
3124
Gilles Peskine449bd832023-01-11 14:50:10 +01003125psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3126 psa_algorithm_t alg,
3127 const uint8_t *hash,
3128 size_t hash_length,
3129 const uint8_t *signature,
3130 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003131{
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003132 return psa_verify_internal(
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003133 key, 0, alg, hash, hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003135}
3136
Gilles Peskine449bd832023-01-11 14:50:10 +01003137psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3138 psa_algorithm_t alg,
3139 const uint8_t *input,
3140 size_t input_length,
3141 const uint8_t *salt,
3142 size_t salt_length,
3143 uint8_t *output,
3144 size_t output_size,
3145 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003146{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003147 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003148 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003149 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003150 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003151
Darryl Green5cc689a2018-07-24 15:34:10 +01003152 (void) input;
3153 (void) input_length;
3154 (void) salt;
3155 (void) output;
3156 (void) output_size;
3157
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003158 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003159
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3161 return PSA_ERROR_INVALID_ARGUMENT;
3162 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003163
Valerio Setti5bb454a2024-01-15 10:43:16 +01003164 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3166 if (status != PSA_SUCCESS) {
3167 return status;
3168 }
3169 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3170 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003171 status = PSA_ERROR_INVALID_ARGUMENT;
3172 goto exit;
3173 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003174
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003175 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003177 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003178
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003179 status = psa_driver_wrapper_asymmetric_encrypt(
3180 &attributes, slot->key.data, slot->key.bytes,
3181 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003183exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003184 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003185
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003187}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003188
Gilles Peskine449bd832023-01-11 14:50:10 +01003189psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3190 psa_algorithm_t alg,
3191 const uint8_t *input,
3192 size_t input_length,
3193 const uint8_t *salt,
3194 size_t salt_length,
3195 uint8_t *output,
3196 size_t output_size,
3197 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003198{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003199 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003200 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003201 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003202 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003203
Darryl Green5cc689a2018-07-24 15:34:10 +01003204 (void) input;
3205 (void) input_length;
3206 (void) salt;
3207 (void) output;
3208 (void) output_size;
3209
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003210 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003211
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3213 return PSA_ERROR_INVALID_ARGUMENT;
3214 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003215
Valerio Setti5bb454a2024-01-15 10:43:16 +01003216 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003217 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3218 if (status != PSA_SUCCESS) {
3219 return status;
3220 }
3221 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003222 status = PSA_ERROR_INVALID_ARGUMENT;
3223 goto exit;
3224 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003225
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003226 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003227 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003228 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003229
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003230 status = psa_driver_wrapper_asymmetric_decrypt(
3231 &attributes, slot->key.data, slot->key.bytes,
3232 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003234
3235exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003236 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003237
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003239}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003240
Paul Elliott9fe12f62022-11-30 19:16:02 +00003241/****************************************************************/
3242/* Asymmetric interruptible cryptography */
3243/****************************************************************/
3244
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003245static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3246
Paul Elliott9fe12f62022-11-30 19:16:02 +00003247void psa_interruptible_set_max_ops(uint32_t max_ops)
3248{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003249 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003250}
3251
3252uint32_t psa_interruptible_get_max_ops(void)
3253{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003254 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003255}
3256
Paul Elliott9fe12f62022-11-30 19:16:02 +00003257uint32_t psa_sign_hash_get_num_ops(
3258 const psa_sign_hash_interruptible_operation_t *operation)
3259{
Paul Elliott296ede92022-12-15 17:00:30 +00003260 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003261}
3262
3263uint32_t psa_verify_hash_get_num_ops(
3264 const psa_verify_hash_interruptible_operation_t *operation)
3265{
Paul Elliott296ede92022-12-15 17:00:30 +00003266 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003267}
3268
Paul Elliott59ad9452022-12-18 15:09:02 +00003269static psa_status_t psa_sign_hash_abort_internal(
3270 psa_sign_hash_interruptible_operation_t *operation)
3271{
3272 if (operation->id == 0) {
3273 /* The object has (apparently) been initialized but it is not (yet)
3274 * in use. It's ok to call abort on such an object, and there's
3275 * nothing to do. */
3276 return PSA_SUCCESS;
3277 }
3278
3279 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3280
3281 status = psa_driver_wrapper_sign_hash_abort(operation);
3282
3283 operation->id = 0;
3284
Paul Elliotte6145dc2023-02-07 12:51:21 +00003285 /* Do not clear either the error_occurred or num_ops elements here as they
3286 * only want to be cleared by the application calling abort, not by abort
3287 * being called at completion of an operation. */
3288
Paul Elliott59ad9452022-12-18 15:09:02 +00003289 return status;
3290}
3291
Paul Elliott9fe12f62022-11-30 19:16:02 +00003292psa_status_t psa_sign_hash_start(
3293 psa_sign_hash_interruptible_operation_t *operation,
3294 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3295 const uint8_t *hash, size_t hash_length)
3296{
3297 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3298 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3299 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003300 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003301
Paul Elliottc9774412023-02-06 15:14:07 +00003302 /* Check that start has not been previously called, or operation has not
3303 * previously errored. */
3304 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003305 return PSA_ERROR_BAD_STATE;
3306 }
3307
Paul Elliott9fe12f62022-11-30 19:16:02 +00003308 status = psa_sign_verify_check_alg(0, alg);
3309 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003310 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003311 return status;
3312 }
3313
3314 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3315 PSA_KEY_USAGE_SIGN_HASH,
3316 alg);
3317
3318 if (status != PSA_SUCCESS) {
3319 goto exit;
3320 }
3321
3322 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3323 status = PSA_ERROR_INVALID_ARGUMENT;
3324 goto exit;
3325 }
3326
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003327 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003328 .core = slot->attr
3329 };
3330
Paul Elliott296ede92022-12-15 17:00:30 +00003331 /* Ensure ops count gets reset, in case of operation re-use. */
3332 operation->num_ops = 0;
3333
Paul Elliott9fe12f62022-11-30 19:16:02 +00003334 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3335 slot->key.data,
3336 slot->key.bytes, alg,
3337 hash, hash_length);
3338exit:
3339
3340 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003341 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003342 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003343 }
3344
Ryan Everett1b70a072024-01-04 10:32:49 +00003345 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003346
Paul Elliottc9774412023-02-06 15:14:07 +00003347 if (unlock_status != PSA_SUCCESS) {
3348 operation->error_occurred = 1;
3349 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003350
Paul Elliottc9774412023-02-06 15:14:07 +00003351 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003352}
3353
3354
3355psa_status_t psa_sign_hash_complete(
3356 psa_sign_hash_interruptible_operation_t *operation,
3357 uint8_t *signature, size_t signature_size,
3358 size_t *signature_length)
3359{
3360 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3361
3362 *signature_length = 0;
3363
Paul Elliottc9774412023-02-06 15:14:07 +00003364 /* Check that start has been called first, and that operation has not
3365 * previously errored. */
3366 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003367 status = PSA_ERROR_BAD_STATE;
3368 goto exit;
3369 }
3370
Paul Elliott096abc42023-02-03 18:33:23 +00003371 /* Immediately reject a zero-length signature buffer. This guarantees that
3372 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003373 if (signature_size == 0) {
3374 status = PSA_ERROR_BUFFER_TOO_SMALL;
3375 goto exit;
3376 }
3377
3378 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3379 signature_size,
3380 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003381
Paul Elliott296ede92022-12-15 17:00:30 +00003382 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003383 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003384
Paul Elliottebe225c2023-02-10 14:32:53 +00003385exit:
3386
Paul Elliott59200a22023-02-21 15:07:40 +00003387 psa_wipe_tag_output_buffer(signature, status, signature_size,
3388 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003389
Paul Elliott53bb3122023-02-10 14:22:22 +00003390 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003391 if (status != PSA_SUCCESS) {
3392 operation->error_occurred = 1;
3393 }
3394
Paul Elliott59ad9452022-12-18 15:09:02 +00003395 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003396 }
3397
3398 return status;
3399}
3400
3401psa_status_t psa_sign_hash_abort(
3402 psa_sign_hash_interruptible_operation_t *operation)
3403{
Paul Elliott59ad9452022-12-18 15:09:02 +00003404 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3405
3406 status = psa_sign_hash_abort_internal(operation);
3407
3408 /* We clear the number of ops done here, so that it is not cleared when
3409 * the operation fails or succeeds, only on manual abort. */
3410 operation->num_ops = 0;
3411
Paul Elliottc9774412023-02-06 15:14:07 +00003412 /* Likewise, failure state. */
3413 operation->error_occurred = 0;
3414
Paul Elliott59ad9452022-12-18 15:09:02 +00003415 return status;
3416}
3417
3418static psa_status_t psa_verify_hash_abort_internal(
3419 psa_verify_hash_interruptible_operation_t *operation)
3420{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003421 if (operation->id == 0) {
3422 /* The object has (apparently) been initialized but it is not (yet)
3423 * in use. It's ok to call abort on such an object, and there's
3424 * nothing to do. */
3425 return PSA_SUCCESS;
3426 }
3427
Paul Elliott59ad9452022-12-18 15:09:02 +00003428 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3429
3430 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003431
3432 operation->id = 0;
3433
Paul Elliotte6145dc2023-02-07 12:51:21 +00003434 /* Do not clear either the error_occurred or num_ops elements here as they
3435 * only want to be cleared by the application calling abort, not by abort
3436 * being called at completion of an operation. */
3437
Paul Elliott59ad9452022-12-18 15:09:02 +00003438 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003439}
3440
3441psa_status_t psa_verify_hash_start(
3442 psa_verify_hash_interruptible_operation_t *operation,
3443 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3444 const uint8_t *hash, size_t hash_length,
3445 const uint8_t *signature, size_t signature_length)
3446{
3447 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3448 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3449 psa_key_slot_t *slot;
3450
Paul Elliottc9774412023-02-06 15:14:07 +00003451 /* Check that start has not been previously called, or operation has not
3452 * previously errored. */
3453 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003454 return PSA_ERROR_BAD_STATE;
3455 }
3456
3457 status = psa_sign_verify_check_alg(0, alg);
3458 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003459 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003460 return status;
3461 }
3462
3463 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3464 PSA_KEY_USAGE_VERIFY_HASH,
3465 alg);
3466
3467 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003468 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003469 return status;
3470 }
3471
3472 psa_key_attributes_t attributes = {
3473 .core = slot->attr
3474 };
3475
Paul Elliott296ede92022-12-15 17:00:30 +00003476 /* Ensure ops count gets reset, in case of operation re-use. */
3477 operation->num_ops = 0;
3478
Paul Elliott9fe12f62022-11-30 19:16:02 +00003479 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3480 slot->key.data,
3481 slot->key.bytes,
3482 alg, hash, hash_length,
3483 signature, signature_length);
3484
3485 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003486 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003487 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003488 }
3489
Ryan Everett1b70a072024-01-04 10:32:49 +00003490 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003491
Paul Elliottc9774412023-02-06 15:14:07 +00003492 if (unlock_status != PSA_SUCCESS) {
3493 operation->error_occurred = 1;
3494 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003495
Paul Elliottc9774412023-02-06 15:14:07 +00003496 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003497}
3498
3499psa_status_t psa_verify_hash_complete(
3500 psa_verify_hash_interruptible_operation_t *operation)
3501{
3502 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3503
Paul Elliottc9774412023-02-06 15:14:07 +00003504 /* Check that start has been called first, and that operation has not
3505 * previously errored. */
3506 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003507 status = PSA_ERROR_BAD_STATE;
3508 goto exit;
3509 }
3510
3511 status = psa_driver_wrapper_verify_hash_complete(operation);
3512
Paul Elliott296ede92022-12-15 17:00:30 +00003513 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003514 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003515 operation);
3516
Paul Elliottebe225c2023-02-10 14:32:53 +00003517exit:
3518
Paul Elliott9fe12f62022-11-30 19:16:02 +00003519 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003520 if (status != PSA_SUCCESS) {
3521 operation->error_occurred = 1;
3522 }
3523
Paul Elliott59ad9452022-12-18 15:09:02 +00003524 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003525 }
3526
3527 return status;
3528}
3529
3530psa_status_t psa_verify_hash_abort(
3531 psa_verify_hash_interruptible_operation_t *operation)
3532{
Paul Elliott59ad9452022-12-18 15:09:02 +00003533 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003534
Paul Elliott59ad9452022-12-18 15:09:02 +00003535 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003536
Paul Elliott59ad9452022-12-18 15:09:02 +00003537 /* We clear the number of ops done here, so that it is not cleared when
3538 * the operation fails or succeeds, only on manual abort. */
3539 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003540
Paul Elliottc9774412023-02-06 15:14:07 +00003541 /* Likewise, failure state. */
3542 operation->error_occurred = 0;
3543
Paul Elliott59ad9452022-12-18 15:09:02 +00003544 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003545}
3546
Paul Elliott588f8ed2022-12-02 18:10:26 +00003547/****************************************************************/
3548/* Asymmetric interruptible cryptography internal */
3549/* implementations */
3550/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003551
Paul Elliott588f8ed2022-12-02 18:10:26 +00003552void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3553{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003554
Paul Elliott588f8ed2022-12-02 18:10:26 +00003555#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3556 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3557 defined(MBEDTLS_ECP_RESTARTABLE)
3558
3559 /* Internal implementation uses zero to indicate infinite number max ops,
3560 * therefore avoid this value, and set to minimum possible. */
3561 if (max_ops == 0) {
3562 max_ops = 1;
3563 }
3564
Paul Elliott588f8ed2022-12-02 18:10:26 +00003565 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003566#else
3567 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003568#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3569 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3570 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3571}
3572
Paul Elliott588f8ed2022-12-02 18:10:26 +00003573uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003574 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003575{
3576#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3577 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3578 defined(MBEDTLS_ECP_RESTARTABLE)
3579
Paul Elliott93d9ca82023-02-15 18:14:21 +00003580 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003581#else
3582 (void) operation;
3583 return 0;
3584#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3585 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3586 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3587}
3588
3589uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003590 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003591{
3592 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3593 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3594 defined(MBEDTLS_ECP_RESTARTABLE)
3595
Paul Elliott93d9ca82023-02-15 18:14:21 +00003596 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003597#else
3598 (void) operation;
3599 return 0;
3600#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3601 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3602 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3603}
3604
3605psa_status_t mbedtls_psa_sign_hash_start(
3606 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3607 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3608 size_t key_buffer_size, psa_algorithm_t alg,
3609 const uint8_t *hash, size_t hash_length)
3610{
3611 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003612 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003613
Paul Elliott068fe072023-01-16 13:59:15 +00003614 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3615 return PSA_ERROR_NOT_SUPPORTED;
3616 }
3617
3618 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003619 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003620 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003621
3622#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003623 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3624 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003625
Paul Elliotta1c94092023-02-15 16:38:04 +00003626 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3627
Paul Elliott93d9ca82023-02-15 18:14:21 +00003628 /* Ensure num_ops is zero'ed in case of context re-use. */
3629 operation->num_ops = 0;
3630
Paul Elliott068fe072023-01-16 13:59:15 +00003631 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3632 attributes->core.bits,
3633 key_buffer,
3634 key_buffer_size,
3635 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003636
Paul Elliott068fe072023-01-16 13:59:15 +00003637 if (status != PSA_SUCCESS) {
3638 return status;
3639 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003640
Paul Elliott1bc59df2023-02-05 13:41:57 +00003641 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003642 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003643
Paul Elliott068fe072023-01-16 13:59:15 +00003644 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003645 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003646 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003647
Paul Elliott0290a762023-02-09 14:30:24 +00003648 /* We only need to store the same length of hash as the private key size
3649 * here, it would be truncated by the internal implementation anyway. */
3650 required_hash_length = (hash_length < operation->coordinate_bytes ?
3651 hash_length : operation->coordinate_bytes);
3652
Paul Elliottba70ad42023-02-15 18:23:53 +00003653 if (required_hash_length > sizeof(operation->hash)) {
3654 /* Shouldn't happen, but better safe than sorry. */
3655 return PSA_ERROR_CORRUPTION_DETECTED;
3656 }
3657
Paul Elliott0290a762023-02-09 14:30:24 +00003658 memcpy(operation->hash, hash, required_hash_length);
3659 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003660
3661 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003662
3663#else
Paul Elliott068fe072023-01-16 13:59:15 +00003664 (void) operation;
3665 (void) key_buffer;
3666 (void) key_buffer_size;
3667 (void) alg;
3668 (void) hash;
3669 (void) hash_length;
3670 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003671 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003672
Paul Elliott068fe072023-01-16 13:59:15 +00003673 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003674#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3675 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3676 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003677}
3678
3679psa_status_t mbedtls_psa_sign_hash_complete(
3680 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3681 uint8_t *signature, size_t signature_size,
3682 size_t *signature_length)
3683{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003684#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3685 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3686 defined(MBEDTLS_ECP_RESTARTABLE)
3687
Paul Elliotta1c94092023-02-15 16:38:04 +00003688 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003689 mbedtls_mpi r;
3690 mbedtls_mpi s;
3691
Paul Elliott46845252023-02-03 14:59:11 +00003692 mbedtls_mpi_init(&r);
3693 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003694
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003695 /* Ensure max_ops is set to the current value (or default). */
3696 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3697
Paul Elliotta1c94092023-02-15 16:38:04 +00003698 if (signature_size < 2 * operation->coordinate_bytes) {
3699 status = PSA_ERROR_BUFFER_TOO_SMALL;
3700 goto exit;
3701 }
3702
Paul Elliott588f8ed2022-12-02 18:10:26 +00003703 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003704
Paul Elliott588f8ed2022-12-02 18:10:26 +00003705#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3706 status = mbedtls_to_psa_error(
3707 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003708 &r,
3709 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003710 &operation->ctx->d,
3711 operation->hash,
3712 operation->hash_length,
3713 operation->md_alg,
3714 mbedtls_psa_get_random,
3715 MBEDTLS_PSA_RANDOM_STATE,
3716 &operation->restart_ctx));
3717#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003718 status = PSA_ERROR_NOT_SUPPORTED;
3719 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003720#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3721 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003722 status = mbedtls_to_psa_error(
3723 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003724 &r,
3725 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003726 &operation->ctx->d,
3727 operation->hash,
3728 operation->hash_length,
3729 mbedtls_psa_get_random,
3730 MBEDTLS_PSA_RANDOM_STATE,
3731 mbedtls_psa_get_random,
3732 MBEDTLS_PSA_RANDOM_STATE,
3733 &operation->restart_ctx));
3734 }
3735
Paul Elliottf8e5b562023-02-19 18:43:45 +00003736 /* Hide the fact that the restart context only holds a delta of number of
3737 * ops done during the last operation, not an absolute value. */
3738 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3739
Paul Elliott724bd252023-02-08 12:35:08 +00003740 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003741 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003742 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003743 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003744 operation->coordinate_bytes)
3745 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003746
3747 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003748 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003749 }
3750
3751 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003752 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003753 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003754 operation->coordinate_bytes,
3755 operation->coordinate_bytes)
3756 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003757
3758 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003759 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003760 }
3761
Paul Elliott1bc59df2023-02-05 13:41:57 +00003762 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003763
Paul Elliott724bd252023-02-08 12:35:08 +00003764 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003765 }
Paul Elliott724bd252023-02-08 12:35:08 +00003766
3767exit:
3768
3769 mbedtls_mpi_free(&r);
3770 mbedtls_mpi_free(&s);
3771 return status;
3772
Paul Elliott588f8ed2022-12-02 18:10:26 +00003773 #else
3774
3775 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003776 (void) signature;
3777 (void) signature_size;
3778 (void) signature_length;
3779
3780 return PSA_ERROR_NOT_SUPPORTED;
3781
3782#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3783 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3784 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3785}
3786
3787psa_status_t mbedtls_psa_sign_hash_abort(
3788 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3789{
3790
3791#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3792 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3793 defined(MBEDTLS_ECP_RESTARTABLE)
3794
3795 if (operation->ctx) {
3796 mbedtls_ecdsa_free(operation->ctx);
3797 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003798 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003799 }
3800
3801 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3802
Paul Elliott93d9ca82023-02-15 18:14:21 +00003803 operation->num_ops = 0;
3804
Paul Elliott588f8ed2022-12-02 18:10:26 +00003805 return PSA_SUCCESS;
3806
3807#else
3808
3809 (void) operation;
3810
3811 return PSA_ERROR_NOT_SUPPORTED;
3812
3813#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3814 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3815 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3816}
3817
3818psa_status_t mbedtls_psa_verify_hash_start(
3819 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3820 const psa_key_attributes_t *attributes,
3821 const uint8_t *key_buffer, size_t key_buffer_size,
3822 psa_algorithm_t alg,
3823 const uint8_t *hash, size_t hash_length,
3824 const uint8_t *signature, size_t signature_length)
3825{
3826 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003827 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003828 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003829
Paul Elliott068fe072023-01-16 13:59:15 +00003830 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3831 return PSA_ERROR_NOT_SUPPORTED;
3832 }
3833
3834 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003835 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003836 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003837
3838#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003839 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3840 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003841
Paul Elliotta1c94092023-02-15 16:38:04 +00003842 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3843 mbedtls_mpi_init(&operation->r);
3844 mbedtls_mpi_init(&operation->s);
3845
Paul Elliott93d9ca82023-02-15 18:14:21 +00003846 /* Ensure num_ops is zero'ed in case of context re-use. */
3847 operation->num_ops = 0;
3848
Paul Elliott068fe072023-01-16 13:59:15 +00003849 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3850 attributes->core.bits,
3851 key_buffer,
3852 key_buffer_size,
3853 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003854
Paul Elliott068fe072023-01-16 13:59:15 +00003855 if (status != PSA_SUCCESS) {
3856 return status;
3857 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003858
Paul Elliottc569fc22023-02-10 13:02:54 +00003859 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003860
Paul Elliott1bc59df2023-02-05 13:41:57 +00003861 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00003862 return PSA_ERROR_INVALID_SIGNATURE;
3863 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003864
Paul Elliott068fe072023-01-16 13:59:15 +00003865 status = mbedtls_to_psa_error(
3866 mbedtls_mpi_read_binary(&operation->r,
3867 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003868 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003869
Paul Elliott068fe072023-01-16 13:59:15 +00003870 if (status != PSA_SUCCESS) {
3871 return status;
3872 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003873
Paul Elliott068fe072023-01-16 13:59:15 +00003874 status = mbedtls_to_psa_error(
3875 mbedtls_mpi_read_binary(&operation->s,
3876 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003877 coordinate_bytes,
3878 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00003879
Paul Elliott068fe072023-01-16 13:59:15 +00003880 if (status != PSA_SUCCESS) {
3881 return status;
3882 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003883
Paul Elliott2c9843f2023-02-15 17:32:42 +00003884 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003885
Paul Elliott2c9843f2023-02-15 17:32:42 +00003886 if (status != PSA_SUCCESS) {
3887 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00003888 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003889
Paul Elliott0290a762023-02-09 14:30:24 +00003890 /* We only need to store the same length of hash as the private key size
3891 * here, it would be truncated by the internal implementation anyway. */
3892 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
3893 coordinate_bytes);
3894
Paul Elliottba70ad42023-02-15 18:23:53 +00003895 if (required_hash_length > sizeof(operation->hash)) {
3896 /* Shouldn't happen, but better safe than sorry. */
3897 return PSA_ERROR_CORRUPTION_DETECTED;
3898 }
3899
Paul Elliott0290a762023-02-09 14:30:24 +00003900 memcpy(operation->hash, hash, required_hash_length);
3901 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003902
3903 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003904#else
Paul Elliott068fe072023-01-16 13:59:15 +00003905 (void) operation;
3906 (void) key_buffer;
3907 (void) key_buffer_size;
3908 (void) alg;
3909 (void) hash;
3910 (void) hash_length;
3911 (void) signature;
3912 (void) signature_length;
3913 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00003914 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00003915 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003916
Paul Elliott068fe072023-01-16 13:59:15 +00003917 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003918#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3919 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3920 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003921}
3922
3923psa_status_t mbedtls_psa_verify_hash_complete(
3924 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3925{
3926
3927#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3928 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3929 defined(MBEDTLS_ECP_RESTARTABLE)
3930
Paul Elliottf8e5b562023-02-19 18:43:45 +00003931 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3932
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003933 /* Ensure max_ops is set to the current value (or default). */
3934 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3935
Paul Elliottf8e5b562023-02-19 18:43:45 +00003936 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00003937 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
3938 operation->hash,
3939 operation->hash_length,
3940 &operation->ctx->Q,
3941 &operation->r,
3942 &operation->s,
3943 &operation->restart_ctx));
3944
Paul Elliottf8e5b562023-02-19 18:43:45 +00003945 /* Hide the fact that the restart context only holds a delta of number of
3946 * ops done during the last operation, not an absolute value. */
3947 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3948
3949 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003950#else
3951 (void) operation;
3952
3953 return PSA_ERROR_NOT_SUPPORTED;
3954
3955#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3956 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3957 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3958}
3959
3960psa_status_t mbedtls_psa_verify_hash_abort(
3961 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
3962{
3963
3964#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3965 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3966 defined(MBEDTLS_ECP_RESTARTABLE)
3967
3968 if (operation->ctx) {
3969 mbedtls_ecdsa_free(operation->ctx);
3970 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003971 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003972 }
3973
3974 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3975
Paul Elliott93d9ca82023-02-15 18:14:21 +00003976 operation->num_ops = 0;
3977
Paul Elliott588f8ed2022-12-02 18:10:26 +00003978 mbedtls_mpi_free(&operation->r);
3979 mbedtls_mpi_free(&operation->s);
3980
3981 return PSA_SUCCESS;
3982
3983#else
3984 (void) operation;
3985
3986 return PSA_ERROR_NOT_SUPPORTED;
3987
3988#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3989 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3990 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3991}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003992
mohammad1603503973b2018-03-12 15:59:30 +02003993/****************************************************************/
3994/* Symmetric cryptography */
3995/****************************************************************/
3996
Gilles Peskine449bd832023-01-11 14:50:10 +01003997static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3998 mbedtls_svc_key_id_t key,
3999 psa_algorithm_t alg,
4000 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004001{
4002 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4003 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004004 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4006 PSA_KEY_USAGE_ENCRYPT :
4007 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004008 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004009
4010 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004011 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004012 status = PSA_ERROR_BAD_STATE;
4013 goto exit;
4014 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004015
Gilles Peskine449bd832023-01-11 14:50:10 +01004016 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004017 status = PSA_ERROR_INVALID_ARGUMENT;
4018 goto exit;
4019 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004020
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4022 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004023 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004025
Ronald Cron49fafa92021-03-10 08:34:23 +01004026 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004027 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004028 * so we only set it (in the driver wrapper) after resources have been
4029 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004030 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004031 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004032 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004034 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004035 }
4036 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004037
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004038 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004039 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004040 };
4041
Ronald Cronab99ac22020-10-01 16:38:28 +02004042 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 if (cipher_operation == MBEDTLS_ENCRYPT) {
4044 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4045 &attributes,
4046 slot->key.data,
4047 slot->key.bytes,
4048 alg);
4049 } else {
4050 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4051 &attributes,
4052 slot->key.data,
4053 slot->key.bytes,
4054 alg);
4055 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004056
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004057exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 if (status != PSA_SUCCESS) {
4059 psa_cipher_abort(operation);
4060 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004061
Ryan Everett1b70a072024-01-04 10:32:49 +00004062 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004063
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004065}
4066
Gilles Peskine449bd832023-01-11 14:50:10 +01004067psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4068 mbedtls_svc_key_id_t key,
4069 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004070{
Gilles Peskine449bd832023-01-11 14:50:10 +01004071 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004072}
4073
Gilles Peskine449bd832023-01-11 14:50:10 +01004074psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4075 mbedtls_svc_key_id_t key,
4076 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004077{
Gilles Peskine449bd832023-01-11 14:50:10 +01004078 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004079}
4080
Gilles Peskine449bd832023-01-11 14:50:10 +01004081psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4082 uint8_t *iv,
4083 size_t iv_size,
4084 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004085{
Ronald Cron6d051732020-10-01 14:10:20 +02004086 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004087 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004088 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004089
Gilles Peskine449bd832023-01-11 14:50:10 +01004090 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004091 status = PSA_ERROR_BAD_STATE;
4092 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004093 }
4094
Gilles Peskine449bd832023-01-11 14:50:10 +01004095 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004096 status = PSA_ERROR_BAD_STATE;
4097 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004098 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004099
Ronald Cron2fb90522021-07-05 12:31:44 +02004100 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004102 status = PSA_ERROR_BUFFER_TOO_SMALL;
4103 goto exit;
4104 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004105
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004107 status = PSA_ERROR_GENERIC_ERROR;
4108 goto exit;
4109 }
4110
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 status = psa_generate_random(local_iv, default_iv_length);
4112 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004113 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 }
Ronald Cron5618a392021-03-26 09:52:26 +01004115
Gilles Peskine449bd832023-01-11 14:50:10 +01004116 status = psa_driver_wrapper_cipher_set_iv(operation,
4117 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004118
4119exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004120 if (status == PSA_SUCCESS) {
4121 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004122 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004123 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004125 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004127 }
Ronald Cron6d051732020-10-01 14:10:20 +02004128
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004130}
4131
Gilles Peskine449bd832023-01-11 14:50:10 +01004132psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4133 const uint8_t *iv,
4134 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004135{
Ronald Cron6d051732020-10-01 14:10:20 +02004136 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004137
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004139 status = PSA_ERROR_BAD_STATE;
4140 goto exit;
4141 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004142
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004144 status = PSA_ERROR_BAD_STATE;
4145 goto exit;
4146 }
Ronald Crona0d68172021-03-26 10:15:08 +01004147
Gilles Peskine449bd832023-01-11 14:50:10 +01004148 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004149 status = PSA_ERROR_INVALID_ARGUMENT;
4150 goto exit;
4151 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004152
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 status = psa_driver_wrapper_cipher_set_iv(operation,
4154 iv,
4155 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004156
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004157exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004159 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 } else {
4161 psa_cipher_abort(operation);
4162 }
4163 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004164}
4165
Gilles Peskine449bd832023-01-11 14:50:10 +01004166psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4167 const uint8_t *input,
4168 size_t input_length,
4169 uint8_t *output,
4170 size_t output_size,
4171 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004172{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004173 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004174
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004176 status = PSA_ERROR_BAD_STATE;
4177 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004178 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004179
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004181 status = PSA_ERROR_BAD_STATE;
4182 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004183 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004184
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 status = psa_driver_wrapper_cipher_update(operation,
4186 input,
4187 input_length,
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 psa_cipher_abort(operation);
4195 }
Ronald Cron6d051732020-10-01 14:10:20 +02004196
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004198}
4199
Gilles Peskine449bd832023-01-11 14:50:10 +01004200psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4201 uint8_t *output,
4202 size_t output_size,
4203 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004204{
David Saadab4ecc272019-02-14 13:48:10 +02004205 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004208 status = PSA_ERROR_BAD_STATE;
4209 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004210 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004211
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004213 status = PSA_ERROR_BAD_STATE;
4214 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004215 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004216
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 status = psa_driver_wrapper_cipher_finish(operation,
4218 output,
4219 output_size,
4220 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004221
4222exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 if (status == PSA_SUCCESS) {
4224 return psa_cipher_abort(operation);
4225 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004226 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004228
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004230 }
mohammad1603503973b2018-03-12 15:59:30 +02004231}
4232
Gilles Peskine449bd832023-01-11 14:50:10 +01004233psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004234{
Gilles Peskine449bd832023-01-11 14:50:10 +01004235 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004236 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004237 * in use. It's ok to call abort on such an object, and there's
4238 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004240 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004241
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004243
Ronald Cron49fafa92021-03-10 08:34:23 +01004244 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004245 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004246 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004247
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004249}
4250
Gilles Peskine449bd832023-01-11 14:50:10 +01004251psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4252 psa_algorithm_t alg,
4253 const uint8_t *input,
4254 size_t input_length,
4255 uint8_t *output,
4256 size_t output_size,
4257 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004258{
4259 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004260 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004261 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004262 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4263 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004264 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004265
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004267 status = PSA_ERROR_INVALID_ARGUMENT;
4268 goto exit;
4269 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004270
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4272 PSA_KEY_USAGE_ENCRYPT,
4273 alg);
4274 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004275 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004277
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004278 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004280 };
4281
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4283 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004284 status = PSA_ERROR_GENERIC_ERROR;
4285 goto exit;
4286 }
4287
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 if (default_iv_length > 0) {
4289 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004290 status = PSA_ERROR_BUFFER_TOO_SMALL;
4291 goto exit;
4292 }
4293
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 status = psa_generate_random(local_iv, default_iv_length);
4295 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004296 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004298 }
4299
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004300 status = psa_driver_wrapper_cipher_encrypt(
4301 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004302 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004303 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004305
4306exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004307 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004309 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004310 }
Ronald Cron23919522021-07-08 19:00:07 +02004311
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 if (status == PSA_SUCCESS) {
4313 if (default_iv_length > 0) {
4314 memcpy(output, local_iv, default_iv_length);
4315 }
4316 *output_length += default_iv_length;
4317 } else {
4318 *output_length = 0;
4319 }
4320
4321 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004322}
4323
Gilles Peskine449bd832023-01-11 14:50:10 +01004324psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4325 psa_algorithm_t alg,
4326 const uint8_t *input,
4327 size_t input_length,
4328 uint8_t *output,
4329 size_t output_size,
4330 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004331{
4332 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004333 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004334 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004335 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004336
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004338 status = PSA_ERROR_INVALID_ARGUMENT;
4339 goto exit;
4340 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004341
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4343 PSA_KEY_USAGE_DECRYPT,
4344 alg);
4345 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004346 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004348
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004349 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004351 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4354 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004355 status = PSA_ERROR_INVALID_ARGUMENT;
4356 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004358 status = PSA_ERROR_INVALID_ARGUMENT;
4359 goto exit;
4360 }
4361
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004362 status = psa_driver_wrapper_cipher_decrypt(
4363 &attributes, slot->key.data, slot->key.bytes,
4364 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004366
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004367exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004368 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004370 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004372
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004374 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 }
Ronald Cron23919522021-07-08 19:00:07 +02004376
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004378}
4379
4380
mohammad16035955c982018-04-26 00:53:03 +03004381/****************************************************************/
4382/* AEAD */
4383/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004384
Paul Elliottbaff51c2021-09-28 17:44:45 +01004385/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004386static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004387{
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004389}
4390
4391/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004392static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4393 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004394{
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004396
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004398#if defined(PSA_WANT_ALG_GCM)
4399 case PSA_ALG_GCM:
4400 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 * arbitrarily large nonces. Please note that we do not generally
4402 * recommend the usage of nonces of greater length than
4403 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4404 * size, which can then lead to collisions if you encrypt a very
4405 * large number of messages.*/
4406 if (nonce_length != 0) {
4407 return PSA_SUCCESS;
4408 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004409 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004410#endif /* PSA_WANT_ALG_GCM */
4411#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004412 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 if (nonce_length >= 7 && nonce_length <= 13) {
4414 return PSA_SUCCESS;
4415 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004416 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004417#endif /* PSA_WANT_ALG_CCM */
4418#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004419 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 if (nonce_length == 12) {
4421 return PSA_SUCCESS;
4422 } else if (nonce_length == 8) {
4423 return PSA_ERROR_NOT_SUPPORTED;
4424 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004425 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004426#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004427 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004428 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004430 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004431
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004433}
4434
Gilles Peskine449bd832023-01-11 14:50:10 +01004435static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004436{
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4438 return PSA_ERROR_INVALID_ARGUMENT;
4439 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004442}
4443
Gilles Peskine449bd832023-01-11 14:50:10 +01004444psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4445 psa_algorithm_t alg,
4446 const uint8_t *nonce,
4447 size_t nonce_length,
4448 const uint8_t *additional_data,
4449 size_t additional_data_length,
4450 const uint8_t *plaintext,
4451 size_t plaintext_length,
4452 uint8_t *ciphertext,
4453 size_t ciphertext_size,
4454 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004455{
Ronald Cron215633c2021-03-16 17:15:37 +01004456 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4457 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004458
mohammad1603f08a5502018-06-03 15:05:47 +03004459 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004460
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 status = psa_aead_check_algorithm(alg);
4462 if (status != PSA_SUCCESS) {
4463 return status;
4464 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004465
Ronald Cron9a986162021-03-26 12:40:07 +01004466 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4468 if (status != PSA_SUCCESS) {
4469 return status;
4470 }
mohammad16035955c982018-04-26 00:53:03 +03004471
Ronald Cron215633c2021-03-16 17:15:37 +01004472 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004474 };
mohammad16035955c982018-04-26 00:53:03 +03004475
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 status = psa_aead_check_nonce_length(alg, nonce_length);
4477 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004478 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004480
Ronald Cronde822812021-03-17 16:08:20 +01004481 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004482 &attributes, slot->key.data, slot->key.bytes,
4483 alg,
4484 nonce, nonce_length,
4485 additional_data, additional_data_length,
4486 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004488
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4490 memset(ciphertext, 0, ciphertext_size);
4491 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004492
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004493exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004494 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004495
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004497}
4498
Gilles Peskine449bd832023-01-11 14:50:10 +01004499psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4500 psa_algorithm_t alg,
4501 const uint8_t *nonce,
4502 size_t nonce_length,
4503 const uint8_t *additional_data,
4504 size_t additional_data_length,
4505 const uint8_t *ciphertext,
4506 size_t ciphertext_length,
4507 uint8_t *plaintext,
4508 size_t plaintext_size,
4509 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004510{
Ronald Cron215633c2021-03-16 17:15:37 +01004511 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4512 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004513
Gilles Peskineee652a32018-06-01 19:23:52 +02004514 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004515
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 status = psa_aead_check_algorithm(alg);
4517 if (status != PSA_SUCCESS) {
4518 return status;
4519 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004520
Ronald Cron9a986162021-03-26 12:40:07 +01004521 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4523 if (status != PSA_SUCCESS) {
4524 return status;
4525 }
mohammad16035955c982018-04-26 00:53:03 +03004526
Ronald Cron215633c2021-03-16 17:15:37 +01004527 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004529 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 status = psa_aead_check_nonce_length(alg, nonce_length);
4532 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004533 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004535
Ronald Cronde822812021-03-17 16:08:20 +01004536 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004537 &attributes, slot->key.data, slot->key.bytes,
4538 alg,
4539 nonce, nonce_length,
4540 additional_data, additional_data_length,
4541 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004543
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 if (status != PSA_SUCCESS && plaintext_size != 0) {
4545 memset(plaintext, 0, plaintext_size);
4546 }
mohammad160360a64d02018-06-03 17:20:42 +03004547
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004548exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004549 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 return status;
mohammad16035955c982018-04-26 00:53:03 +03004552}
4553
Gilles Peskine449bd832023-01-11 14:50:10 +01004554static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4555{
4556 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004557
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004559#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004561 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4563 return PSA_ERROR_INVALID_ARGUMENT;
4564 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004565 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004566#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004567
Przemek Stekiel86679c72022-10-06 17:06:56 +02004568#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004570 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4572 return PSA_ERROR_INVALID_ARGUMENT;
4573 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004574 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004575#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004576
Przemek Stekiel86679c72022-10-06 17:06:56 +02004577#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004579 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (tag_len != 16) {
4581 return PSA_ERROR_INVALID_ARGUMENT;
4582 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004583 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004584#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004585
4586 default:
4587 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004589 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004591}
4592
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004593/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004594static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4595 int is_encrypt,
4596 mbedtls_svc_key_id_t key,
4597 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004598{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004599 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4600 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4601 psa_key_slot_t *slot = NULL;
4602 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004603 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 status = psa_aead_check_algorithm(alg);
4606 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004607 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004609
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004611 status = PSA_ERROR_BAD_STATE;
4612 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004613 }
4614
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 if (operation->nonce_set || operation->lengths_set ||
4616 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004617 status = PSA_ERROR_BAD_STATE;
4618 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004619 }
4620
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004622 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004624 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4628 alg);
4629 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004630 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004632
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004633 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004634 .core = slot->attr
4635 };
4636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004638 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004640
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 if (is_encrypt) {
4642 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4643 &attributes,
4644 slot->key.data,
4645 slot->key.bytes,
4646 alg);
4647 } else {
4648 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4649 &attributes,
4650 slot->key.data,
4651 slot->key.bytes,
4652 alg);
4653 }
4654 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004655 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004657
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004659
4660exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004661 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004662
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004664 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004666 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 } else {
4668 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004669 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004670
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004672}
4673
Paul Elliott302ff6b2021-04-20 18:10:30 +01004674/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004675psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4676 mbedtls_svc_key_id_t key,
4677 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004678{
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004680}
4681
4682/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004683psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4684 mbedtls_svc_key_id_t key,
4685 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004686{
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004688}
4689
4690/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004691psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4692 uint8_t *nonce,
4693 size_t nonce_size,
4694 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004695{
4696 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004697 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004698 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004699
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004700 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004701
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004703 status = PSA_ERROR_BAD_STATE;
4704 goto exit;
4705 }
4706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004708 status = PSA_ERROR_BAD_STATE;
4709 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004710 }
4711
Paul Elliotte193ea82021-10-01 13:00:16 +01004712 /* For CCM, this size may not be correct according to the PSA
4713 * specification. The PSA Crypto 1.0.1 specification states:
4714 *
4715 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4716 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4717 *
4718 * However this restriction that L has to be the smallest integer is not
4719 * applied in practice, and it is not implementable here since the
4720 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4722 operation->alg);
4723 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004724 status = PSA_ERROR_BUFFER_TOO_SMALL;
4725 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004726 }
4727
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 status = psa_generate_random(local_nonce, required_nonce_size);
4729 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004730 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004732
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004734
Paul Elliott39dc6b82021-05-11 19:16:09 +01004735exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if (status == PSA_SUCCESS) {
4737 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004738 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 } else {
4740 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004741 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004742
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004744}
4745
4746/* Set the nonce for a multipart authenticated encryption or decryption
4747 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004748psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
4749 const uint8_t *nonce,
4750 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004751{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004752 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4753
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004755 status = PSA_ERROR_BAD_STATE;
4756 goto exit;
4757 }
4758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004760 status = PSA_ERROR_BAD_STATE;
4761 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004762 }
4763
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4765 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004766 status = PSA_ERROR_INVALID_ARGUMENT;
4767 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01004768 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01004769
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4771 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004772
Paul Elliott39dc6b82021-05-11 19:16:09 +01004773exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004775 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 } else {
4777 psa_aead_abort(operation);
4778 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004779
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004781}
4782
4783/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004784psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4785 size_t ad_length,
4786 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004787{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004788 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4789
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004791 status = PSA_ERROR_BAD_STATE;
4792 goto exit;
4793 }
4794
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 if (operation->lengths_set || operation->ad_started ||
4796 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004797 status = PSA_ERROR_BAD_STATE;
4798 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004799 }
4800
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004802#if defined(PSA_WANT_ALG_GCM)
4803 case PSA_ALG_GCM:
4804 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 * bits. Without the guard this code will generate warnings on 32bit
4806 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01004807#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 if (((uint64_t) ad_length) >> 61 != 0 ||
4809 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004810 status = PSA_ERROR_INVALID_ARGUMENT;
4811 goto exit;
4812 }
Paul Elliott325d3742021-09-27 17:56:28 +01004813#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004814 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004815#endif /* PSA_WANT_ALG_GCM */
4816#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004817 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004819 status = PSA_ERROR_INVALID_ARGUMENT;
4820 goto exit;
4821 }
4822 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004823#endif /* PSA_WANT_ALG_CCM */
4824#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004825 case PSA_ALG_CHACHA20_POLY1305:
4826 /* No length restrictions for ChaChaPoly. */
4827 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004828#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004829 default:
4830 break;
4831 }
Paul Elliott325d3742021-09-27 17:56:28 +01004832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
4834 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004835
Paul Elliott39dc6b82021-05-11 19:16:09 +01004836exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004838 operation->ad_remaining = ad_length;
4839 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01004840 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 } else {
4842 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01004843 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004844
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004846}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01004847
4848/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004849psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
4850 const uint8_t *input,
4851 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004852{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004853 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4854
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004856 status = PSA_ERROR_BAD_STATE;
4857 goto exit;
4858 }
4859
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004861 status = PSA_ERROR_BAD_STATE;
4862 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004863 }
4864
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 if (operation->lengths_set) {
4866 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004867 status = PSA_ERROR_INVALID_ARGUMENT;
4868 goto exit;
4869 }
4870
4871 operation->ad_remaining -= input_length;
4872 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004873#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004875 status = PSA_ERROR_BAD_STATE;
4876 goto exit;
4877 }
4878#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004879
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 status = psa_driver_wrapper_aead_update_ad(operation, input,
4881 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004882
Paul Elliott39dc6b82021-05-11 19:16:09 +01004883exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004885 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 } else {
4887 psa_aead_abort(operation);
4888 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004889
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004891}
4892
4893/* Encrypt or decrypt a message fragment in an active multipart AEAD
4894 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004895psa_status_t psa_aead_update(psa_aead_operation_t *operation,
4896 const uint8_t *input,
4897 size_t input_length,
4898 uint8_t *output,
4899 size_t output_size,
4900 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004901{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004902 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004903
4904 *output_length = 0;
4905
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004907 status = PSA_ERROR_BAD_STATE;
4908 goto exit;
4909 }
4910
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004912 status = PSA_ERROR_BAD_STATE;
4913 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004914 }
4915
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004917 /* Additional data length was supplied, but not all the additional
4918 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004920 status = PSA_ERROR_INVALID_ARGUMENT;
4921 goto exit;
4922 }
4923
4924 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01004926 status = PSA_ERROR_INVALID_ARGUMENT;
4927 goto exit;
4928 }
4929
4930 operation->body_remaining -= input_length;
4931 }
Paul Elliotte193ea82021-10-01 13:00:16 +01004932#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01004934 status = PSA_ERROR_BAD_STATE;
4935 goto exit;
4936 }
4937#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01004938
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 status = psa_driver_wrapper_aead_update(operation, input, input_length,
4940 output, output_size,
4941 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004942
Paul Elliott39dc6b82021-05-11 19:16:09 +01004943exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004945 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 } else {
4947 psa_aead_abort(operation);
4948 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004949
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004951}
4952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01004954{
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 if (operation->id == 0 || !operation->nonce_set) {
4956 return PSA_ERROR_BAD_STATE;
4957 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004958
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 if (operation->lengths_set && (operation->ad_remaining != 0 ||
4960 operation->body_remaining != 0)) {
4961 return PSA_ERROR_INVALID_ARGUMENT;
4962 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004963
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01004965}
4966
Paul Elliott302ff6b2021-04-20 18:10:30 +01004967/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004968psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
4969 uint8_t *ciphertext,
4970 size_t ciphertext_size,
4971 size_t *ciphertext_length,
4972 uint8_t *tag,
4973 size_t tag_size,
4974 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004975{
Paul Elliott39dc6b82021-05-11 19:16:09 +01004976 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4977
Paul Elliott302ff6b2021-04-20 18:10:30 +01004978 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01004979 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004980
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 status = psa_aead_final_checks(operation);
4982 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01004983 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01004985
Gilles Peskine449bd832023-01-11 14:50:10 +01004986 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004987 status = PSA_ERROR_BAD_STATE;
4988 goto exit;
4989 }
4990
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
4992 ciphertext_size,
4993 ciphertext_length,
4994 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004995
Paul Elliott39dc6b82021-05-11 19:16:09 +01004996exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00004997
4998
Paul Elliottf47b0952021-05-21 18:02:33 +01004999 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005000 * the zero tag size, make sure the tag is set to something implausible.
5001 * Even if the operation succeeds, make sure we clear the rest of the
5002 * buffer to prevent potential leakage of anything previously placed in
5003 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005004 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005005
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005007
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005009}
5010
5011/* Finish authenticating and decrypting a message in a multipart AEAD
5012 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005013psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5014 uint8_t *plaintext,
5015 size_t plaintext_size,
5016 size_t *plaintext_length,
5017 const uint8_t *tag,
5018 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005019{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005020 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5021
Paul Elliott302ff6b2021-04-20 18:10:30 +01005022 *plaintext_length = 0;
5023
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 status = psa_aead_final_checks(operation);
5025 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005026 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005028
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005030 status = PSA_ERROR_BAD_STATE;
5031 goto exit;
5032 }
5033
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5035 plaintext_size,
5036 plaintext_length,
5037 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005038
5039exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005043}
5044
5045/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005046psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005047{
5048 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5049
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005051 /* The object has (apparently) been initialized but it is not (yet)
5052 * in use. It's ok to call abort on such an object, and there's
5053 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005055 }
5056
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005058
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005060
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005062}
5063
Gilles Peskinee59236f2018-01-27 23:32:46 +01005064/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005065/* Generators */
5066/****************************************************************/
5067
Przemek Stekiel69c46792022-06-10 12:59:51 +02005068#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005069 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005070 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305071 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305072 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005073#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005074#endif /* At least one builtin KDF */
5075
Przemek Stekiel69c46792022-06-10 12:59:51 +02005076#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005077 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5078 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5079static psa_status_t psa_key_derivation_start_hmac(
5080 psa_mac_operation_t *operation,
5081 psa_algorithm_t hash_alg,
5082 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005084{
5085 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5086 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5088 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5089 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005090
Steven Cooreman72f736a2021-05-07 14:14:37 +02005091 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005093
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 status = psa_driver_wrapper_mac_sign_setup(operation,
5095 &attributes,
5096 hmac_key, hmac_key_length,
5097 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005098
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 psa_reset_key_attributes(&attributes);
5100 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005101}
5102#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005103
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005104#define HKDF_STATE_INIT 0 /* no input yet */
5105#define HKDF_STATE_STARTED 1 /* got salt */
5106#define HKDF_STATE_KEYED 2 /* got key */
5107#define HKDF_STATE_OUTPUT 3 /* output started */
5108
Gilles Peskinecbe66502019-05-16 16:59:18 +02005109static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005111{
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5113 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5114 } else {
5115 return operation->alg;
5116 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005117}
5118
Gilles Peskine449bd832023-01-11 14:50:10 +01005119psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005120{
5121 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5123 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005124 /* The object has (apparently) been initialized but it is not
5125 * in use. It's ok to call abort on such an object, and there's
5126 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005128#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5130 mbedtls_free(operation->ctx.hkdf.info);
5131 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5132 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005133#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005134#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5135 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5137 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5138 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5139 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005140 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005142 }
5143
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005145 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005147 }
5148
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005150 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005152 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005153#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005155 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005157 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005158#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005159 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005160
5161 /* We leave the fields Ai and output_block to be erased safely by the
5162 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005164#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5165 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005166#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5168 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5169 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5170 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005171#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305172#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305173 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305174 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005175 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305176 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305177 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305178
5179 status = PSA_SUCCESS;
5180 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305181#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005182 {
5183 status = PSA_ERROR_BAD_STATE;
5184 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 mbedtls_platform_zeroize(operation, sizeof(*operation));
5186 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005187}
5188
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005189psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005191{
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005193 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005195 }
5196
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005197 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005199}
5200
Gilles Peskine449bd832023-01-11 14:50:10 +01005201psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5202 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005203{
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 if (operation->alg == 0) {
5205 return PSA_ERROR_BAD_STATE;
5206 }
5207 if (capacity > operation->capacity) {
5208 return PSA_ERROR_INVALID_ARGUMENT;
5209 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005210 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005212}
5213
Przemek Stekiel69c46792022-06-10 12:59:51 +02005214#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005215/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005216static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5217 psa_algorithm_t kdf_alg,
5218 uint8_t *output,
5219 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005220{
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5222 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005223 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005224 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005225#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005227#else
5228 const uint8_t last_block = 0xff;
5229#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005230
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 if (hkdf->state < HKDF_STATE_KEYED ||
5232 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005233#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005235#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 )) {
5237 return PSA_ERROR_BAD_STATE;
5238 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005239 hkdf->state = HKDF_STATE_OUTPUT;
5240
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005242 /* Copy what remains of the current block */
5243 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005245 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 }
5247 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005248 output += n;
5249 output_length -= n;
5250 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005252 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005254 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005255 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005256 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005257 * object was corrupted or if this function is called directly
5258 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 if (hkdf->block_number == last_block) {
5260 return PSA_ERROR_BAD_STATE;
5261 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005262
5263 /* We need a new block */
5264 ++hkdf->block_number;
5265 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005266
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5268 hash_alg,
5269 hkdf->prk,
5270 hash_length);
5271 if (status != PSA_SUCCESS) {
5272 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005273 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005274
5275 if (hkdf->block_number != 1) {
5276 status = psa_mac_update(&hkdf->hmac,
5277 hkdf->output_block,
5278 hash_length);
5279 if (status != PSA_SUCCESS) {
5280 return status;
5281 }
5282 }
5283 status = psa_mac_update(&hkdf->hmac,
5284 hkdf->info,
5285 hkdf->info_length);
5286 if (status != PSA_SUCCESS) {
5287 return status;
5288 }
5289 status = psa_mac_update(&hkdf->hmac,
5290 &hkdf->block_number, 1);
5291 if (status != PSA_SUCCESS) {
5292 return status;
5293 }
5294 status = psa_mac_sign_finish(&hkdf->hmac,
5295 hkdf->output_block,
5296 sizeof(hkdf->output_block),
5297 &hmac_output_length);
5298 if (status != PSA_SUCCESS) {
5299 return status;
5300 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005301 }
5302
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005304}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005305#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005306
John Durkop07cc04a2020-11-16 22:08:34 -08005307#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5308 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005309static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5310 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005312{
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5314 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005315 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5316 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005317 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005318
Janos Follath7742fee2019-06-17 12:58:10 +01005319 /* We can't be wanting more output after block 0xff, otherwise
5320 * the capacity check in psa_key_derivation_output_bytes() would have
5321 * prevented this call. It could happen only if the operation
5322 * object was corrupted or if this function is called directly
5323 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 if (tls12_prf->block_number == 0xff) {
5325 return PSA_ERROR_CORRUPTION_DETECTED;
5326 }
Janos Follath7742fee2019-06-17 12:58:10 +01005327
5328 /* We need a new block */
5329 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005330 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005331
5332 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5333 *
5334 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5335 *
5336 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5337 * HMAC_hash(secret, A(2) + seed) +
5338 * HMAC_hash(secret, A(3) + seed) + ...
5339 *
5340 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005341 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005342 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005343 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005344 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005345 * is currently extracted as `output_block` and where i is
5346 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005347 */
5348
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 status = psa_key_derivation_start_hmac(&hmac,
5350 hash_alg,
5351 tls12_prf->secret,
5352 tls12_prf->secret_length);
5353 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005354 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005356
5357 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005359 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5360 * the variable seed and in this instance means it in the context of the
5361 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 status = psa_mac_update(&hmac,
5363 tls12_prf->label,
5364 tls12_prf->label_length);
5365 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005366 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 }
5368 status = psa_mac_update(&hmac,
5369 tls12_prf->seed,
5370 tls12_prf->seed_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 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005375 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5377 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005378 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005380 }
5381
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 status = psa_mac_sign_finish(&hmac,
5383 tls12_prf->Ai, hash_length,
5384 &hmac_output_length);
5385 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005386 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 }
5388 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005389 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005391
5392 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 status = psa_key_derivation_start_hmac(&hmac,
5394 hash_alg,
5395 tls12_prf->secret,
5396 tls12_prf->secret_length);
5397 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005398 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 }
5400 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5401 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005402 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 }
5404 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5405 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005406 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 }
5408 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5409 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005410 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 }
5412 status = psa_mac_sign_finish(&hmac,
5413 tls12_prf->output_block, hash_length,
5414 &hmac_output_length);
5415 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005416 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005418
Janos Follath7742fee2019-06-17 12:58:10 +01005419
5420cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 cleanup_status = psa_mac_abort(&hmac);
5422 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005423 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005425
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005427}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005428
Janos Follath844eb0e2019-06-19 12:10:49 +01005429static psa_status_t psa_key_derivation_tls12_prf_read(
5430 psa_tls12_prf_key_derivation_t *tls12_prf,
5431 psa_algorithm_t alg,
5432 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005434{
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5436 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005437 psa_status_t status;
5438 uint8_t offset, length;
5439
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005441 case PSA_TLS12_PRF_STATE_LABEL_SET:
5442 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5443 break;
5444 case PSA_TLS12_PRF_STATE_OUTPUT:
5445 break;
5446 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005447 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005448 }
5449
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005451 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 if (tls12_prf->left_in_block == 0) {
5453 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5454 alg);
5455 if (status != PSA_SUCCESS) {
5456 return status;
5457 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005458
5459 continue;
5460 }
5461
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005463 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005465 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005467
5468 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005470 output += length;
5471 output_length -= length;
5472 tls12_prf->left_in_block -= length;
5473 }
5474
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005476}
John Durkop07cc04a2020-11-16 22:08:34 -08005477#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5478 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005479
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005480#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5481static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5482 psa_tls12_ecjpake_to_pms_t *ecjpake,
5483 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005485{
5486 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005487 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005488
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 if (output_length != 32) {
5490 return PSA_ERROR_INVALID_ARGUMENT;
5491 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005492
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5494 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5495 &output_size);
5496 if (status != PSA_SUCCESS) {
5497 return status;
5498 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005499
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 if (output_size != output_length) {
5501 return PSA_ERROR_GENERIC_ERROR;
5502 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005503
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005505}
5506#endif
5507
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305508#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305509static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5510 psa_pbkdf2_key_derivation_t *pbkdf2,
5511 psa_algorithm_t prf_alg,
5512 uint8_t prf_output_length,
5513 psa_key_attributes_t *attributes)
5514{
5515 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305516 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305517 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305518 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305519 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305520 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305521 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305522
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305523 mac_operation.is_sign = 1;
5524 mac_operation.mac_size = prf_output_length;
5525 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305526
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305527 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5528 attributes,
5529 pbkdf2->password,
5530 pbkdf2->password_length,
5531 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305532 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305533 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305534 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305535 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5536 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305537 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305538 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305539 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305540 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305541 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305542 }
5543 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5544 &mac_output_length);
5545 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305546 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305547 }
5548
5549 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305550 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305551 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305552 }
5553
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305554 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305555
5556 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305557 /* We are passing prf_output_length as mac_size because the driver
5558 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305559 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305560 status = psa_driver_wrapper_mac_compute(attributes,
5561 pbkdf2->password,
5562 pbkdf2->password_length,
5563 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305564 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305565 &mac_output_length);
5566 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305567 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305568 }
5569
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305570 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305571 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305572
5573cleanup:
5574 /* Zeroise buffers to clear sensitive data from memory. */
5575 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5576 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305577}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305578
5579static psa_status_t psa_key_derivation_pbkdf2_read(
5580 psa_pbkdf2_key_derivation_t *pbkdf2,
5581 psa_algorithm_t kdf_alg,
5582 uint8_t *output,
5583 size_t output_length)
5584{
5585 psa_status_t status;
5586 psa_algorithm_t prf_alg;
5587 uint8_t prf_output_length;
5588 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5589 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5590 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5591
5592 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5593 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5594 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5595 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305596 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5597 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305598 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305599 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305600 } else {
5601 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305602 }
5603
5604 switch (pbkdf2->state) {
5605 case PSA_PBKDF2_STATE_PASSWORD_SET:
5606 /* Initially we need a new block so bytes_used is equal to block size*/
5607 pbkdf2->bytes_used = prf_output_length;
5608 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5609 break;
5610 case PSA_PBKDF2_STATE_OUTPUT:
5611 break;
5612 default:
5613 return PSA_ERROR_BAD_STATE;
5614 }
5615
5616 while (output_length != 0) {
5617 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5618 if (n > output_length) {
5619 n = (uint8_t) output_length;
5620 }
5621 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5622 output += n;
5623 output_length -= n;
5624 pbkdf2->bytes_used += n;
5625
5626 if (output_length == 0) {
5627 break;
5628 }
5629
5630 /* We need a new block */
5631 pbkdf2->bytes_used = 0;
5632 pbkdf2->block_number++;
5633
5634 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5635 prf_output_length,
5636 &attributes);
5637 if (status != PSA_SUCCESS) {
5638 return status;
5639 }
5640 }
5641
5642 return PSA_SUCCESS;
5643}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305644#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305645
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005646psa_status_t psa_key_derivation_output_bytes(
5647 psa_key_derivation_operation_t *operation,
5648 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005650{
5651 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005653
Gilles Peskine449bd832023-01-11 14:50:10 +01005654 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005655 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005657 }
5658
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005660 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005661 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005662 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005663 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005664 goto exit;
5665 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005667 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005668 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005669 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5670 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005671 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005672 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005674 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005675 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005676
Przemek Stekiel69c46792022-06-10 12:59:51 +02005677#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5679 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5680 output, output_length);
5681 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005682#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005683#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5684 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5686 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5687 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5688 kdf_alg, output,
5689 output_length);
5690 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005691#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5692 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005693#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005695 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5697 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005698#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305699#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305700 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305701 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5702 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305703 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305704#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005705
Gilles Peskineeab56e42018-07-12 17:12:33 +02005706 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005707 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005709 }
5710
5711exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005713 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005714 * This allows us to differentiate between exhausted operations and
5715 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5716 * operations. */
5717 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005719 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005721 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005723}
5724
David Brown7807bf72021-02-09 16:28:23 -07005725#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005726static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005727{
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 if (data_size >= 8) {
5729 mbedtls_des_key_set_parity(data);
5730 }
5731 if (data_size >= 16) {
5732 mbedtls_des_key_set_parity(data + 8);
5733 }
5734 if (data_size >= 24) {
5735 mbedtls_des_key_set_parity(data + 16);
5736 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005737}
David Brown7807bf72021-02-09 16:28:23 -07005738#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005739
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005740/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 * ECC keys on a Weierstrass elliptic curve require the generation
5742 * of a private key which is an integer
5743 * in the range [1, N - 1], where N is the boundary of the private key domain:
5744 * N is the prime p for Diffie-Hellman, or the order of the
5745 * curve’s base point for ECC.
5746 *
5747 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5748 * This function generates the private key using the following process:
5749 *
5750 * 1. Draw a byte string of length ceiling(m/8) bytes.
5751 * 2. If m is not a multiple of 8, set the most significant
5752 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5753 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5754 * 4. If k > N - 2, discard the result and return to step 1.
5755 * 5. Output k + 1 as the private key.
5756 *
5757 * This method allows compliance to NIST standards, specifically the methods titled
5758 * Key-Pair Generation by Testing Candidates in the following publications:
5759 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5760 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5761 * Diffie-Hellman keys.
5762 *
5763 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5764 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5765 *
5766 * Note: Function allocates memory for *data buffer, so given *data should be
5767 * always NULL.
5768 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005769#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5770#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005771static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005772 psa_key_slot_t *slot,
5773 size_t bits,
5774 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005775 uint8_t **data
5776 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005777{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005778 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005779 mbedtls_mpi k;
5780 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005781 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005782 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005783 size_t m;
5784 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005785
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 mbedtls_mpi_init(&k);
5787 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005788
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005789 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01005790 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005791 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01005792 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005793
Gilles Peskine449bd832023-01-11 14:50:10 +01005794 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005795 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01005796 goto cleanup;
5797 }
5798
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005799 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005801
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005803
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005804 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005805 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005806 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005807
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005808 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005809
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005810 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005811 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005812
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005813 /* Note: This function is always called with *data == NULL and it
5814 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005815 *data = mbedtls_calloc(1, m_bytes);
5816 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005817 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005818 goto cleanup;
5819 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005820
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005822 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005824 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005826
5827 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005829 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005830 * (8 * ceiling(m/8) - m) bits of the first byte in
5831 * the string to zero.
5832 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005834 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005835 }
5836
5837 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 * big-endian byte string.
5839 */
5840 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005841
5842 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 * Result of comparison is returned. When it indicates error
5844 * then this function is called again.
5845 */
5846 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005847 }
5848
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005849 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
5851 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005852cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005853 if (ret != 0) {
5854 status = mbedtls_to_psa_error(ret);
5855 }
5856 if (status != PSA_SUCCESS) {
5857 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005858 *data = NULL;
5859 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005860 mbedtls_mpi_free(&k);
5861 mbedtls_mpi_free(&diff_N_2);
5862 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005863}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005864
5865/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
5866 * is determined by the curve, and sets the mandatory bits accordingly. That is:
5867 *
5868 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
5869 * draw a 32-byte string and process it as specified in
5870 * Elliptic Curves for Security [RFC7748] §5.
5871 *
5872 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
5873 * draw a 56-byte string and process it as specified in [RFC7748] §5.
5874 *
5875 * Note: Function allocates memory for *data buffer, so given *data should be
5876 * always NULL.
5877 */
5878
5879static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5880 size_t bits,
5881 psa_key_derivation_operation_t *operation,
5882 uint8_t **data
5883 )
5884{
5885 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005886 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005887
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005889 case 255:
5890 output_length = 32;
5891 break;
5892 case 448:
5893 output_length = 56;
5894 break;
5895 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005897 break;
5898 }
5899
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005901
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 if (*data == NULL) {
5903 return PSA_ERROR_INSUFFICIENT_MEMORY;
5904 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005905
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005907
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005909 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005910 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005911
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005913 case 255:
5914 (*data)[0] &= 248;
5915 (*data)[31] &= 127;
5916 (*data)[31] |= 64;
5917 break;
5918 case 448:
5919 (*data)[0] &= 252;
5920 (*data)[55] |= 128;
5921 break;
5922 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005924 break;
5925 }
5926
5927 return status;
5928}
Valerio Setti86587ab2023-06-27 13:09:30 +02005929#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5930static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
5931 psa_key_slot_t *slot, size_t bits,
5932 psa_key_derivation_operation_t *operation, uint8_t **data)
5933{
5934 (void) slot;
5935 (void) bits;
5936 (void) operation;
5937 (void) data;
5938 return PSA_ERROR_NOT_SUPPORTED;
5939}
5940
5941static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
5942 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
5943{
5944 (void) bits;
5945 (void) operation;
5946 (void) data;
5947 return PSA_ERROR_NOT_SUPPORTED;
5948}
5949#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
5950#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005951
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01005952static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005953 psa_key_slot_t *slot,
5954 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01005955 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005956{
5957 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05305959 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005960 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005961 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005962
Gilles Peskine449bd832023-01-11 14:50:10 +01005963 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
5964 return PSA_ERROR_INVALID_ARGUMENT;
5965 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02005966
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005967#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02005968 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
5970 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
5971 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005972 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
5974 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005975 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 }
5977 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005978 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
5980 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005981 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005983 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005984 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02005985#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02005986 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 if (key_type_is_raw_bytes(slot->attr.type)) {
5988 if (bits % 8 != 0) {
5989 return PSA_ERROR_INVALID_ARGUMENT;
5990 }
5991 data = mbedtls_calloc(1, bytes);
5992 if (data == NULL) {
5993 return PSA_ERROR_INSUFFICIENT_MEMORY;
5994 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005995
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 status = psa_key_derivation_output_bytes(operation, data, bytes);
5997 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01005998 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 }
David Brown12ca5032021-02-11 11:02:00 -07006000#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6002 psa_des_set_key_parity(data, bytes);
6003 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006004#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 } else {
6006 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006007 }
Ronald Crondd04d422020-11-28 15:14:42 +01006008
Ronald Cronbf33c932020-11-28 18:06:53 +01006009 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006010 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006012 };
6013
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6015 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6016 &storage_size);
6017 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306018 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 }
Archanad8a83dc2021-06-14 10:04:16 +05306020 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 status = psa_allocate_buffer_to_slot(slot, storage_size);
6022 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306023 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 }
Archanad8a83dc2021-06-14 10:04:16 +05306025
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 status = psa_driver_wrapper_import_key(&attributes,
6027 data, bytes,
6028 slot->key.data,
6029 slot->key.bytes,
6030 &slot->key.bytes, &bits);
6031 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006032 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006034
6035exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 mbedtls_free(data);
6037 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006038}
6039
Gilles Peskine449bd832023-01-11 14:50:10 +01006040psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6041 psa_key_derivation_operation_t *operation,
6042 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006043{
6044 psa_status_t status;
6045 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006046 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006047
Ronald Cron81709fc2020-11-14 12:10:32 +01006048 *key = MBEDTLS_SVC_KEY_ID_INIT;
6049
Gilles Peskine0f84d622019-09-12 19:03:13 +02006050 /* Reject any attempt to create a zero-length key so that we don't
6051 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 if (psa_get_key_bits(attributes) == 0) {
6053 return PSA_ERROR_INVALID_ARGUMENT;
6054 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006055
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 if (operation->alg == PSA_ALG_NONE) {
6057 return PSA_ERROR_BAD_STATE;
6058 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006059
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 if (!operation->can_output_key) {
6061 return PSA_ERROR_NOT_PERMITTED;
6062 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006063
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6065 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006066#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006068 /* Deriving a key in a secure element is not implemented yet. */
6069 status = PSA_ERROR_NOT_SUPPORTED;
6070 }
6071#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 if (status == PSA_SUCCESS) {
6073 status = psa_generate_derived_key_internal(slot,
6074 attributes->core.bits,
6075 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006076 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 if (status == PSA_SUCCESS) {
6078 status = psa_finish_key_creation(slot, driver, key);
6079 }
6080 if (status != PSA_SUCCESS) {
6081 psa_fail_key_creation(slot, driver);
6082 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006083
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006085}
6086
Gilles Peskineeab56e42018-07-12 17:12:33 +02006087
6088
6089/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006090/* Key derivation */
6091/****************************************************************/
6092
Steven Cooreman932ffb72021-02-15 12:14:32 +01006093#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006094static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006095{
6096#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6098 return 1;
6099 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006100#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006101#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6103 return 1;
6104 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006105#endif
6106#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6108 return 1;
6109 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006110#endif
6111#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6113 return 1;
6114 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006115#endif
6116#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6118 return 1;
6119 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006120#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006121#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6123 return 1;
6124 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006125#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306126#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6127 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6128 return 1;
6129 }
6130#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306131#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6132 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6133 return 1;
6134 }
6135#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006137}
6138
Gilles Peskine449bd832023-01-11 14:50:10 +01006139static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006140{
6141 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 psa_status_t status = psa_hash_setup(&operation, alg);
6143 psa_hash_abort(&operation);
6144 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006145}
6146
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306147static psa_status_t psa_key_derivation_set_maximum_capacity(
6148 psa_key_derivation_operation_t *operation,
6149 psa_algorithm_t kdf_alg)
6150{
6151#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6152 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6153 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6154 return PSA_SUCCESS;
6155 }
6156#endif
6157#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
6158 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6159#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05306160 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306161 PSA_KEY_TYPE_AES,
6162 128U,
6163 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306164#else
6165 operation->capacity = SIZE_MAX;
6166#endif
6167 return PSA_SUCCESS;
6168 }
6169#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
6170
6171 /* After this point, if kdf_alg is not valid then value of hash_alg may be
6172 * invalid or meaningless but it does not affect this function */
6173 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
6174 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306175 if (hash_size == 0) {
6176 return PSA_ERROR_NOT_SUPPORTED;
6177 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306178
6179 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6180 * we might fail later, which is somewhat unfriendly and potentially
6181 * risk-prone. */
6182 psa_status_t status = psa_hash_try_support(hash_alg);
6183 if (status != PSA_SUCCESS) {
6184 return status;
6185 }
6186
6187#if defined(PSA_WANT_ALG_HKDF)
6188 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6189 operation->capacity = 255 * hash_size;
6190 } else
6191#endif
6192#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6193 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6194 operation->capacity = hash_size;
6195 } else
6196#endif
6197#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6198 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6199 operation->capacity = 255 * hash_size;
6200 } else
6201#endif
6202#if defined(PSA_WANT_ALG_TLS12_PRF)
6203 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6204 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6205 operation->capacity = SIZE_MAX;
6206 } else
6207#endif
6208#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6209 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6210 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6211 /* Master Secret is always 48 bytes
6212 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6213 operation->capacity = 48U;
6214 } else
6215#endif
6216#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6217 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6218#if (SIZE_MAX > UINT32_MAX)
6219 operation->capacity = UINT32_MAX * hash_size;
6220#else
6221 operation->capacity = SIZE_MAX;
6222#endif
6223 } else
6224#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6225 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306226 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306227 status = PSA_ERROR_NOT_SUPPORTED;
6228 }
6229 return status;
6230}
6231
Gilles Peskine969c5d62019-01-16 15:53:06 +01006232static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006233 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006235{
Janos Follath5fe19732019-06-20 15:09:30 +01006236 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6237 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006239
Gilles Peskine969c5d62019-01-16 15:53:06 +01006240 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 if (!is_kdf_alg_supported(kdf_alg)) {
6242 return PSA_ERROR_NOT_SUPPORTED;
6243 }
John Durkop07cc04a2020-11-16 22:08:34 -08006244
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306245 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6246 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306247 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006248}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006249
Gilles Peskine449bd832023-01-11 14:50:10 +01006250static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006251{
6252#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 if (alg == PSA_ALG_ECDH) {
6254 return PSA_SUCCESS;
6255 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006256#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006257#if defined(PSA_WANT_ALG_FFDH)
6258 if (alg == PSA_ALG_FFDH) {
6259 return PSA_SUCCESS;
6260 }
6261#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006262 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006264}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006265
6266static int psa_key_derivation_allows_free_form_secret_input(
6267 psa_algorithm_t kdf_alg)
6268{
6269#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6270 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6271 return 0;
6272 }
6273#endif
6274 (void) kdf_alg;
6275 return 1;
6276}
John Durkop07cc04a2020-11-16 22:08:34 -08006277#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006278
Gilles Peskine449bd832023-01-11 14:50:10 +01006279psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6280 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006281{
6282 psa_status_t status;
6283
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 if (operation->alg != 0) {
6285 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006286 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006287
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6289 return PSA_ERROR_INVALID_ARGUMENT;
6290 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6291#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6292 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6293 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6294 status = psa_key_agreement_try_support(ka_alg);
6295 if (status != PSA_SUCCESS) {
6296 return status;
6297 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006298 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6299 return PSA_ERROR_INVALID_ARGUMENT;
6300 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6302#else
6303 return PSA_ERROR_NOT_SUPPORTED;
6304#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6305 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6306#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6307 status = psa_key_derivation_setup_kdf(operation, alg);
6308#else
6309 return PSA_ERROR_NOT_SUPPORTED;
6310#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6311 } else {
6312 return PSA_ERROR_INVALID_ARGUMENT;
6313 }
6314
6315 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006316 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 }
6318 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006319}
6320
Przemek Stekiel69c46792022-06-10 12:59:51 +02006321#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006322static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6323 psa_algorithm_t kdf_alg,
6324 psa_key_derivation_step_t step,
6325 const uint8_t *data,
6326 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006327{
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006329 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006331 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006332#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6334 return PSA_ERROR_INVALID_ARGUMENT;
6335 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006336#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 if (hkdf->state != HKDF_STATE_INIT) {
6338 return PSA_ERROR_BAD_STATE;
6339 } else {
6340 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6341 hash_alg,
6342 data, data_length);
6343 if (status != PSA_SUCCESS) {
6344 return status;
6345 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006346 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006348 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006349 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006350#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006352 /* We shouldn't be in different state as HKDF_EXPAND only allows
6353 * two inputs: SECRET (this case) and INFO which does not modify
6354 * the state. It could happen only if the hkdf
6355 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 if (hkdf->state != HKDF_STATE_INIT) {
6357 return PSA_ERROR_BAD_STATE;
6358 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006359
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006360 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006361 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6362 return PSA_ERROR_INVALID_ARGUMENT;
6363 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006364
Gilles Peskine449bd832023-01-11 14:50:10 +01006365 memcpy(hkdf->prk, data, data_length);
6366 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006367#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006368 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006369 /* HKDF: If no salt was provided, use an empty salt.
6370 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006371 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006372#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6374 return PSA_ERROR_BAD_STATE;
6375 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006376#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6378 hash_alg,
6379 NULL, 0);
6380 if (status != PSA_SUCCESS) {
6381 return status;
6382 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006383 hkdf->state = HKDF_STATE_STARTED;
6384 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006385 if (hkdf->state != HKDF_STATE_STARTED) {
6386 return PSA_ERROR_BAD_STATE;
6387 }
6388 status = psa_mac_update(&hkdf->hmac,
6389 data, data_length);
6390 if (status != PSA_SUCCESS) {
6391 return status;
6392 }
6393 status = psa_mac_sign_finish(&hkdf->hmac,
6394 hkdf->prk,
6395 sizeof(hkdf->prk),
6396 &data_length);
6397 if (status != PSA_SUCCESS) {
6398 return status;
6399 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006400 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006401
Gilles Peskine2b522db2019-04-12 15:11:49 +02006402 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006403 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006404#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006406 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006408 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006410#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006411 {
6412 /* Block 0 is empty, and the next block will be
6413 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006415 }
6416
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006418 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006419#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6421 return PSA_ERROR_INVALID_ARGUMENT;
6422 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006423#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006424#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6426 hkdf->state == HKDF_STATE_INIT) {
6427 return PSA_ERROR_BAD_STATE;
6428 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006429#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 if (hkdf->state == HKDF_STATE_OUTPUT) {
6431 return PSA_ERROR_BAD_STATE;
6432 }
6433 if (hkdf->info_set) {
6434 return PSA_ERROR_BAD_STATE;
6435 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006436 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006437 if (data_length != 0) {
6438 hkdf->info = mbedtls_calloc(1, data_length);
6439 if (hkdf->info == NULL) {
6440 return PSA_ERROR_INSUFFICIENT_MEMORY;
6441 }
6442 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006443 }
6444 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006445 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006446 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006448 }
6449}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006450#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006451
John Durkop07cc04a2020-11-16 22:08:34 -08006452#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6453 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006454static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6455 const uint8_t *data,
6456 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006457{
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6459 return PSA_ERROR_BAD_STATE;
6460 }
Janos Follathf08e2652019-06-13 09:05:41 +01006461
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 if (data_length != 0) {
6463 prf->seed = mbedtls_calloc(1, data_length);
6464 if (prf->seed == NULL) {
6465 return PSA_ERROR_INSUFFICIENT_MEMORY;
6466 }
Janos Follathf08e2652019-06-13 09:05:41 +01006467
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006469 prf->seed_length = data_length;
6470 }
Janos Follathf08e2652019-06-13 09:05:41 +01006471
Gilles Peskine43f958b2020-12-13 14:55:14 +01006472 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006473
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006475}
6476
Gilles Peskine449bd832023-01-11 14:50:10 +01006477static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6478 const uint8_t *data,
6479 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006480{
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6482 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6483 return PSA_ERROR_BAD_STATE;
6484 }
Janos Follath81550542019-06-13 14:26:34 +01006485
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 if (data_length != 0) {
6487 prf->secret = mbedtls_calloc(1, data_length);
6488 if (prf->secret == NULL) {
6489 return PSA_ERROR_INSUFFICIENT_MEMORY;
6490 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006491
Gilles Peskine449bd832023-01-11 14:50:10 +01006492 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006493 prf->secret_length = data_length;
6494 }
Janos Follath81550542019-06-13 14:26:34 +01006495
Gilles Peskine43f958b2020-12-13 14:55:14 +01006496 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006497
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006499}
6500
Gilles Peskine449bd832023-01-11 14:50:10 +01006501static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6502 const uint8_t *data,
6503 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006504{
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6506 return PSA_ERROR_BAD_STATE;
6507 }
Janos Follath63028dd2019-06-13 09:15:47 +01006508
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 if (data_length != 0) {
6510 prf->label = mbedtls_calloc(1, data_length);
6511 if (prf->label == NULL) {
6512 return PSA_ERROR_INSUFFICIENT_MEMORY;
6513 }
Janos Follath63028dd2019-06-13 09:15:47 +01006514
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006516 prf->label_length = data_length;
6517 }
Janos Follath63028dd2019-06-13 09:15:47 +01006518
Gilles Peskine43f958b2020-12-13 14:55:14 +01006519 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006520
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006522}
6523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6525 psa_key_derivation_step_t step,
6526 const uint8_t *data,
6527 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006528{
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006530 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006532 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006534 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006536 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006538 }
6539}
John Durkop07cc04a2020-11-16 22:08:34 -08006540#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6541 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6542
6543#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6544static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6545 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006546 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006548{
6549 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6551 4 + data_length + prf->other_secret_length :
6552 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006553
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6555 return PSA_ERROR_INVALID_ARGUMENT;
6556 }
John Durkop07cc04a2020-11-16 22:08:34 -08006557
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 uint8_t *pms = mbedtls_calloc(1, pms_len);
6559 if (pms == NULL) {
6560 return PSA_ERROR_INSUFFICIENT_MEMORY;
6561 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006562 uint8_t *cur = pms;
6563
6564 /* pure-PSK:
6565 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006566 *
6567 * The premaster secret is formed as follows: if the PSK is N octets
6568 * long, concatenate a uint16 with the value N, N zero octets, a second
6569 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006570 *
6571 * mixed-PSK:
6572 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6573 * follows: concatenate a uint16 with the length of the other secret,
6574 * the other secret itself, uint16 with the length of PSK, and the
6575 * PSK itself.
6576 * For details please check:
6577 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6578 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6579 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006580 */
6581
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6583 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6584 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6585 if (prf->other_secret_length != 0) {
6586 memcpy(cur, prf->other_secret, prf->other_secret_length);
6587 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006588 cur += prf->other_secret_length;
6589 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 } else {
6591 *cur++ = MBEDTLS_BYTE_1(data_length);
6592 *cur++ = MBEDTLS_BYTE_0(data_length);
6593 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006594 cur += data_length;
6595 }
6596
Gilles Peskine449bd832023-01-11 14:50:10 +01006597 *cur++ = MBEDTLS_BYTE_1(data_length);
6598 *cur++ = MBEDTLS_BYTE_0(data_length);
6599 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006600 cur += data_length;
6601
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006602 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006603
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006604 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006606}
Janos Follath6660f0e2019-06-17 08:44:03 +01006607
Przemek Stekiele47201b2022-04-19 13:53:28 +02006608static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6609 psa_tls12_prf_key_derivation_t *prf,
6610 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006612{
Gilles Peskine449bd832023-01-11 14:50:10 +01006613 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6614 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006615 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006616
6617 if (data_length != 0) {
6618 prf->other_secret = mbedtls_calloc(1, data_length);
6619 if (prf->other_secret == NULL) {
6620 return PSA_ERROR_INSUFFICIENT_MEMORY;
6621 }
6622
6623 memcpy(prf->other_secret, data, data_length);
6624 prf->other_secret_length = data_length;
6625 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006626 prf->other_secret_length = 0;
6627 }
6628
6629 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6630
Gilles Peskine449bd832023-01-11 14:50:10 +01006631 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006632}
6633
Janos Follath6660f0e2019-06-17 08:44:03 +01006634static psa_status_t psa_tls12_prf_psk_to_ms_input(
6635 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006636 psa_key_derivation_step_t step,
6637 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006639{
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006641 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006642 return psa_tls12_prf_psk_to_ms_set_key(prf,
6643 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006644 break;
6645 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6647 data,
6648 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006649 break;
6650 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006652 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006653
Przemek Stekiele47201b2022-04-19 13:53:28 +02006654 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006655}
John Durkop07cc04a2020-11-16 22:08:34 -08006656#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006657
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006658#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6659static psa_status_t psa_tls12_ecjpake_to_pms_input(
6660 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006661 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006662 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006664{
Gilles Peskine449bd832023-01-11 14:50:10 +01006665 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6666 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6667 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006668 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006669
6670 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006671 if (data[0] != 0x04) {
6672 return PSA_ERROR_INVALID_ARGUMENT;
6673 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006674
6675 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006676 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006677
Gilles Peskine449bd832023-01-11 14:50:10 +01006678 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006679}
6680#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306681
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306682#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306683static psa_status_t psa_pbkdf2_set_input_cost(
6684 psa_pbkdf2_key_derivation_t *pbkdf2,
6685 psa_key_derivation_step_t step,
6686 uint64_t data)
6687{
6688 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6689 return PSA_ERROR_INVALID_ARGUMENT;
6690 }
6691
6692 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6693 return PSA_ERROR_BAD_STATE;
6694 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306695
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306696 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306697 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306698 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306699
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306700 if (data == 0) {
6701 return PSA_ERROR_INVALID_ARGUMENT;
6702 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306703
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306704 pbkdf2->input_cost = data;
6705 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6706
6707 return PSA_SUCCESS;
6708}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306709
6710static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6711 const uint8_t *data,
6712 size_t data_length)
6713{
Gilles Peskineead17662023-08-20 22:02:51 +02006714 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6715 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6716 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6717 /* Appending to existing salt. No state change. */
6718 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306719 return PSA_ERROR_BAD_STATE;
6720 }
6721
Gilles Peskineca57d782023-07-20 19:08:06 +02006722 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006723 /* Appending an empty string, nothing to do. */
6724 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306725 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306726
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306727 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6728 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306729 return PSA_ERROR_INSUFFICIENT_MEMORY;
6730 }
6731
Gilles Peskineead17662023-08-20 22:02:51 +02006732 if (pbkdf2->salt_length != 0) {
6733 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6734 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306735 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306736 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306737 mbedtls_free(pbkdf2->salt);
6738 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306739 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306740 return PSA_SUCCESS;
6741}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306742
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306743#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306744static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306745 const uint8_t *input,
6746 size_t input_len,
6747 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306748 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306749{
6750 psa_status_t status = PSA_SUCCESS;
6751 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6752 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306753 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306754 } else {
6755 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306756 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306757 }
6758 return status;
6759}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306760#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306761
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306762#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306763static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6764 size_t input_len,
6765 uint8_t *output,
6766 size_t *output_len)
6767{
6768 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306769 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306770 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306771 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306772 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6773 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6774 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306775 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306776 * mac_size as the driver function sets mac_output_length = mac_size
6777 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306778 status = psa_driver_wrapper_mac_compute(&attributes,
6779 zeros, sizeof(zeros),
6780 PSA_ALG_CMAC, input, input_len,
6781 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306782 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6783 128U,
6784 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306785 output_len);
6786 } else {
6787 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306788 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306789 }
6790 return status;
6791}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306792#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306793
6794static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306795 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306796 const uint8_t *data,
6797 size_t data_length)
6798{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306799 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306800 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6801 return PSA_ERROR_BAD_STATE;
6802 }
6803
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306804#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306805 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6806 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6807 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6808 pbkdf2->password,
6809 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306810 } else
6811#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6812#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6813 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306814 status = psa_pbkdf2_cmac_set_password(data, data_length,
6815 pbkdf2->password,
6816 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306817 } else
6818#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6819 {
6820 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306821 }
6822
6823 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6824
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306825 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306826}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306827
6828static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306829 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306830 psa_key_derivation_step_t step,
6831 const uint8_t *data,
6832 size_t data_length)
6833{
6834 switch (step) {
6835 case PSA_KEY_DERIVATION_INPUT_SALT:
6836 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6837 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306838 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306839 default:
6840 return PSA_ERROR_INVALID_ARGUMENT;
6841 }
6842}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306843#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306844
Gilles Peskineb8965192019-09-24 16:21:10 +02006845/** Check whether the given key type is acceptable for the given
6846 * input step of a key derivation.
6847 *
6848 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
6849 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
6850 * Both secret and non-secret inputs can alternatively have the type
6851 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
6852 * that the input was passed as a buffer rather than via a key object.
6853 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02006854static int psa_key_derivation_check_input_type(
6855 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02006857{
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006859 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 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 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006866 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02006867 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 if (key_type == PSA_KEY_TYPE_DERIVE) {
6869 return PSA_SUCCESS;
6870 }
6871 if (key_type == PSA_KEY_TYPE_NONE) {
6872 return PSA_SUCCESS;
6873 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02006874 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006875 case PSA_KEY_DERIVATION_INPUT_LABEL:
6876 case PSA_KEY_DERIVATION_INPUT_SALT:
6877 case PSA_KEY_DERIVATION_INPUT_INFO:
6878 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
6880 return PSA_SUCCESS;
6881 }
6882 if (key_type == PSA_KEY_TYPE_NONE) {
6883 return PSA_SUCCESS;
6884 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006885 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306886 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
6887 if (key_type == PSA_KEY_TYPE_PASSWORD) {
6888 return PSA_SUCCESS;
6889 }
6890 if (key_type == PSA_KEY_TYPE_DERIVE) {
6891 return PSA_SUCCESS;
6892 }
6893 if (key_type == PSA_KEY_TYPE_NONE) {
6894 return PSA_SUCCESS;
6895 }
6896 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006897 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02006899}
6900
Janos Follathb80a94e2019-06-12 15:54:46 +01006901static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006902 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006903 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02006904 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006905 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006907{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006908 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02006910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 status = psa_key_derivation_check_input_type(step, key_type);
6912 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02006913 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006914 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02006915
Przemek Stekiel69c46792022-06-10 12:59:51 +02006916#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6918 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
6919 step, data, data_length);
6920 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006921#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006922#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6924 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
6925 step, data, data_length);
6926 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006927#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
6928#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6930 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
6931 step, data, data_length);
6932 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006933#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006934#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006936 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
6938 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006939#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306940#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306941 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306942 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
6943 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306944 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306945#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006946 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006947 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01006948 (void) data;
6949 (void) data_length;
6950 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006952 }
6953
Gilles Peskine224b0d62019-09-23 18:13:17 +02006954exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 if (status != PSA_SUCCESS) {
6956 psa_key_derivation_abort(operation);
6957 }
6958 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006959}
6960
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306961static psa_status_t psa_key_derivation_input_integer_internal(
6962 psa_key_derivation_operation_t *operation,
6963 psa_key_derivation_step_t step,
6964 uint64_t value)
6965{
6966 psa_status_t status;
6967 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
6968
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306969#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306970 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306971 status = psa_pbkdf2_set_input_cost(
6972 &operation->ctx.pbkdf2, step, value);
6973 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306974#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306975 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05306976 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306977 (void) value;
6978 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05306979 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306980 }
6981
6982 if (status != PSA_SUCCESS) {
6983 psa_key_derivation_abort(operation);
6984 }
6985 return status;
6986}
6987
Janos Follath51f4a0f2019-06-14 11:35:55 +01006988psa_status_t psa_key_derivation_input_bytes(
6989 psa_key_derivation_operation_t *operation,
6990 psa_key_derivation_step_t step,
6991 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006993{
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 return psa_key_derivation_input_internal(operation, step,
6995 PSA_KEY_TYPE_NONE,
6996 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01006997}
6998
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05306999psa_status_t psa_key_derivation_input_integer(
7000 psa_key_derivation_operation_t *operation,
7001 psa_key_derivation_step_t step,
7002 uint64_t value)
7003{
7004 return psa_key_derivation_input_integer_internal(operation, step, value);
7005}
7006
Janos Follath51f4a0f2019-06-14 11:35:55 +01007007psa_status_t psa_key_derivation_input_key(
7008 psa_key_derivation_operation_t *operation,
7009 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007011{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007012 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007013 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007014 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007015
Ronald Cron5c522922020-11-14 16:35:34 +01007016 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7018 if (status != PSA_SUCCESS) {
7019 psa_key_derivation_abort(operation);
7020 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007021 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007022
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307023 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7024 * permission to output to a key object. */
7025 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7026 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007027 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007028 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007029
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 status = psa_key_derivation_input_internal(operation,
7031 step, slot->attr.type,
7032 slot->key.data,
7033 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007034
Ryan Everett1b70a072024-01-04 10:32:49 +00007035 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007036
Gilles Peskine449bd832023-01-11 14:50:10 +01007037 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007038}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007039
7040
7041
7042/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007043/* Key agreement */
7044/****************************************************************/
7045
Gilles Peskine449bd832023-01-11 14:50:10 +01007046psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7047 const uint8_t *key_buffer,
7048 size_t key_buffer_size,
7049 psa_algorithm_t alg,
7050 const uint8_t *peer_key,
7051 size_t peer_key_length,
7052 uint8_t *shared_secret,
7053 size_t shared_secret_size,
7054 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007055{
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007057#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007058 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7060 key_buffer_size, alg,
7061 peer_key, peer_key_length,
7062 shared_secret,
7063 shared_secret_size,
7064 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007065#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007066
7067#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7068 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007069 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007070 peer_key,
7071 peer_key_length,
7072 key_buffer,
7073 key_buffer_size,
7074 shared_secret,
7075 shared_secret_size,
7076 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007077#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7078
Gilles Peskine01d718c2018-09-18 12:01:02 +02007079 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007080 (void) attributes;
7081 (void) key_buffer;
7082 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007083 (void) peer_key;
7084 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007085 (void) shared_secret;
7086 (void) shared_secret_size;
7087 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007089 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007090}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007091
Aditya Deshpande17845b82022-10-13 17:21:01 +01007092/** Internal function for raw key agreement
7093 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007094 * to the driver's implementation if a driver is present.
7095 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007096 * (psa_key_agreement_raw_builtin).
7097 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007098static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7099 psa_key_slot_t *private_key,
7100 const uint8_t *peer_key,
7101 size_t peer_key_length,
7102 uint8_t *shared_secret,
7103 size_t shared_secret_size,
7104 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007105{
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7107 return PSA_ERROR_NOT_SUPPORTED;
7108 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007109
7110 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007111 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007112 };
7113
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 return psa_driver_wrapper_key_agreement(&attributes,
7115 private_key->key.data,
7116 private_key->key.bytes, alg,
7117 peer_key, peer_key_length,
7118 shared_secret,
7119 shared_secret_size,
7120 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007121}
7122
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007123/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007124 * to potentially free embedded data structures and wipe confidential data.
7125 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007126static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7127 psa_key_derivation_step_t step,
7128 psa_key_slot_t *private_key,
7129 const uint8_t *peer_key,
7130 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007131{
7132 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007133 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007134 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007136
7137 /* Step 1: run the secret agreement algorithm to generate the shared
7138 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 status = psa_key_agreement_raw_internal(ka_alg,
7140 private_key,
7141 peer_key, peer_key_length,
7142 shared_secret,
7143 sizeof(shared_secret),
7144 &shared_secret_length);
7145 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007146 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007148
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007149 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007150 * the shared secret. A shared secret is permitted wherever a key
7151 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 status = psa_key_derivation_input_internal(operation, step,
7153 PSA_KEY_TYPE_DERIVE,
7154 shared_secret,
7155 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007156exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7158 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007159}
7160
Gilles Peskine449bd832023-01-11 14:50:10 +01007161psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7162 psa_key_derivation_step_t step,
7163 mbedtls_svc_key_id_t private_key,
7164 const uint8_t *peer_key,
7165 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007166{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007167 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007168 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007169 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007170
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7172 return PSA_ERROR_INVALID_ARGUMENT;
7173 }
Ronald Cron5c522922020-11-14 16:35:34 +01007174 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7176 if (status != PSA_SUCCESS) {
7177 return status;
7178 }
7179 status = psa_key_agreement_internal(operation, step,
7180 slot,
7181 peer_key, peer_key_length);
7182 if (status != PSA_SUCCESS) {
7183 psa_key_derivation_abort(operation);
7184 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007185 /* If a private key has been added as SECRET, we allow the derived
7186 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007187 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007188 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007190 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007191
Ryan Everett1b70a072024-01-04 10:32:49 +00007192 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007193
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007195}
7196
Gilles Peskine449bd832023-01-11 14:50:10 +01007197psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7198 mbedtls_svc_key_id_t private_key,
7199 const uint8_t *peer_key,
7200 size_t peer_key_length,
7201 uint8_t *output,
7202 size_t output_size,
7203 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007204{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007205 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007206 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007207 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007208 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007209
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007211 status = PSA_ERROR_INVALID_ARGUMENT;
7212 goto exit;
7213 }
Ronald Cron5c522922020-11-14 16:35:34 +01007214 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7216 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007217 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007219
Gilles Peskine3e561302022-04-14 00:17:15 +02007220 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7221 * for the output size. The PSA specification only guarantees that this
7222 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7223 * but it might be nice to allow smaller buffers if the output fits.
7224 * At the time of writing this comment, with only ECDH implemented,
7225 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7226 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7227 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007228 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7230 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007231 status = PSA_ERROR_BUFFER_TOO_SMALL;
7232 goto exit;
7233 }
7234
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 status = psa_key_agreement_raw_internal(alg, slot,
7236 peer_key, peer_key_length,
7237 output, output_size,
7238 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007239
7240exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007242 /* If an error happens and is not handled properly, the output
7243 * may be used as a key to protect sensitive data. Arrange for such
7244 * a key to be random, which is likely to result in decryption or
7245 * verification errors. This is better than filling the buffer with
7246 * some constant data such as zeros, which would result in the data
7247 * being protected with a reproducible, easily knowable key.
7248 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007250 *output_length = output_size;
7251 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007252
Ryan Everett1b70a072024-01-04 10:32:49 +00007253 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007254
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007256}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007257
7258
Gilles Peskine30524eb2020-11-13 17:02:26 +01007259
Gilles Peskine86a440b2018-11-12 18:39:40 +01007260/****************************************************************/
7261/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007262/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007263
Gilles Peskine672a7712023-04-28 21:00:28 +02007264#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7265#include "entropy_poll.h"
7266#endif
7267
Gilles Peskine30524eb2020-11-13 17:02:26 +01007268/** Initialize the PSA random generator.
7269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007270static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007271{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007272#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007274#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7275
Gilles Peskine30524eb2020-11-13 17:02:26 +01007276 /* Set default configuration if
7277 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007279 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 }
7281 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007282 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007283 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007284
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007286#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7287 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7288 /* The PSA entropy injection feature depends on using NV seed as an entropy
7289 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 mbedtls_entropy_add_source(&rng->entropy,
7291 mbedtls_nv_seed_poll, NULL,
7292 MBEDTLS_ENTROPY_BLOCK_SIZE,
7293 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007294#endif
7295
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007297#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007298}
7299
7300/** Deinitialize the PSA random generator.
7301 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007302static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007303{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007304#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007305 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007306#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007307 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7308 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007309#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007310}
7311
7312/** Seed the PSA random generator.
7313 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007314static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007315{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007316#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7317 /* Do nothing: the external RNG seeds itself. */
7318 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007320#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007321 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7323 drbg_seed, sizeof(drbg_seed) - 1);
7324 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007325#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007326}
7327
Gilles Peskine449bd832023-01-11 14:50:10 +01007328psa_status_t psa_generate_random(uint8_t *output,
7329 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007330{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007331 GUARD_MODULE_INITIALIZED;
7332
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007333#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7334
7335 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7337 output, output_size,
7338 &output_length);
7339 if (status != PSA_SUCCESS) {
7340 return status;
7341 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007342 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007343 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 if (output_length != output_size) {
7345 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7346 }
7347 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007348
7349#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7350
Gilles Peskine449bd832023-01-11 14:50:10 +01007351 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007352 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7354 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7355 output_size);
7356 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7357 output, request_size);
7358 if (ret != 0) {
7359 return mbedtls_to_psa_error(ret);
7360 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007361 output_size -= request_size;
7362 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007363 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007365#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007366}
7367
Gilles Peskine8814fc42020-12-14 15:33:44 +01007368/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007369 *
7370 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7371 * `psa_generate_random(...)`. The state parameter is ignored since the
7372 * PSA API doesn't support passing an explicit state.
7373 *
7374 * In the non-external case, psa_generate_random() calls an
7375 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7376 * and semantics as mbedtls_psa_get_random(). As an optimization,
7377 * instead of doing this back-and-forth between the PSA API and the
7378 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7379 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007381#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7382int mbedtls_psa_get_random(void *p_rng,
7383 unsigned char *output,
7384 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007385{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007386 /* This function takes a pointer to the RNG state because that's what
7387 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7388 * its own state internally and doesn't let the caller access that state.
7389 * So we just ignore the state parameter, and in practice we'll pass
7390 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007391 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 psa_status_t status = psa_generate_random(output, output_size);
7393 if (status == PSA_SUCCESS) {
7394 return 0;
7395 } else {
7396 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7397 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007398}
7399#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7400
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007401#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007402psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7403 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007404{
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 if (global_data.initialized) {
7406 return PSA_ERROR_NOT_PERMITTED;
7407 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007408
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7410 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7411 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7412 return PSA_ERROR_INVALID_ARGUMENT;
7413 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007414
Gilles Peskine449bd832023-01-11 14:50:10 +01007415 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007416}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007417#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007418
Ronald Cron3772afe2021-02-08 16:10:05 +01007419/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007420 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007421 * \param type The key type
7422 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007423 *
7424 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007425 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007426 * \retval #PSA_ERROR_INVALID_ARGUMENT
7427 * The size in bits of the key is not valid.
7428 * \retval #PSA_ERROR_NOT_SUPPORTED
7429 * The type and/or the size in bits of the key or the combination of
7430 * the two is not supported.
7431 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007432static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007434{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007435 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007436
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 if (key_type_is_raw_bytes(type)) {
7438 status = psa_validate_unstructured_key_bit_size(type, bits);
7439 if (status != PSA_SUCCESS) {
7440 return status;
7441 }
7442 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007443#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7445 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7446 return PSA_ERROR_NOT_SUPPORTED;
7447 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007448 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007449 return PSA_ERROR_NOT_SUPPORTED;
7450 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007451
Ronald Cron01b2aba2020-10-05 09:42:02 +02007452 /* Accept only byte-aligned keys, for the same reasons as
7453 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 if (bits % 8 != 0) {
7455 return PSA_ERROR_NOT_SUPPORTED;
7456 }
7457 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007458#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007459
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007460#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007462 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 return PSA_SUCCESS;
7464 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007465#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007466
Valerio Settia55f0422023-07-10 15:34:41 +02007467#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007468 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007469 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007470 return PSA_ERROR_NOT_SUPPORTED;
7471 }
7472 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007473#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007474 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007475 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007476 }
7477
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007479}
7480
Ronald Cron55ed0592020-10-05 10:30:40 +02007481psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007482 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007484{
7485 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007486 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007487
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 if ((attributes->domain_parameters == NULL) &&
7489 (attributes->domain_parameters_size != 0)) {
7490 return PSA_ERROR_INVALID_ARGUMENT;
7491 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007492
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 if (key_type_is_raw_bytes(type)) {
7494 status = psa_generate_random(key_buffer, key_buffer_size);
7495 if (status != PSA_SUCCESS) {
7496 return status;
7497 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007498
David Brown12ca5032021-02-11 11:02:00 -07007499#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 if (type == PSA_KEY_TYPE_DES) {
7501 psa_des_set_key_parity(key_buffer, key_buffer_size);
7502 }
David Brown8107e312021-02-12 08:08:46 -07007503#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007505
Valerio Setti76df8c12023-07-11 14:11:28 +02007506#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7508 return mbedtls_psa_rsa_generate_key(attributes,
7509 key_buffer,
7510 key_buffer_size,
7511 key_buffer_length);
7512 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007513#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007514
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007515#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7517 return mbedtls_psa_ecp_generate_key(attributes,
7518 key_buffer,
7519 key_buffer_size,
7520 key_buffer_length);
7521 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007522#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007523
Valerio Settia55f0422023-07-10 15:34:41 +02007524#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007525 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7526 return mbedtls_psa_ffdh_generate_key(attributes,
7527 key_buffer,
7528 key_buffer_size,
7529 key_buffer_length);
7530 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007531#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007532 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 (void) key_buffer_length;
7534 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007535 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007536
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007538}
Darryl Green0c6575a2018-11-07 16:05:30 +00007539
Gilles Peskine449bd832023-01-11 14:50:10 +01007540psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7541 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007542{
7543 psa_status_t status;
7544 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007545 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007546 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007547
Ronald Cron81709fc2020-11-14 12:10:32 +01007548 *key = MBEDTLS_SVC_KEY_ID_INIT;
7549
Gilles Peskine0f84d622019-09-12 19:03:13 +02007550 /* Reject any attempt to create a zero-length key so that we don't
7551 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 if (psa_get_key_bits(attributes) == 0) {
7553 return PSA_ERROR_INVALID_ARGUMENT;
7554 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007555
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007556 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7558 return PSA_ERROR_INVALID_ARGUMENT;
7559 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007560
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7562 &slot, &driver);
7563 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007564 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 }
Gilles Peskine11792082019-08-06 18:36:36 +02007566
Ronald Cron977c2472020-10-13 08:32:21 +02007567 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307568 * storage ( thus not in the case of generating a key in a secure element
7569 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7570 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 if (slot->key.data == NULL) {
7572 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7573 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007574 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 attributes->core.type, attributes->core.bits);
7576 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007577 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007579
7580 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 attributes->core.type,
7582 attributes->core.bits);
7583 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007584 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 attributes, &key_buffer_size);
7586 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007587 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 }
Ronald Cron977c2472020-10-13 08:32:21 +02007589 }
Ronald Cron977c2472020-10-13 08:32:21 +02007590
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7592 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007593 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 }
Ronald Cron977c2472020-10-13 08:32:21 +02007595 }
7596
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 status = psa_driver_wrapper_generate_key(attributes,
7598 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007599
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 if (status != PSA_SUCCESS) {
7601 psa_remove_key_data_from_memory(slot);
7602 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007603
Gilles Peskine11792082019-08-06 18:36:36 +02007604exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 if (status == PSA_SUCCESS) {
7606 status = psa_finish_key_creation(slot, driver, key);
7607 }
7608 if (status != PSA_SUCCESS) {
7609 psa_fail_key_creation(slot, driver);
7610 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007611
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007613}
7614
Gilles Peskinee59236f2018-01-27 23:32:46 +01007615/****************************************************************/
7616/* Module setup */
7617/****************************************************************/
7618
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007619#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007620psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 void (* entropy_init)(mbedtls_entropy_context *ctx),
7622 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007623{
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7625 return PSA_ERROR_BAD_STATE;
7626 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007627 global_data.rng.entropy_init = entropy_init;
7628 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007630}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007631#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007632
Gilles Peskine449bd832023-01-11 14:50:10 +01007633void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007634{
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007636 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7637 mbedtls_psa_random_free(&global_data.rng);
7638 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007639 /* Wipe all remaining data, including configuration.
7640 * In particular, this sets all state indicator to the value
7641 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007643
7644 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007646}
7647
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007648#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7649/** Recover a transaction that was interrupted by a power failure.
7650 *
7651 * This function is called during initialization, before psa_crypto_init()
7652 * returns. If this function returns a failure status, the initialization
7653 * fails.
7654 */
7655static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007657{
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007659 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7660 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 /* TODO - fall through to the failure case until this
7662 * is implemented.
7663 * https://github.com/ARMmbed/mbed-crypto/issues/218
7664 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007665 default:
7666 /* We found an unsupported transaction in the storage.
7667 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007669 }
7670}
7671#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7672
Gilles Peskine449bd832023-01-11 14:50:10 +01007673psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007674{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007675 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007676
Gilles Peskinec6b69072018-11-20 21:42:52 +01007677 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 if (global_data.initialized != 0) {
7679 return PSA_SUCCESS;
7680 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007681
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007682 /* Init drivers */
7683 status = psa_driver_wrapper_init();
7684 if (status != PSA_SUCCESS) {
7685 goto exit;
7686 }
7687 global_data.drivers_initialized = 1;
7688
Valerio Setti402cfba2023-11-13 10:24:32 +01007689 status = psa_initialize_key_slots();
7690 if (status != PSA_SUCCESS) {
7691 goto exit;
7692 }
7693
Gilles Peskine30524eb2020-11-13 17:02:26 +01007694 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007696 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 status = mbedtls_psa_random_seed(&global_data.rng);
7698 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007699 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007700 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007701 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007702
Gilles Peskine4b734222019-07-24 15:56:31 +02007703#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 status = psa_crypto_load_transaction();
7705 if (status == PSA_SUCCESS) {
7706 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7707 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007708 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 }
7710 status = psa_crypto_stop_transaction();
7711 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007712 /* There's no transaction to complete. It's all good. */
7713 status = PSA_SUCCESS;
7714 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007715#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007716
Gilles Peskinec6b69072018-11-20 21:42:52 +01007717 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007718 global_data.initialized = 1;
7719
7720exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 if (status != PSA_SUCCESS) {
7722 mbedtls_psa_crypto_free();
7723 }
7724 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007725}
7726
Yanray Wangffc3c482023-07-11 12:01:04 +08007727#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007728psa_status_t psa_crypto_driver_pake_get_password_len(
7729 const psa_crypto_driver_pake_inputs_t *inputs,
7730 size_t *password_len)
7731{
7732 if (inputs->password_len == 0) {
7733 return PSA_ERROR_BAD_STATE;
7734 }
7735
7736 *password_len = inputs->password_len;
7737
7738 return PSA_SUCCESS;
7739}
7740
7741psa_status_t psa_crypto_driver_pake_get_password(
7742 const psa_crypto_driver_pake_inputs_t *inputs,
7743 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7744{
7745 if (inputs->password_len == 0) {
7746 return PSA_ERROR_BAD_STATE;
7747 }
7748
7749 if (buffer_size < inputs->password_len) {
7750 return PSA_ERROR_BUFFER_TOO_SMALL;
7751 }
7752
7753 memcpy(buffer, inputs->password, inputs->password_len);
7754 *buffer_length = inputs->password_len;
7755
7756 return PSA_SUCCESS;
7757}
7758
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007759psa_status_t psa_crypto_driver_pake_get_user_len(
7760 const psa_crypto_driver_pake_inputs_t *inputs,
7761 size_t *user_len)
7762{
7763 if (inputs->user_len == 0) {
7764 return PSA_ERROR_BAD_STATE;
7765 }
7766
7767 *user_len = inputs->user_len;
7768
7769 return PSA_SUCCESS;
7770}
7771
7772psa_status_t psa_crypto_driver_pake_get_user(
7773 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007774 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007775{
7776 if (inputs->user_len == 0) {
7777 return PSA_ERROR_BAD_STATE;
7778 }
7779
Przemek Stekielc0e62502023-03-14 11:49:36 +01007780 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007781 return PSA_ERROR_BUFFER_TOO_SMALL;
7782 }
7783
Przemek Stekielc0e62502023-03-14 11:49:36 +01007784 memcpy(user_id, inputs->user, inputs->user_len);
7785 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007786
7787 return PSA_SUCCESS;
7788}
7789
7790psa_status_t psa_crypto_driver_pake_get_peer_len(
7791 const psa_crypto_driver_pake_inputs_t *inputs,
7792 size_t *peer_len)
7793{
7794 if (inputs->peer_len == 0) {
7795 return PSA_ERROR_BAD_STATE;
7796 }
7797
7798 *peer_len = inputs->peer_len;
7799
7800 return PSA_SUCCESS;
7801}
7802
7803psa_status_t psa_crypto_driver_pake_get_peer(
7804 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007805 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007806{
7807 if (inputs->peer_len == 0) {
7808 return PSA_ERROR_BAD_STATE;
7809 }
7810
Przemek Stekielc0e62502023-03-14 11:49:36 +01007811 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007812 return PSA_ERROR_BUFFER_TOO_SMALL;
7813 }
7814
Przemek Stekielc0e62502023-03-14 11:49:36 +01007815 memcpy(peer_id, inputs->peer, inputs->peer_len);
7816 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007817
7818 return PSA_SUCCESS;
7819}
7820
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007821psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7822 const psa_crypto_driver_pake_inputs_t *inputs,
7823 psa_pake_cipher_suite_t *cipher_suite)
7824{
7825 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7826 return PSA_ERROR_BAD_STATE;
7827 }
7828
7829 *cipher_suite = inputs->cipher_suite;
7830
7831 return PSA_SUCCESS;
7832}
7833
Neil Armstronga7d08c32022-06-01 18:21:20 +02007834psa_status_t psa_pake_setup(
7835 psa_pake_operation_t *operation,
7836 const psa_pake_cipher_suite_t *cipher_suite)
7837{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007838 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007839
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007840 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007841 status = PSA_ERROR_BAD_STATE;
7842 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007843 }
7844
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01007845 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01007846 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007847 status = PSA_ERROR_INVALID_ARGUMENT;
7848 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007849 }
7850
Przemek Stekiel51eac532022-12-07 11:04:51 +01007851 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
7852
Przemek Stekiele12ed362022-12-21 12:54:46 +01007853 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01007854 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
7855 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01007856 operation->data.inputs.cipher_suite = *cipher_suite;
7857
Przemek Stekiel4aa99402023-02-27 13:00:57 +01007858#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01007859 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007860 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01007861 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01007862
David Horstmann16f01512023-06-14 17:21:07 +01007863 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01007864 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01007865 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007866#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01007867 {
7868 status = PSA_ERROR_NOT_SUPPORTED;
7869 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01007870 }
7871
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01007872 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
7873
Przemek Stekiel51eac532022-12-07 11:04:51 +01007874 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007875exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007876 psa_pake_abort(operation);
7877 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007878}
7879
7880psa_status_t psa_pake_set_password_key(
7881 psa_pake_operation_t *operation,
7882 mbedtls_svc_key_id_t password)
7883{
Neil Armstrong5ae60962022-09-15 11:29:46 +02007884 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01007885 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
7886 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007887 psa_key_attributes_t attributes;
7888 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007889
Przemek Stekiel51eac532022-12-07 11:04:51 +01007890 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007891 status = PSA_ERROR_BAD_STATE;
7892 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007893 }
7894
Przemek Stekiel6c764412022-11-22 14:05:12 +01007895 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
7896 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01007897 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007898 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007899 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007900 }
7901
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007902 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01007903 .core = slot->attr
7904 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02007905
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007906 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02007907
Przemek Stekiel51eac532022-12-07 11:04:51 +01007908 if (type != PSA_KEY_TYPE_PASSWORD &&
7909 type != PSA_KEY_TYPE_PASSWORD_HASH) {
7910 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007911 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007912 }
7913
Przemek Stekiel51eac532022-12-07 11:04:51 +01007914 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
7915 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01007916 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007917 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007918 }
7919
7920 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
7921 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01007922 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007923exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007924 if (status != PSA_SUCCESS) {
7925 psa_pake_abort(operation);
7926 }
Ryan Everett1b70a072024-01-04 10:32:49 +00007927 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007928 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007929}
7930
7931psa_status_t psa_pake_set_user(
7932 psa_pake_operation_t *operation,
7933 const uint8_t *user_id,
7934 size_t user_id_len)
7935{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007936 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007937
7938 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007939 status = PSA_ERROR_BAD_STATE;
7940 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007941 }
7942
Przemek Stekiel51eac532022-12-07 11:04:51 +01007943 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007944 status = PSA_ERROR_INVALID_ARGUMENT;
7945 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007946 }
7947
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007948 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007949 status = PSA_ERROR_BAD_STATE;
7950 goto exit;
7951 }
7952
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007953 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
7954 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007955 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7956 goto exit;
7957 }
7958
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007959 memcpy(operation->data.inputs.user, user_id, user_id_len);
7960 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007961
7962 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007963exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01007964 psa_pake_abort(operation);
7965 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02007966}
7967
7968psa_status_t psa_pake_set_peer(
7969 psa_pake_operation_t *operation,
7970 const uint8_t *peer_id,
7971 size_t peer_id_len)
7972{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007973 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01007974
7975 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007976 status = PSA_ERROR_BAD_STATE;
7977 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007978 }
7979
Przemek Stekiel51eac532022-12-07 11:04:51 +01007980 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007981 status = PSA_ERROR_INVALID_ARGUMENT;
7982 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02007983 }
7984
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007985 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007986 status = PSA_ERROR_BAD_STATE;
7987 goto exit;
7988 }
7989
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007990 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
7991 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007992 status = PSA_ERROR_INSUFFICIENT_MEMORY;
7993 goto exit;
7994 }
7995
Przemek Stekielf309d6b2023-03-10 09:54:45 +01007996 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
7997 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01007998
7999 return PSA_SUCCESS;
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
8005psa_status_t psa_pake_set_role(
8006 psa_pake_operation_t *operation,
8007 psa_pake_role_t role)
8008{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008009 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008010
Przemek Stekiel51eac532022-12-07 11:04:51 +01008011 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008012 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008013 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008014 }
8015
Przemek Stekiel09104b82023-03-06 14:11:51 +01008016 switch (operation->alg) {
8017#if defined(PSA_WANT_ALG_JPAKE)
8018 case PSA_ALG_JPAKE:
8019 if (role == PSA_PAKE_ROLE_NONE) {
8020 return PSA_SUCCESS;
8021 }
8022 status = PSA_ERROR_INVALID_ARGUMENT;
8023 break;
8024#endif
8025 default:
8026 (void) role;
8027 status = PSA_ERROR_NOT_SUPPORTED;
8028 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008029 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008030exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008031 psa_pake_abort(operation);
8032 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008033}
8034
David Horstmanne7f21e62023-05-12 18:17:21 +01008035/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008036#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008037static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008038 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008039{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008040 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008041 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008042 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008043
David Horstmann024e5c52023-06-14 15:48:21 +01008044 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008045 is_x1 = (stage->outputs < 1);
8046 } else {
8047 is_x1 = (stage->inputs < 1);
8048 }
8049
David Horstmann74a3d8c2023-06-14 18:28:19 +01008050 key_share_step = is_x1 ?
8051 PSA_JPAKE_X1_STEP_KEY_SHARE :
8052 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008053 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008054 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8055 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8056 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8057 } else {
8058 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008059 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008060 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008061}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008062#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008063
Przemek Stekiel2797d372022-12-22 11:19:22 +01008064static psa_status_t psa_pake_complete_inputs(
8065 psa_pake_operation_t *operation)
8066{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008067 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008068 /* Create copy of the inputs on stack as inputs share memory
8069 with the driver context which will be setup by the driver. */
8070 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008071
Przemek Stekielfde11282023-03-13 16:06:09 +01008072 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008073 return PSA_ERROR_BAD_STATE;
8074 }
8075
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008076 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008077 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8078 return PSA_ERROR_BAD_STATE;
8079 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008080 }
8081
Przemek Stekiel18620a32023-01-17 16:34:52 +01008082 /* Clear driver context */
8083 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8084
8085 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008086
8087 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008088 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008089
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008090 /* User and peer are translated to role. */
8091 mbedtls_free(inputs.user);
8092 mbedtls_free(inputs.peer);
8093
Przemek Stekiel2797d372022-12-22 11:19:22 +01008094 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008095#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008096 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008097 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008098 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008099#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008100 {
8101 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008102 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008103 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008104 return status;
8105}
8106
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008107#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008108static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008109 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008110 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008111 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008112{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008113 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8114 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8115 step != PSA_PAKE_STEP_ZK_PROOF) {
8116 return PSA_ERROR_INVALID_ARGUMENT;
8117 }
8118
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008119 psa_jpake_computation_stage_t *computation_stage =
8120 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008121
David Horstmann5da95602023-06-08 15:37:12 +01008122 if (computation_stage->round != PSA_JPAKE_FIRST &&
8123 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008124 return PSA_ERROR_BAD_STATE;
8125 }
8126
David Horstmanne7f21e62023-05-12 18:17:21 +01008127 /* Check that the step we are given is the one we were expecting */
8128 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008129 return PSA_ERROR_BAD_STATE;
8130 }
8131
David Horstmanne7f21e62023-05-12 18:17:21 +01008132 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8133 computation_stage->inputs == 0 &&
8134 computation_stage->outputs == 0) {
8135 /* Start of the round, so function decides whether we are inputting
8136 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008137 computation_stage->io_mode = io_mode;
8138 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008139 /* Middle of the round so the mode we are in must match the function
8140 * called by the user */
8141 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008142 }
8143
8144 return PSA_SUCCESS;
8145}
8146
David Horstmanne7f21e62023-05-12 18:17:21 +01008147static psa_status_t psa_jpake_epilogue(
8148 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008149 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008150{
David Horstmanne7f21e62023-05-12 18:17:21 +01008151 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008152 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008153
David Horstmanne7f21e62023-05-12 18:17:21 +01008154 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8155 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008156 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008157 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008158 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008159 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008160 }
8161 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008162 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008163 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008164 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008165 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008166 }
8167 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008168 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8169 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008170 /* End of a round, move to the next round */
8171 stage->inputs = 0;
8172 stage->outputs = 0;
8173 stage->round++;
8174 }
8175 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008176 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008177 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008178 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008179 return PSA_SUCCESS;
8180}
David Horstmanne7f21e62023-05-12 18:17:21 +01008181
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008182#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008183
Neil Armstronga7d08c32022-06-01 18:21:20 +02008184psa_status_t psa_pake_output(
8185 psa_pake_operation_t *operation,
8186 psa_pake_step_t step,
8187 uint8_t *output,
8188 size_t output_size,
8189 size_t *output_length)
8190{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008191 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008192 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008193 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008194
8195 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008196 status = psa_pake_complete_inputs(operation);
8197 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008198 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008199 }
8200 }
8201
8202 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008203 status = PSA_ERROR_BAD_STATE;
8204 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008205 }
8206
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008207 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008208 status = PSA_ERROR_INVALID_ARGUMENT;
8209 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008210 }
8211
Przemek Stekiele12ed362022-12-21 12:54:46 +01008212 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008213#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008214 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008215 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008216 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008217 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008218 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008219 driver_step = convert_jpake_computation_stage_to_driver_step(
8220 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008221 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008222#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008223 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008224 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008225 status = PSA_ERROR_NOT_SUPPORTED;
8226 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008227 }
8228
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008229 status = psa_driver_wrapper_pake_output(operation, driver_step,
8230 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008231
8232 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008233 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008234 }
8235
8236 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008237#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008238 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008239 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008240 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008241 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008242 }
8243 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008244#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008245 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008246 status = PSA_ERROR_NOT_SUPPORTED;
8247 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008248 }
8249
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008250 return PSA_SUCCESS;
8251exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008252 psa_pake_abort(operation);
8253 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008254}
8255
8256psa_status_t psa_pake_input(
8257 psa_pake_operation_t *operation,
8258 psa_pake_step_t step,
8259 const uint8_t *input,
8260 size_t input_length)
8261{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008262 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008263 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008264 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8265 operation->primitive,
8266 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008267
8268 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008269 status = psa_pake_complete_inputs(operation);
8270 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008271 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008272 }
8273 }
8274
8275 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008276 status = PSA_ERROR_BAD_STATE;
8277 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008278 }
8279
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008280 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008281 status = PSA_ERROR_INVALID_ARGUMENT;
8282 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008283 }
8284
Przemek Stekiele12ed362022-12-21 12:54:46 +01008285 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008286#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008287 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008288 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008289 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008290 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008291 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008292 driver_step = convert_jpake_computation_stage_to_driver_step(
8293 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008294 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008295#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008296 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008297 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008298 status = PSA_ERROR_NOT_SUPPORTED;
8299 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008300 }
8301
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008302 status = psa_driver_wrapper_pake_input(operation, driver_step,
8303 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008304
8305 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008306 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008307 }
8308
8309 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008310#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008311 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008312 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008313 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008314 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008315 }
8316 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008317#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008318 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008319 status = PSA_ERROR_NOT_SUPPORTED;
8320 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008321 }
8322
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008323 return PSA_SUCCESS;
8324exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008325 psa_pake_abort(operation);
8326 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008327}
8328
8329psa_status_t psa_pake_get_implicit_key(
8330 psa_pake_operation_t *operation,
8331 psa_key_derivation_operation_t *output)
8332{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008333 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008334 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008335 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008336 size_t shared_key_len = 0;
8337
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008338 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008339 status = PSA_ERROR_BAD_STATE;
8340 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008341 }
8342
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008343#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008344 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008345 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008346 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008347 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008348 status = PSA_ERROR_BAD_STATE;
8349 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008350 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008351 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008352#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008353 {
8354 status = PSA_ERROR_NOT_SUPPORTED;
8355 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008356 }
8357
Przemek Stekiel0c781802022-11-29 14:53:13 +01008358 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8359 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008360 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008361 &shared_key_len);
8362
8363 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008364 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008365 }
8366
8367 status = psa_key_derivation_input_bytes(output,
8368 PSA_KEY_DERIVATION_INPUT_SECRET,
8369 shared_key,
8370 shared_key_len);
8371
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008372 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008373exit:
8374 abort_status = psa_pake_abort(operation);
8375 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008376}
8377
8378psa_status_t psa_pake_abort(
8379 psa_pake_operation_t *operation)
8380{
Przemek Stekield69dca92023-01-31 19:59:20 +01008381 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008382
Przemek Stekield69dca92023-01-31 19:59:20 +01008383 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008384 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008385 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008386
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008387 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8388 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008389 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008390 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008391 }
8392 if (operation->data.inputs.user != NULL) {
8393 mbedtls_free(operation->data.inputs.user);
8394 }
8395 if (operation->data.inputs.peer != NULL) {
8396 mbedtls_free(operation->data.inputs.peer);
8397 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008398 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008399 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008400
Przemek Stekield69dca92023-01-31 19:59:20 +01008401 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008402}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008403#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008404
Gilles Peskinee59236f2018-01-27 23:32:46 +01008405#endif /* MBEDTLS_PSA_CRYPTO_C */